Package org.hl7.fhir.r4.model
Enum Enumerations.FHIRAllTypes
- All Implemented Interfaces:
Serializable,Comparable<Enumerations.FHIRAllTypes>
- Enclosing class:
Enumerations
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA financial tool for tracking value accrued for a particular purpose.This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.An address expressed using postal conventions (as opposed to GPS or other location definition formats).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.A duration of time during which an organism (or a process) has existed.Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.A text note which also contains information about who made the statement and when.A place holder that means any kind of resourceA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time.A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.For referring to data content defined in other formats.A record of an event made for purposes of maintaining a security log.Base definition for all elements that are defined inside a resource - but not those in a data type.A stream of bytesBasic 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.A resource that represents the data of a single raw artifact as digital content accessible in its native format.A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.Record details about an anatomical structure.Value of "true" or "false"A container for a collection of resources.A URI that is a reference to a canonical URL on a FHIR resourceA 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.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.The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.Catalog entries are wrappers that contextualize items included in a catalog.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.The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices.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.This resource provides the adjudication details from the processing of a Claim resource.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.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 contentsA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.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.A reference to a code defined by a terminology system.An occurrence of information being transmitted; e.g.A request to convey information; e.g.A compartment definition that defines how resources are accessed on a server.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 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.A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.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.Specifies contact information for a person or organization.Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.A measured amount (or an amount that can potentially be measured).Financial instrument which may be used to reimburse or pay for health care products and services.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.This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.A date or partial date (e.g.A date, date-time or partial date (e.g.A rational number with implicit precisionIndicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g.A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity.The characteristics, operational status and capabilities of a medical-related component of a medical device.Describes a measurement, calculation or setting capability of a medical device.Represents a request for a patient to employ a medical device.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.The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these.A length - a value with a unit that is a physical distance.A collection of documents compiled for a purpose together with metadata that applies to the collection.A reference to a document of any kind for any purpose.A resource that includes narrative, extensions, and contained resources.Indicates how the medication is/was taken or should be taken by the patient.A length of time.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.Base definition for all elements in a resource.Captures constraints on each element within the resource, profile, or extension.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.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 resource provides the insurance enrollment details to the insurer regarding a specified coverage.This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.An association between a patient and an organization / healthcare provider(s) during which time encounters may occur.The EventDefinition resource provides a reusable description of when a particular event can occur.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.The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.Example of workflow instance.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.A expression that is evaluated in a specified context and returns a value.Optional Extension Element - found in all resources.Significant health conditions for a person related to the patient relevant in the context of care for the patient.Prospective warnings of potential issues when providing care to the patient.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.A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references.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 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.The details of a healthcare service available at a location.A human's name with the ability to identify parts and usage.Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.An identifier - identifies some entity uniquely and unambiguously.Representation of the content produced in a DICOM imaging study.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.Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.A patient's point-in-time set of recommendations (i.e.A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources.An instant in time - known at least to the secondDetails of a Health Insurance product/plan provided by an organization.A whole numberInvoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.The Library resource is a general-purpose container for knowledge asset definitions.Identifies two or more records (resource instances) that refer to the same real-world "occurrence".A list is a curated collection of resources.Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engineThe 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.The Measure resource provides the definition of a quality measure.The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.A photo, video, or audio recording acquired or used in healthcare.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.Describes the event of a patient consuming or otherwise being administered a medication.Indicates that a medication product is to be or has been dispensed for a named person/patient.Information about a medication that is used to support knowledge.An order or request for both supply of the medication and the instructions for administration of the medication to a patient.A record of a medication that is being consumed by a patient.Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g.The regulatory authorization of a medicinal product.The clinical particulars - indications, contraindications etc.Indication for the Medicinal Product.An ingredient of a manufactured item or pharmaceutical product.The interactions of the medicinal product with other medicinal products, or other forms of interactions.The manufactured item as contained in the packaged medicinal product.A medicinal product in a container or package.A pharmaceutical product described in terms of its composition and dose form.Describe the undesirable effects of the medicinal product.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.The header for a message exchange that is either requesting or responding to an action.The metadata about a resource.Raw data describing a biological sequence.An amount of economic utility in some recognized currency.nullA curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc.A human-readable summary of the resource conveying the essential clinical and business information for the resource.added to help the parsersA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.Measurements and simple assertions made about a patient, device or other subject.Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.An OID represented as a URIA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).A collection of error, warning, or information messages that result from a system action.A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.The parameters to the module.This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html).Demographics and other administrative information about an individual or animal receiving care or other health-related services.This resource provides the status of the payment for goods and services rendered, and the request and response resource references.This resource provides the details including amount of a payment and allocates the payment items being paid.A time period defined by a start and end date and optionally time.Demographics and administrative information about a person independent of a specific health-related context.This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact.A populatioof people with some set of grouping criteria.An integer with a value that is positive (e.g.A person who is directly or indirectly involved in the provisioning of healthcare.A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.An action that is or was performed on or for a patient.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.The shelf-life and storage information for a medicinal product item or container can be described using this class.Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource.A measured amount (or an amount that can potentially be measured).A structured set of questions intended to guide the collection of answers from end-users.A structured set of questions and their answers.A set of ordered Quantities defined by a low and high limit.A relationship of two Quantity values - expressed as a numerator and a denominator.A reference from one resource to another.Related artifacts such as additional documentation, justification, or bibliographic references.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.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".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.The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge.A physical entity which is the primary unit of operational and/or administrative interest in a study.This is the base resource type for everything.An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.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.A series of measurements taken by a device, with upper and lower limits.A container for slots of time that may be available for booking appointments.A search parameter that defines a named search item that can be used to search/filter on a resource.A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.A signature along with supporting context.nullA slot of time on a schedule that may be available for booking appointments.A sample to be used for analysis.A kind of specimen with associated set of requirements.A sequence of Unicode charactersA definition of a FHIR structure.A Map of relationships between 2 structures that can be used to transform data.The subscription resource is used to define a push-based subscription from a server to another system.A homogeneous material with a definite composition.Chemical substances are a single substance type whose primary defining element is the molecular structure.Nucleic acids are defined by three distinct elements: the base, sugar and linkage.Todo.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.Todo.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.The detailed description of a substance, typically at a level beyond what is used for prescribing.Record of delivery of what is supplied.A record of a request for a medication, substance or device used in the healthcare setting.A task to be performed.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.A summary of information based on the results of executing a TestScript.A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.A time during the day, with no date specifiedSpecifies an event that may occur multiple times.A description of a triggering event.A place holder that means any kind of data typeAn integer with a value that is not negative (e.g.String of characters used to identify a name or a resourceA URI that is a literal referenceSpecifies clinical/business/etc.A UUID, represented as a URIA ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context.Describes validation requirements, source(s), status and dates for one or more elements.An authorization for the provision of glasses and/or contact lenses to a patient.XHTML format, as defined by W3C, but restricted usage (mainly, no active content) -
Method Summary
Modifier and TypeMethodDescriptionstatic Enumerations.FHIRAllTypestoCode()static Enumerations.FHIRAllTypesReturns the enum constant of this type with the specified name.static Enumerations.FHIRAllTypes[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
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
A duration of time during which an organism (or a process) has existed. -
ANNOTATION
A text note which also contains information about who made the statement and when. -
ATTACHMENT
For referring to data content defined in other formats. -
BACKBONEELEMENT
Base definition for all elements that are defined inside a resource - but not those in a data type. -
CODEABLECONCEPT
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. -
CODING
A reference to a code defined by a terminology system. -
CONTACTDETAIL
Specifies contact information for a person or organization. -
CONTACTPOINT
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. -
CONTRIBUTOR
A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers. -
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
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
A length - a value with a unit that is a physical distance. -
DOSAGE
Indicates how the medication is/was taken or should be taken by the patient. -
DURATION
A length of time. -
ELEMENT
Base definition for all elements in a resource. -
ELEMENTDEFINITION
Captures constraints on each element within the resource, profile, or extension. -
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
Optional Extension Element - found in all resources. -
HUMANNAME
A human's name with the ability to identify parts and usage. -
IDENTIFIER
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. -
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
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
An amount of economic utility in some recognized currency. -
MONEYQUANTITY
null -
NARRATIVE
A human-readable summary of the resource conveying the essential clinical and business information for the resource. -
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
A time period defined by a start and end date and optionally time. -
POPULATION
A populatioof people with some set of grouping criteria. -
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
The shelf-life and storage information for a medicinal product item or container can be described using this class. -
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
A set of ordered Quantities defined by a low and high limit. -
RATIO
A relationship of two Quantity values - expressed as a numerator and a denominator. -
REFERENCE
A reference from one resource to another. -
RELATEDARTIFACT
Related artifacts such as additional documentation, justification, or bibliographic references. -
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
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
null -
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
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
A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element. -
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
A stream of bytes -
BOOLEAN
Value of "true" or "false" -
CANONICAL
A URI that is a reference to a canonical URL on a FHIR resource -
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
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
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
A rational number with implicit precision -
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
An instant in time - known at least to the second -
INTEGER
A whole number -
MARKDOWN
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine -
OID
An OID represented as a URI -
POSITIVEINT
An integer with a value that is positive (e.g. >0) -
STRING
A sequence of Unicode characters -
TIME
A time during the day, with no date specified -
UNSIGNEDINT
An integer with a value that is not negative (e.g. >= 0) -
URI
String of characters used to identify a name or a resource -
URL
A URI that is a literal reference -
UUID
A UUID, represented as a URI -
XHTML
XHTML format, as defined by W3C, but restricted usage (mainly, no active content) -
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
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. -
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
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. -
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
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. -
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
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
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
A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity. -
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
A container for a collection of resources. -
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
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
The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient. -
CATALOGENTRY
Catalog entries are wrappers that contextualize items included in a catalog. -
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
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
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
This resource provides the adjudication details from the processing of a Claim resource. -
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
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
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
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
A compartment definition that defines how resources are accessed on a server. -
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
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
A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. -
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
Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement. -
COVERAGE
Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment. -
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
This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource. -
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
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
The characteristics, operational status and capabilities of a medical-related component of a medical device. -
DEVICEMETRIC
Describes a measurement, calculation or setting capability of a medical device. -
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
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
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
A collection of documents compiled for a purpose together with metadata that applies to the collection. -
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
A resource that includes narrative, extensions, and contained resources. -
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
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
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
This resource provides the insurance enrollment details to the insurer regarding a specified coverage. -
ENROLLMENTRESPONSE
This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource. -
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
The EventDefinition resource provides a reusable description of when a particular event can occur. -
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
The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about. -
EXAMPLESCENARIO
Example of workflow instance. -
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
Significant health conditions for a person related to the patient relevant in the context of care for the patient. -
FLAG
Prospective warnings of potential issues when providing care to the patient. -
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
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
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
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
The details of a healthcare service available at a location. -
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
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
Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations. -
IMMUNIZATIONRECOMMENDATION
A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification. -
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
Details of a Health Insurance product/plan provided by an organization. -
INVOICE
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. -
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
Identifies two or more records (resource instances) that refer to the same real-world "occurrence". -
LIST
A list is a curated collection of resources. -
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
The Measure resource provides the definition of a quality measure. -
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
A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. -
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
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
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
Information about a medication that is used to support knowledge. -
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
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
Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use). -
MEDICINALPRODUCTAUTHORIZATION
The regulatory authorization of a medicinal product. -
MEDICINALPRODUCTCONTRAINDICATION
The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes. -
MEDICINALPRODUCTINDICATION
Indication for the Medicinal Product. -
MEDICINALPRODUCTINGREDIENT
An ingredient of a manufactured item or pharmaceutical product. -
MEDICINALPRODUCTINTERACTION
The interactions of the medicinal product with other medicinal products, or other forms of interactions. -
MEDICINALPRODUCTMANUFACTURED
The manufactured item as contained in the packaged medicinal product. -
MEDICINALPRODUCTPACKAGED
A medicinal product in a container or package. -
MEDICINALPRODUCTPHARMACEUTICAL
A pharmaceutical product described in terms of its composition and dose form. -
MEDICINALPRODUCTUNDESIRABLEEFFECT
Describe the undesirable effects of the medicinal product. -
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
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
Raw data describing a biological sequence. -
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
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident. -
OBSERVATION
Measurements and simple assertions made about a patient, device or other subject. -
OBSERVATIONDEFINITION
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service. -
OPERATIONDEFINITION
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction). -
OPERATIONOUTCOME
A collection of error, warning, or information messages that result from a system action. -
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
Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. -
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
Demographics and other administrative information about an individual or animal receiving care or other health-related services. -
PAYMENTNOTICE
This resource provides the status of the payment for goods and services rendered, and the request and response resource references. -
PAYMENTRECONCILIATION
This resource provides the details including amount of a payment and allocates the payment items being paid. -
PERSON
Demographics and administrative information about a person independent of a specific health-related context. -
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
A person who is directly or indirectly involved in the provisioning of healthcare. -
PRACTITIONERROLE
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. -
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
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
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
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
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
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
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
The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about. -
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
A physical entity which is the primary unit of operational and/or administrative interest in a study. -
RESOURCE
This is the base resource type for everything. -
RISKASSESSMENT
An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome. -
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
A container for slots of time that may be available for booking appointments. -
SEARCHPARAMETER
A search parameter that defines a named search item that can be used to search/filter on a resource. -
SERVICEREQUEST
A record of a request for service such as diagnostic investigations, treatments, or operations to be performed. -
SLOT
A slot of time on a schedule that may be available for booking appointments. -
SPECIMEN
A sample to be used for analysis. -
SPECIMENDEFINITION
A kind of specimen with associated set of requirements. -
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
A Map of relationships between 2 structures that can be used to transform data. -
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
A homogeneous material with a definite composition. -
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
Todo. -
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
Todo. -
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
The detailed description of a substance, typically at a level beyond what is used for prescribing. -
SUPPLYDELIVERY
Record of delivery of what is supplied. -
SUPPLYREQUEST
A record of a request for a medication, substance or device used in the healthcare setting. -
TASK
A task to be performed. -
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
A summary of information based on the results of executing a TestScript. -
TESTSCRIPT
A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification. -
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
Describes validation requirements, source(s), status and dates for one or more elements. -
VISIONPRESCRIPTION
An authorization for the provision of glasses and/or contact lenses to a patient. -
TYPE
A place holder that means any kind of data type -
ANY
A place holder that means any kind of resource -
NULL
added to help the parsers
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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.FHIRAllTypes fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException - Throws:
org.hl7.fhir.exceptions.FHIRException
-
toCode
-
getSystem
-
getDefinition
-
getDisplay
-