Package org.hl7.fhir.r4.model
Enum Enumerations.FHIRDefinedType
- java.lang.Object
-
- java.lang.Enum<Enumerations.FHIRDefinedType>
-
- org.hl7.fhir.r4.model.Enumerations.FHIRDefinedType
-
- All Implemented Interfaces:
Serializable,Comparable<Enumerations.FHIRDefinedType>
- Enclosing class:
- Enumerations
public static enum Enumerations.FHIRDefinedType extends Enum<Enumerations.FHIRDefinedType>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCOUNTA financial tool for tracking value accrued for a particular purpose.ACTIVITYDEFINITIONThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.ADDRESSAn address expressed using postal conventions (as opposed to GPS or other location definition formats).ADVERSEEVENTActual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.AGEA duration of time during which an organism (or a process) has existed.ALLERGYINTOLERANCERisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.ANNOTATIONA text note which also contains information about who made the statement and when.APPOINTMENTA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time.APPOINTMENTRESPONSEA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.ATTACHMENTFor referring to data content defined in other formats.AUDITEVENTA record of an event made for purposes of maintaining a security log.BACKBONEELEMENTBase definition for all elements that are defined inside a resource - but not those in a data type.BASE64BINARYA stream of bytesBASICBasic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.BINARYA resource that represents the data of a single raw artifact as digital content accessible in its native format.BIOLOGICALLYDERIVEDPRODUCTA material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.BODYSTRUCTURERecord details about an anatomical structure.BOOLEANValue of "true" or "false"BUNDLEA container for a collection of resources.CANONICALA URI that is a reference to a canonical URL on a FHIR resourceCAPABILITYSTATEMENTA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.CAREPLANDescribes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.CARETEAMThe Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.CATALOGENTRYCatalog entries are wrappers that contextualize items included in a catalog.CHARGEITEMThe resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons.CHARGEITEMDEFINITIONThe ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices.CLAIMA provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.CLAIMRESPONSEThis resource provides the adjudication details from the processing of a Claim resource.CLINICALIMPRESSIONA record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition.CODEA string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contentsCODEABLECONCEPTA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.CODESYSTEMThe CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.CODINGA reference to a code defined by a terminology system.COMMUNICATIONAn occurrence of information being transmitted; e.g.COMMUNICATIONREQUESTA request to convey information; e.g.COMPARTMENTDEFINITIONA compartment definition that defines how resources are accessed on a server.COMPOSITIONA set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.CONCEPTMAPA statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.CONDITIONA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.CONSENTA record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.CONTACTDETAILSpecifies contact information for a person or organization.CONTACTPOINTDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.CONTRACTLegally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.CONTRIBUTORA contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.COUNTA measured amount (or an amount that can potentially be measured).COVERAGEFinancial instrument which may be used to reimburse or pay for health care products and services.COVERAGEELIGIBILITYREQUESTThe CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.COVERAGEELIGIBILITYRESPONSEThis resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.DATAREQUIREMENTDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.DATEA date or partial date (e.g.DATETIMEA date, date-time or partial date (e.g.DECIMALA rational number with implicit precisionDETECTEDISSUEIndicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g.DEVICEA type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.DEVICEDEFINITIONThe characteristics, operational status and capabilities of a medical-related component of a medical device.DEVICEMETRICDescribes a measurement, calculation or setting capability of a medical device.DEVICEREQUESTRepresents a request for a patient to employ a medical device.DEVICEUSESTATEMENTA record of a device being used by a patient where the record is the result of a report from the patient or another clinician.DIAGNOSTICREPORTThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these.DISTANCEA length - a value with a unit that is a physical distance.DOCUMENTMANIFESTA collection of documents compiled for a purpose together with metadata that applies to the collection.DOCUMENTREFERENCEA reference to a document of any kind for any purpose.DOMAINRESOURCEA resource that includes narrative, extensions, and contained resources.DOSAGEIndicates how the medication is/was taken or should be taken by the patient.DURATIONA length of time.EFFECTEVIDENCESYNTHESISThe EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.ELEMENTBase definition for all elements in a resource.ELEMENTDEFINITIONCaptures constraints on each element within the resource, profile, or extension.ENCOUNTERAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.ENDPOINTThe technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server.ENROLLMENTREQUESTThis resource provides the insurance enrollment details to the insurer regarding a specified coverage.ENROLLMENTRESPONSEThis resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.EPISODEOFCAREAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur.EVENTDEFINITIONThe EventDefinition resource provides a reusable description of when a particular event can occur.EVIDENCEThe Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.EVIDENCEVARIABLEThe EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.EXAMPLESCENARIOExample of workflow instance.EXPLANATIONOFBENEFITThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.EXPRESSIONA expression that is evaluated in a specified context and returns a value.EXTENSIONOptional Extension Element - found in all resources.FAMILYMEMBERHISTORYSignificant health conditions for a person related to the patient relevant in the context of care for the patient.FLAGProspective warnings of potential issues when providing care to the patient.GOALDescribes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.GRAPHDEFINITIONA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references.GROUPRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e.GUIDANCERESPONSEA guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.HEALTHCARESERVICEThe details of a healthcare service available at a location.HUMANNAMEA human's name with the ability to identify parts and usage.IDAny combination of letters, numerals, "-" and ".", with a length limit of 64 characters.IDENTIFIERAn identifier - identifies some entity uniquely and unambiguously.IMAGINGSTUDYRepresentation of the content produced in a DICOM imaging study.IMMUNIZATIONDescribes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.IMMUNIZATIONEVALUATIONDescribes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.IMMUNIZATIONRECOMMENDATIONA patient's point-in-time set of recommendations (i.e.IMPLEMENTATIONGUIDEA set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources.INSTANTAn instant in time - known at least to the secondINSURANCEPLANDetails of a Health Insurance product/plan provided by an organization.INTEGERA whole numberINVOICEInvoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.LIBRARYThe Library resource is a general-purpose container for knowledge asset definitions.LINKAGEIdentifies two or more records (resource instances) that refer to the same real-world "occurrence".LISTA list is a curated collection of resources.LOCATIONDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.MARKDOWNA string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engineMARKETINGSTATUSThe marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.MEASUREThe Measure resource provides the definition of a quality measure.MEASUREREPORTThe MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.MEDIAA photo, video, or audio recording acquired or used in healthcare.MEDICATIONThis resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.MEDICATIONADMINISTRATIONDescribes the event of a patient consuming or otherwise being administered a medication.MEDICATIONDISPENSEIndicates that a medication product is to be or has been dispensed for a named person/patient.MEDICATIONKNOWLEDGEInformation about a medication that is used to support knowledge.MEDICATIONREQUESTAn order or request for both supply of the medication and the instructions for administration of the medication to a patient.MEDICATIONSTATEMENTA record of a medication that is being consumed by a patient.MEDICINALPRODUCTDetailed definition of a medicinal product, typically for uses other than direct patient care (e.g.MEDICINALPRODUCTAUTHORIZATIONThe regulatory authorization of a medicinal product.MEDICINALPRODUCTCONTRAINDICATIONThe clinical particulars - indications, contraindications etc.MEDICINALPRODUCTINDICATIONIndication for the Medicinal Product.MEDICINALPRODUCTINGREDIENTAn ingredient of a manufactured item or pharmaceutical product.MEDICINALPRODUCTINTERACTIONThe interactions of the medicinal product with other medicinal products, or other forms of interactions.MEDICINALPRODUCTMANUFACTUREDThe manufactured item as contained in the packaged medicinal product.MEDICINALPRODUCTPACKAGEDA medicinal product in a container or package.MEDICINALPRODUCTPHARMACEUTICALA pharmaceutical product described in terms of its composition and dose form.MEDICINALPRODUCTUNDESIRABLEEFFECTDescribe the undesirable effects of the medicinal product.MESSAGEDEFINITIONDefines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.MESSAGEHEADERThe header for a message exchange that is either requesting or responding to an action.METAThe metadata about a resource.MOLECULARSEQUENCERaw data describing a biological sequence.MONEYAn amount of economic utility in some recognized currency.MONEYQUANTITYnullNAMINGSYSTEMA curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc.NARRATIVEA human-readable summary of the resource conveying the essential clinical and business information for the resource.NULLadded to help the parsersNUTRITIONORDERA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.OBSERVATIONMeasurements and simple assertions made about a patient, device or other subject.OBSERVATIONDEFINITIONSet of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.OIDAn OID represented as a URIOPERATIONDEFINITIONA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).OPERATIONOUTCOMEA collection of error, warning, or information messages that result from a system action.ORGANIZATIONA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.ORGANIZATIONAFFILIATIONDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.PARAMETERDEFINITIONThe parameters to the module.PARAMETERSThis resource is a non-persisted resource used to pass information into and back from an [operation](operations.html).PATIENTDemographics and other administrative information about an individual or animal receiving care or other health-related services.PAYMENTNOTICEThis resource provides the status of the payment for goods and services rendered, and the request and response resource references.PAYMENTRECONCILIATIONThis resource provides the details including amount of a payment and allocates the payment items being paid.PERIODA time period defined by a start and end date and optionally time.PERSONDemographics and administrative information about a person independent of a specific health-related context.PLANDEFINITIONThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact.POPULATIONA populatioof people with some set of grouping criteria.POSITIVEINTAn integer with a value that is positive (e.g.PRACTITIONERA person who is directly or indirectly involved in the provisioning of healthcare.PRACTITIONERROLEA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.PROCEDUREAn action that is or was performed on or for a patient.PRODCHARACTERISTICThe marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.PRODUCTSHELFLIFEThe shelf-life and storage information for a medicinal product item or container can be described using this class.PROVENANCEProvenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource.QUANTITYA measured amount (or an amount that can potentially be measured).QUESTIONNAIREA structured set of questions intended to guide the collection of answers from end-users.QUESTIONNAIRERESPONSEA structured set of questions and their answers.RANGEA set of ordered Quantities defined by a low and high limit.RATIOA relationship of two Quantity values - expressed as a numerator and a denominator.REFERENCEA reference from one resource to another.RELATEDARTIFACTRelated artifacts such as additional documentation, justification, or bibliographic references.RELATEDPERSONInformation about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.REQUESTGROUPA group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".RESEARCHDEFINITIONThe ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.RESEARCHELEMENTDEFINITIONThe ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.RESEARCHSTUDYA process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge.RESEARCHSUBJECTA physical entity which is the primary unit of operational and/or administrative interest in a study.RESOURCEThis is the base resource type for everything.RISKASSESSMENTAn assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.RISKEVIDENCESYNTHESISThe RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.SAMPLEDDATAA series of measurements taken by a device, with upper and lower limits.SCHEDULEA container for slots of time that may be available for booking appointments.SEARCHPARAMETERA search parameter that defines a named search item that can be used to search/filter on a resource.SERVICEREQUESTA record of a request for service such as diagnostic investigations, treatments, or operations to be performed.SIGNATUREA signature along with supporting context.SIMPLEQUANTITYnullSLOTA slot of time on a schedule that may be available for booking appointments.SPECIMENA sample to be used for analysis.SPECIMENDEFINITIONA kind of specimen with associated set of requirements.STRINGA sequence of Unicode charactersSTRUCTUREDEFINITIONA definition of a FHIR structure.STRUCTUREMAPA Map of relationships between 2 structures that can be used to transform data.SUBSCRIPTIONThe subscription resource is used to define a push-based subscription from a server to another system.SUBSTANCEA homogeneous material with a definite composition.SUBSTANCEAMOUNTChemical substances are a single substance type whose primary defining element is the molecular structure.SUBSTANCENUCLEICACIDNucleic acids are defined by three distinct elements: the base, sugar and linkage.SUBSTANCEPOLYMERTodo.SUBSTANCEPROTEINA SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship.SUBSTANCEREFERENCEINFORMATIONTodo.SUBSTANCESOURCEMATERIALSource material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance.SUBSTANCESPECIFICATIONThe detailed description of a substance, typically at a level beyond what is used for prescribing.SUPPLYDELIVERYRecord of delivery of what is supplied.SUPPLYREQUESTA record of a request for a medication, substance or device used in the healthcare setting.TASKA task to be performed.TERMINOLOGYCAPABILITIESA Terminology Capabilities documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.TESTREPORTA summary of information based on the results of executing a TestScript.TESTSCRIPTA structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.TIMEA time during the day, with no date specifiedTIMINGSpecifies an event that may occur multiple times.TRIGGERDEFINITIONA description of a triggering event.UNSIGNEDINTAn integer with a value that is not negative (e.g.URIString of characters used to identify a name or a resourceURLA URI that is a literal referenceUSAGECONTEXTSpecifies clinical/business/etc.UUIDA UUID, represented as a URIVALUESETA ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context.VERIFICATIONRESULTDescribes validation requirements, source(s), status and dates for one or more elements.VISIONPRESCRIPTIONAn authorization for the provision of glasses and/or contact lenses to a patient.XHTMLXHTML format, as defined by W3C, but restricted usage (mainly, no active content)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Enumerations.FHIRDefinedTypefromCode(String codeString)StringgetDefinition()StringgetDisplay()StringgetSystem()StringtoCode()static Enumerations.FHIRDefinedTypevalueOf(String name)Returns the enum constant of this type with the specified name.static Enumerations.FHIRDefinedType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ADDRESS
public static final Enumerations.FHIRDefinedType ADDRESS
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
-
AGE
public static final Enumerations.FHIRDefinedType AGE
A duration of time during which an organism (or a process) has existed.
-
ANNOTATION
public static final Enumerations.FHIRDefinedType ANNOTATION
A text note which also contains information about who made the statement and when.
-
ATTACHMENT
public static final Enumerations.FHIRDefinedType ATTACHMENT
For referring to data content defined in other formats.
-
BACKBONEELEMENT
public static final Enumerations.FHIRDefinedType BACKBONEELEMENT
Base definition for all elements that are defined inside a resource - but not those in a data type.
-
CODEABLECONCEPT
public static final Enumerations.FHIRDefinedType CODEABLECONCEPT
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
CODING
public static final Enumerations.FHIRDefinedType CODING
A reference to a code defined by a terminology system.
-
CONTACTDETAIL
public static final Enumerations.FHIRDefinedType CONTACTDETAIL
Specifies contact information for a person or organization.
-
CONTACTPOINT
public static final Enumerations.FHIRDefinedType CONTACTPOINT
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
CONTRIBUTOR
public static final Enumerations.FHIRDefinedType CONTRIBUTOR
A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
-
COUNT
public static final Enumerations.FHIRDefinedType COUNT
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
DATAREQUIREMENT
public static final Enumerations.FHIRDefinedType DATAREQUIREMENT
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
DISTANCE
public static final Enumerations.FHIRDefinedType DISTANCE
A length - a value with a unit that is a physical distance.
-
DOSAGE
public static final Enumerations.FHIRDefinedType DOSAGE
Indicates how the medication is/was taken or should be taken by the patient.
-
DURATION
public static final Enumerations.FHIRDefinedType DURATION
A length of time.
-
ELEMENT
public static final Enumerations.FHIRDefinedType ELEMENT
Base definition for all elements in a resource.
-
ELEMENTDEFINITION
public static final Enumerations.FHIRDefinedType ELEMENTDEFINITION
Captures constraints on each element within the resource, profile, or extension.
-
EXPRESSION
public static final Enumerations.FHIRDefinedType EXPRESSION
A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.
-
EXTENSION
public static final Enumerations.FHIRDefinedType EXTENSION
Optional Extension Element - found in all resources.
-
HUMANNAME
public static final Enumerations.FHIRDefinedType HUMANNAME
A human's name with the ability to identify parts and usage.
-
IDENTIFIER
public static final Enumerations.FHIRDefinedType IDENTIFIER
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
-
MARKETINGSTATUS
public static final Enumerations.FHIRDefinedType MARKETINGSTATUS
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
-
META
public static final Enumerations.FHIRDefinedType META
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
-
MONEY
public static final Enumerations.FHIRDefinedType MONEY
An amount of economic utility in some recognized currency.
-
MONEYQUANTITY
public static final Enumerations.FHIRDefinedType MONEYQUANTITY
null
-
NARRATIVE
public static final Enumerations.FHIRDefinedType NARRATIVE
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
-
PARAMETERDEFINITION
public static final Enumerations.FHIRDefinedType PARAMETERDEFINITION
The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
-
PERIOD
public static final Enumerations.FHIRDefinedType PERIOD
A time period defined by a start and end date and optionally time.
-
POPULATION
public static final Enumerations.FHIRDefinedType POPULATION
A populatioof people with some set of grouping criteria.
-
PRODCHARACTERISTIC
public static final Enumerations.FHIRDefinedType PRODCHARACTERISTIC
The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
-
PRODUCTSHELFLIFE
public static final Enumerations.FHIRDefinedType PRODUCTSHELFLIFE
The shelf-life and storage information for a medicinal product item or container can be described using this class.
-
QUANTITY
public static final Enumerations.FHIRDefinedType QUANTITY
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
RANGE
public static final Enumerations.FHIRDefinedType RANGE
A set of ordered Quantities defined by a low and high limit.
-
RATIO
public static final Enumerations.FHIRDefinedType RATIO
A relationship of two Quantity values - expressed as a numerator and a denominator.
-
REFERENCE
public static final Enumerations.FHIRDefinedType REFERENCE
A reference from one resource to another.
-
RELATEDARTIFACT
public static final Enumerations.FHIRDefinedType RELATEDARTIFACT
Related artifacts such as additional documentation, justification, or bibliographic references.
-
SAMPLEDDATA
public static final Enumerations.FHIRDefinedType SAMPLEDDATA
A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
-
SIGNATURE
public static final Enumerations.FHIRDefinedType SIGNATURE
A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.
-
SIMPLEQUANTITY
public static final Enumerations.FHIRDefinedType SIMPLEQUANTITY
null
-
SUBSTANCEAMOUNT
public static final Enumerations.FHIRDefinedType SUBSTANCEAMOUNT
Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.
-
TIMING
public static final Enumerations.FHIRDefinedType TIMING
Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
TRIGGERDEFINITION
public static final Enumerations.FHIRDefinedType TRIGGERDEFINITION
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
-
USAGECONTEXT
public static final Enumerations.FHIRDefinedType USAGECONTEXT
Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
-
BASE64BINARY
public static final Enumerations.FHIRDefinedType BASE64BINARY
A stream of bytes
-
BOOLEAN
public static final Enumerations.FHIRDefinedType BOOLEAN
Value of "true" or "false"
-
CANONICAL
public static final Enumerations.FHIRDefinedType CANONICAL
A URI that is a reference to a canonical URL on a FHIR resource
-
CODE
public static final Enumerations.FHIRDefinedType CODE
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
-
DATE
public static final Enumerations.FHIRDefinedType DATE
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
-
DATETIME
public static final Enumerations.FHIRDefinedType DATETIME
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
-
DECIMAL
public static final Enumerations.FHIRDefinedType DECIMAL
A rational number with implicit precision
-
ID
public static final Enumerations.FHIRDefinedType ID
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
-
INSTANT
public static final Enumerations.FHIRDefinedType INSTANT
An instant in time - known at least to the second
-
INTEGER
public static final Enumerations.FHIRDefinedType INTEGER
A whole number
-
MARKDOWN
public static final Enumerations.FHIRDefinedType MARKDOWN
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
-
OID
public static final Enumerations.FHIRDefinedType OID
An OID represented as a URI
-
POSITIVEINT
public static final Enumerations.FHIRDefinedType POSITIVEINT
An integer with a value that is positive (e.g. >0)
-
STRING
public static final Enumerations.FHIRDefinedType STRING
A sequence of Unicode characters
-
TIME
public static final Enumerations.FHIRDefinedType TIME
A time during the day, with no date specified
-
UNSIGNEDINT
public static final Enumerations.FHIRDefinedType UNSIGNEDINT
An integer with a value that is not negative (e.g. >= 0)
-
URI
public static final Enumerations.FHIRDefinedType URI
String of characters used to identify a name or a resource
-
URL
public static final Enumerations.FHIRDefinedType URL
A URI that is a literal reference
-
UUID
public static final Enumerations.FHIRDefinedType UUID
A UUID, represented as a URI
-
XHTML
public static final Enumerations.FHIRDefinedType XHTML
XHTML format, as defined by W3C, but restricted usage (mainly, no active content)
-
ACCOUNT
public static final Enumerations.FHIRDefinedType ACCOUNT
A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
-
ACTIVITYDEFINITION
public static final Enumerations.FHIRDefinedType ACTIVITYDEFINITION
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
-
ADVERSEEVENT
public static final Enumerations.FHIRDefinedType ADVERSEEVENT
Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
-
ALLERGYINTOLERANCE
public static final Enumerations.FHIRDefinedType ALLERGYINTOLERANCE
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
-
APPOINTMENT
public static final Enumerations.FHIRDefinedType APPOINTMENT
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
-
APPOINTMENTRESPONSE
public static final Enumerations.FHIRDefinedType APPOINTMENTRESPONSE
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
-
AUDITEVENT
public static final Enumerations.FHIRDefinedType AUDITEVENT
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
BASIC
public static final Enumerations.FHIRDefinedType BASIC
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
-
BINARY
public static final Enumerations.FHIRDefinedType BINARY
A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.
-
BIOLOGICALLYDERIVEDPRODUCT
public static final Enumerations.FHIRDefinedType BIOLOGICALLYDERIVEDPRODUCT
A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.
-
BODYSTRUCTURE
public static final Enumerations.FHIRDefinedType BODYSTRUCTURE
Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.
-
BUNDLE
public static final Enumerations.FHIRDefinedType BUNDLE
A container for a collection of resources.
-
CAPABILITYSTATEMENT
public static final Enumerations.FHIRDefinedType CAPABILITYSTATEMENT
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
CAREPLAN
public static final Enumerations.FHIRDefinedType CAREPLAN
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
-
CARETEAM
public static final Enumerations.FHIRDefinedType CARETEAM
The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
-
CATALOGENTRY
public static final Enumerations.FHIRDefinedType CATALOGENTRY
Catalog entries are wrappers that contextualize items included in a catalog.
-
CHARGEITEM
public static final Enumerations.FHIRDefinedType CHARGEITEM
The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
-
CHARGEITEMDEFINITION
public static final Enumerations.FHIRDefinedType CHARGEITEMDEFINITION
The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.
-
CLAIM
public static final Enumerations.FHIRDefinedType CLAIM
A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.
-
CLAIMRESPONSE
public static final Enumerations.FHIRDefinedType CLAIMRESPONSE
This resource provides the adjudication details from the processing of a Claim resource.
-
CLINICALIMPRESSION
public static final Enumerations.FHIRDefinedType CLINICALIMPRESSION
A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
-
CODESYSTEM
public static final Enumerations.FHIRDefinedType CODESYSTEM
The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.
-
COMMUNICATION
public static final Enumerations.FHIRDefinedType COMMUNICATION
An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.
-
COMMUNICATIONREQUEST
public static final Enumerations.FHIRDefinedType COMMUNICATIONREQUEST
A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
-
COMPARTMENTDEFINITION
public static final Enumerations.FHIRDefinedType COMPARTMENTDEFINITION
A compartment definition that defines how resources are accessed on a server.
-
COMPOSITION
public static final Enumerations.FHIRDefinedType COMPOSITION
A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
-
CONCEPTMAP
public static final Enumerations.FHIRDefinedType CONCEPTMAP
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.
-
CONDITION
public static final Enumerations.FHIRDefinedType CONDITION
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
-
CONSENT
public static final Enumerations.FHIRDefinedType CONSENT
A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
CONTRACT
public static final Enumerations.FHIRDefinedType CONTRACT
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
-
COVERAGE
public static final Enumerations.FHIRDefinedType COVERAGE
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
-
COVERAGEELIGIBILITYREQUEST
public static final Enumerations.FHIRDefinedType COVERAGEELIGIBILITYREQUEST
The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
-
COVERAGEELIGIBILITYRESPONSE
public static final Enumerations.FHIRDefinedType COVERAGEELIGIBILITYRESPONSE
This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
-
DETECTEDISSUE
public static final Enumerations.FHIRDefinedType DETECTEDISSUE
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
-
DEVICE
public static final Enumerations.FHIRDefinedType DEVICE
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
-
DEVICEDEFINITION
public static final Enumerations.FHIRDefinedType DEVICEDEFINITION
The characteristics, operational status and capabilities of a medical-related component of a medical device.
-
DEVICEMETRIC
public static final Enumerations.FHIRDefinedType DEVICEMETRIC
Describes a measurement, calculation or setting capability of a medical device.
-
DEVICEREQUEST
public static final Enumerations.FHIRDefinedType DEVICEREQUEST
Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
-
DEVICEUSESTATEMENT
public static final Enumerations.FHIRDefinedType DEVICEUSESTATEMENT
A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
-
DIAGNOSTICREPORT
public static final Enumerations.FHIRDefinedType DIAGNOSTICREPORT
The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
-
DOCUMENTMANIFEST
public static final Enumerations.FHIRDefinedType DOCUMENTMANIFEST
A collection of documents compiled for a purpose together with metadata that applies to the collection.
-
DOCUMENTREFERENCE
public static final Enumerations.FHIRDefinedType DOCUMENTREFERENCE
A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.
-
DOMAINRESOURCE
public static final Enumerations.FHIRDefinedType DOMAINRESOURCE
A resource that includes narrative, extensions, and contained resources.
-
EFFECTEVIDENCESYNTHESIS
public static final Enumerations.FHIRDefinedType EFFECTEVIDENCESYNTHESIS
The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.
-
ENCOUNTER
public static final Enumerations.FHIRDefinedType ENCOUNTER
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
ENDPOINT
public static final Enumerations.FHIRDefinedType ENDPOINT
The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
-
ENROLLMENTREQUEST
public static final Enumerations.FHIRDefinedType ENROLLMENTREQUEST
This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
-
ENROLLMENTRESPONSE
public static final Enumerations.FHIRDefinedType ENROLLMENTRESPONSE
This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
-
EPISODEOFCARE
public static final Enumerations.FHIRDefinedType EPISODEOFCARE
An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
-
EVENTDEFINITION
public static final Enumerations.FHIRDefinedType EVENTDEFINITION
The EventDefinition resource provides a reusable description of when a particular event can occur.
-
EVIDENCE
public static final Enumerations.FHIRDefinedType EVIDENCE
The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.
-
EVIDENCEVARIABLE
public static final Enumerations.FHIRDefinedType EVIDENCEVARIABLE
The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
-
EXAMPLESCENARIO
public static final Enumerations.FHIRDefinedType EXAMPLESCENARIO
Example of workflow instance.
-
EXPLANATIONOFBENEFIT
public static final Enumerations.FHIRDefinedType EXPLANATIONOFBENEFIT
This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
FAMILYMEMBERHISTORY
public static final Enumerations.FHIRDefinedType FAMILYMEMBERHISTORY
Significant health conditions for a person related to the patient relevant in the context of care for the patient.
-
FLAG
public static final Enumerations.FHIRDefinedType FLAG
Prospective warnings of potential issues when providing care to the patient.
-
GOAL
public static final Enumerations.FHIRDefinedType GOAL
Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
-
GRAPHDEFINITION
public static final Enumerations.FHIRDefinedType GRAPHDEFINITION
A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
GROUP
public static final Enumerations.FHIRDefinedType GROUP
Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.
-
GUIDANCERESPONSE
public static final Enumerations.FHIRDefinedType GUIDANCERESPONSE
A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.
-
HEALTHCARESERVICE
public static final Enumerations.FHIRDefinedType HEALTHCARESERVICE
The details of a healthcare service available at a location.
-
IMAGINGSTUDY
public static final Enumerations.FHIRDefinedType IMAGINGSTUDY
Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
-
IMMUNIZATION
public static final Enumerations.FHIRDefinedType IMMUNIZATION
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
-
IMMUNIZATIONEVALUATION
public static final Enumerations.FHIRDefinedType IMMUNIZATIONEVALUATION
Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.
-
IMMUNIZATIONRECOMMENDATION
public static final Enumerations.FHIRDefinedType IMMUNIZATIONRECOMMENDATION
A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
-
IMPLEMENTATIONGUIDE
public static final Enumerations.FHIRDefinedType IMPLEMENTATIONGUIDE
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
INSURANCEPLAN
public static final Enumerations.FHIRDefinedType INSURANCEPLAN
Details of a Health Insurance product/plan provided by an organization.
-
INVOICE
public static final Enumerations.FHIRDefinedType INVOICE
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
-
LIBRARY
public static final Enumerations.FHIRDefinedType LIBRARY
The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
-
LINKAGE
public static final Enumerations.FHIRDefinedType LINKAGE
Identifies two or more records (resource instances) that refer to the same real-world "occurrence".
-
LIST
public static final Enumerations.FHIRDefinedType LIST
A list is a curated collection of resources.
-
LOCATION
public static final Enumerations.FHIRDefinedType LOCATION
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
-
MEASURE
public static final Enumerations.FHIRDefinedType MEASURE
The Measure resource provides the definition of a quality measure.
-
MEASUREREPORT
public static final Enumerations.FHIRDefinedType MEASUREREPORT
The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
-
MEDIA
public static final Enumerations.FHIRDefinedType MEDIA
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
-
MEDICATION
public static final Enumerations.FHIRDefinedType MEDICATION
This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.
-
MEDICATIONADMINISTRATION
public static final Enumerations.FHIRDefinedType MEDICATIONADMINISTRATION
Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
-
MEDICATIONDISPENSE
public static final Enumerations.FHIRDefinedType MEDICATIONDISPENSE
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
-
MEDICATIONKNOWLEDGE
public static final Enumerations.FHIRDefinedType MEDICATIONKNOWLEDGE
Information about a medication that is used to support knowledge.
-
MEDICATIONREQUEST
public static final Enumerations.FHIRDefinedType MEDICATIONREQUEST
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
MEDICATIONSTATEMENT
public static final Enumerations.FHIRDefinedType MEDICATIONSTATEMENT
A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.
-
MEDICINALPRODUCT
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCT
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
-
MEDICINALPRODUCTAUTHORIZATION
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTAUTHORIZATION
The regulatory authorization of a medicinal product.
-
MEDICINALPRODUCTCONTRAINDICATION
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTCONTRAINDICATION
The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.
-
MEDICINALPRODUCTINDICATION
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTINDICATION
Indication for the Medicinal Product.
-
MEDICINALPRODUCTINGREDIENT
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTINGREDIENT
An ingredient of a manufactured item or pharmaceutical product.
-
MEDICINALPRODUCTINTERACTION
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTINTERACTION
The interactions of the medicinal product with other medicinal products, or other forms of interactions.
-
MEDICINALPRODUCTMANUFACTURED
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTMANUFACTURED
The manufactured item as contained in the packaged medicinal product.
-
MEDICINALPRODUCTPACKAGED
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTPACKAGED
A medicinal product in a container or package.
-
MEDICINALPRODUCTPHARMACEUTICAL
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTPHARMACEUTICAL
A pharmaceutical product described in terms of its composition and dose form.
-
MEDICINALPRODUCTUNDESIRABLEEFFECT
public static final Enumerations.FHIRDefinedType MEDICINALPRODUCTUNDESIRABLEEFFECT
Describe the undesirable effects of the medicinal product.
-
MESSAGEDEFINITION
public static final Enumerations.FHIRDefinedType MESSAGEDEFINITION
Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
-
MESSAGEHEADER
public static final Enumerations.FHIRDefinedType MESSAGEHEADER
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
MOLECULARSEQUENCE
public static final Enumerations.FHIRDefinedType MOLECULARSEQUENCE
Raw data describing a biological sequence.
-
NAMINGSYSTEM
public static final Enumerations.FHIRDefinedType NAMINGSYSTEM
A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.
-
NUTRITIONORDER
public static final Enumerations.FHIRDefinedType NUTRITIONORDER
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
OBSERVATION
public static final Enumerations.FHIRDefinedType OBSERVATION
Measurements and simple assertions made about a patient, device or other subject.
-
OBSERVATIONDEFINITION
public static final Enumerations.FHIRDefinedType OBSERVATIONDEFINITION
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
-
OPERATIONDEFINITION
public static final Enumerations.FHIRDefinedType OPERATIONDEFINITION
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
OPERATIONOUTCOME
public static final Enumerations.FHIRDefinedType OPERATIONOUTCOME
A collection of error, warning, or information messages that result from a system action.
-
ORGANIZATION
public static final Enumerations.FHIRDefinedType ORGANIZATION
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
-
ORGANIZATIONAFFILIATION
public static final Enumerations.FHIRDefinedType ORGANIZATIONAFFILIATION
Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.
-
PARAMETERS
public static final Enumerations.FHIRDefinedType PARAMETERS
This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.
-
PATIENT
public static final Enumerations.FHIRDefinedType PATIENT
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
-
PAYMENTNOTICE
public static final Enumerations.FHIRDefinedType PAYMENTNOTICE
This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
-
PAYMENTRECONCILIATION
public static final Enumerations.FHIRDefinedType PAYMENTRECONCILIATION
This resource provides the details including amount of a payment and allocates the payment items being paid.
-
PERSON
public static final Enumerations.FHIRDefinedType PERSON
Demographics and administrative information about a person independent of a specific health-related context.
-
PLANDEFINITION
public static final Enumerations.FHIRDefinedType PLANDEFINITION
This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
PRACTITIONER
public static final Enumerations.FHIRDefinedType PRACTITIONER
A person who is directly or indirectly involved in the provisioning of healthcare.
-
PRACTITIONERROLE
public static final Enumerations.FHIRDefinedType PRACTITIONERROLE
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
-
PROCEDURE
public static final Enumerations.FHIRDefinedType PROCEDURE
An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.
-
PROVENANCE
public static final Enumerations.FHIRDefinedType PROVENANCE
Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
-
QUESTIONNAIRE
public static final Enumerations.FHIRDefinedType QUESTIONNAIRE
A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
QUESTIONNAIRERESPONSE
public static final Enumerations.FHIRDefinedType QUESTIONNAIRERESPONSE
A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
-
RELATEDPERSON
public static final Enumerations.FHIRDefinedType RELATEDPERSON
Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
-
REQUESTGROUP
public static final Enumerations.FHIRDefinedType REQUESTGROUP
A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".
-
RESEARCHDEFINITION
public static final Enumerations.FHIRDefinedType RESEARCHDEFINITION
The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.
-
RESEARCHELEMENTDEFINITION
public static final Enumerations.FHIRDefinedType RESEARCHELEMENTDEFINITION
The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
-
RESEARCHSTUDY
public static final Enumerations.FHIRDefinedType RESEARCHSTUDY
A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
-
RESEARCHSUBJECT
public static final Enumerations.FHIRDefinedType RESEARCHSUBJECT
A physical entity which is the primary unit of operational and/or administrative interest in a study.
-
RESOURCE
public static final Enumerations.FHIRDefinedType RESOURCE
This is the base resource type for everything.
-
RISKASSESSMENT
public static final Enumerations.FHIRDefinedType RISKASSESSMENT
An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
-
RISKEVIDENCESYNTHESIS
public static final Enumerations.FHIRDefinedType RISKEVIDENCESYNTHESIS
The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.
-
SCHEDULE
public static final Enumerations.FHIRDefinedType SCHEDULE
A container for slots of time that may be available for booking appointments.
-
SEARCHPARAMETER
public static final Enumerations.FHIRDefinedType SEARCHPARAMETER
A search parameter that defines a named search item that can be used to search/filter on a resource.
-
SERVICEREQUEST
public static final Enumerations.FHIRDefinedType SERVICEREQUEST
A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
-
SLOT
public static final Enumerations.FHIRDefinedType SLOT
A slot of time on a schedule that may be available for booking appointments.
-
SPECIMEN
public static final Enumerations.FHIRDefinedType SPECIMEN
A sample to be used for analysis.
-
SPECIMENDEFINITION
public static final Enumerations.FHIRDefinedType SPECIMENDEFINITION
A kind of specimen with associated set of requirements.
-
STRUCTUREDEFINITION
public static final Enumerations.FHIRDefinedType STRUCTUREDEFINITION
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
STRUCTUREMAP
public static final Enumerations.FHIRDefinedType STRUCTUREMAP
A Map of relationships between 2 structures that can be used to transform data.
-
SUBSCRIPTION
public static final Enumerations.FHIRDefinedType SUBSCRIPTION
The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
-
SUBSTANCE
public static final Enumerations.FHIRDefinedType SUBSTANCE
A homogeneous material with a definite composition.
-
SUBSTANCENUCLEICACID
public static final Enumerations.FHIRDefinedType SUBSTANCENUCLEICACID
Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.
-
SUBSTANCEPOLYMER
public static final Enumerations.FHIRDefinedType SUBSTANCEPOLYMER
Todo.
-
SUBSTANCEPROTEIN
public static final Enumerations.FHIRDefinedType SUBSTANCEPROTEIN
A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.
-
SUBSTANCEREFERENCEINFORMATION
public static final Enumerations.FHIRDefinedType SUBSTANCEREFERENCEINFORMATION
Todo.
-
SUBSTANCESOURCEMATERIAL
public static final Enumerations.FHIRDefinedType SUBSTANCESOURCEMATERIAL
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.
-
SUBSTANCESPECIFICATION
public static final Enumerations.FHIRDefinedType SUBSTANCESPECIFICATION
The detailed description of a substance, typically at a level beyond what is used for prescribing.
-
SUPPLYDELIVERY
public static final Enumerations.FHIRDefinedType SUPPLYDELIVERY
Record of delivery of what is supplied.
-
SUPPLYREQUEST
public static final Enumerations.FHIRDefinedType SUPPLYREQUEST
A record of a request for a medication, substance or device used in the healthcare setting.
-
TASK
public static final Enumerations.FHIRDefinedType TASK
A task to be performed.
-
TERMINOLOGYCAPABILITIES
public static final Enumerations.FHIRDefinedType TERMINOLOGYCAPABILITIES
A Terminology Capabilities documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
TESTREPORT
public static final Enumerations.FHIRDefinedType TESTREPORT
A summary of information based on the results of executing a TestScript.
-
TESTSCRIPT
public static final Enumerations.FHIRDefinedType TESTSCRIPT
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
-
VALUESET
public static final Enumerations.FHIRDefinedType VALUESET
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).
-
VERIFICATIONRESULT
public static final Enumerations.FHIRDefinedType VERIFICATIONRESULT
Describes validation requirements, source(s), status and dates for one or more elements.
-
VISIONPRESCRIPTION
public static final Enumerations.FHIRDefinedType VISIONPRESCRIPTION
An authorization for the provision of glasses and/or contact lenses to a patient.
-
NULL
public static final Enumerations.FHIRDefinedType NULL
added to help the parsers
-
-
Method Detail
-
values
public static Enumerations.FHIRDefinedType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Enumerations.FHIRDefinedType c : Enumerations.FHIRDefinedType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Enumerations.FHIRDefinedType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
fromCode
public static Enumerations.FHIRDefinedType fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getDefinition
public String getDefinition()
-
getDisplay
public String getDisplay()
-
-