FHIR Cross-Version Extensions package for FHIR R5 from FHIR R4
0.0.1-snapshot-2 - informative International flag

FHIR Cross-Version Extensions package for FHIR R5 from FHIR R4 - Version 0.0.1-snapshot-2. See the Directory of published versions

ValueSet: Cross-version VS for R4.FHIRDefinedType for use in FHIR R5

Official URL: http://hl7.org/fhir/4.0/ValueSet/R4-defined-types-for-R5 Version: 0.0.1-snapshot-2
Standards status: Informative Maturity Level: 5 Computable Name: R4_defined_types_for_R5

This cross-version ValueSet represents concepts from http://hl7.org/fhir/ValueSet/defined-types 4.0.1 for use in FHIR R5. Concepts not present here have direct equivalent mappings crossing all versions from R4 to R5.

References

Logical Definition (CLD)

This value set includes codes based on the following rules:

  • Include these codes as defined in http://hl7.org/fhir/data-types version 4.0.1
    CodeDisplayDefinition
    AgeAgeA duration of time during which an organism (or a process) has existed.
    AttachmentAttachmentFor referring to data content defined in other formats.
    CodeableConceptCodeableConceptA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
    ContactDetailContactDetailSpecifies contact information for a person or organization.
    ContributorContributorA contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
    DataRequirementDataRequirementDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
    DosageDosageIndicates how the medication is/was taken or should be taken by the patient.
    ElementElementBase definition for all elements in a resource.
    ExpressionExpressionA 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.
    HumanNameHumanNameA human's name with the ability to identify parts and usage.
    MarketingStatusMarketingStatusThe 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.
    MoneyMoneyAn amount of economic utility in some recognized currency.
    NarrativeNarrativeA human-readable summary of the resource conveying the essential clinical and business information for the resource.
    PeriodPeriodA time period defined by a start and end date and optionally time.
    ProdCharacteristicProdCharacteristicThe 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.
    QuantityQuantityA 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.
    RatioRatioA relationship of two Quantity values - expressed as a numerator and a denominator.
    RelatedArtifactRelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.
    SignatureSignatureA 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.
    SubstanceAmountSubstanceAmountChemical 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.
    AddressAddressAn 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.
    AnnotationAnnotationA text note which also contains information about who made the statement and when.
    BackboneElementBackboneElementBase definition for all elements that are defined inside a resource - but not those in a data type.
    CodingCodingA reference to a code defined by a terminology system.
    ContactPointContactPointDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
    CountCountA 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.
    DistanceDistanceA length - a value with a unit that is a physical distance.
    DurationDurationA length of time.
    ElementDefinitionElementDefinitionCaptures constraints on each element within the resource, profile, or extension.
    ExtensionExtensionOptional Extension Element - found in all resources.
    IdentifierIdentifierAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
    MetaMetaThe 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.
    MoneyQuantityMoneyQuantity
    ParameterDefinitionParameterDefinitionThe 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.
    PopulationPopulationA populatioof people with some set of grouping criteria.
    ProductShelfLifeProductShelfLifeThe shelf-life and storage information for a medicinal product item or container can be described using this class.
    RangeRangeA set of ordered Quantities defined by a low and high limit.
    ReferenceReferenceA reference from one resource to another.
    SampledDataSampledDataA series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
    SimpleQuantitySimpleQuantity
    TimingTimingSpecifies 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.
    TriggerDefinitionTriggerDefinitionA description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
    UsageContextUsageContextSpecifies 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).
    base64Binarybase64BinaryA stream of bytes
    booleanbooleanValue of "true" or "false"
    canonicalcanonicalA URI that is a reference to a canonical URL on a FHIR resource
    codecodeA 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
    datedateA 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.
    dateTimedateTimeA 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.
    decimaldecimalA rational number with implicit precision
    ididAny 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.
    instantinstantAn instant in time - known at least to the second
    integerintegerA whole number
    markdownmarkdownA string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
    oidoidAn OID represented as a URI
    positiveIntpositiveIntAn integer with a value that is positive (e.g. >0)
    stringstringA sequence of Unicode characters
    timetimeA time during the day, with no date specified
    unsignedIntunsignedIntAn integer with a value that is not negative (e.g. >= 0)
    uriuriString of characters used to identify a name or a resource
    urlurlA URI that is a literal reference
    uuiduuidA UUID, represented as a URI
    xhtmlXHTMLXHTML format, as defined by W3C, but restricted usage (mainly, no active content)
  • Include these codes as defined in http://hl7.org/fhir/resource-types version 4.0.1
    CodeDisplayDefinition
    EffectEvidenceSynthesis 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.
    EnrollmentRequest EnrollmentRequest This resource provides the insurance enrollment details to the insurer regarding a specified coverage.
    EpisodeOfCare 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.
    Evidence 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.
    ExampleScenario ExampleScenario Example of workflow instance.
    FamilyMemberHistory FamilyMemberHistory Significant health conditions for a person related to the patient relevant in the context of care for the patient.
    Goal 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.
    Group 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.
    HealthcareService HealthcareService The details of a healthcare service available at a location.
    Immunization 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.
    ImmunizationRecommendation ImmunizationRecommendation A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
    List List A list is a curated collection of resources.
    Measure Measure The Measure resource provides the definition of a quality measure.
    Media Media A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
    MedicationAdministration 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.
    MedicationKnowledge MedicationKnowledge Information about a medication that is used to support knowledge.
    MedicationStatement 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 MedicinalProduct Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).
    MedicinalProductAuthorization MedicinalProductAuthorization The regulatory authorization of a medicinal product.
    MedicinalProductContraindication MedicinalProductContraindication The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.
    MedicinalProductIndication MedicinalProductIndication Indication for the Medicinal Product.
    MedicinalProductIngredient MedicinalProductIngredient An ingredient of a manufactured item or pharmaceutical product.
    MedicinalProductInteraction MedicinalProductInteraction The interactions of the medicinal product with other medicinal products, or other forms of interactions.
    MedicinalProductManufactured MedicinalProductManufactured The manufactured item as contained in the packaged medicinal product.
    MedicinalProductPackaged MedicinalProductPackaged A medicinal product in a container or package.
    MedicinalProductPharmaceutical MedicinalProductPharmaceutical A pharmaceutical product described in terms of its composition and dose form.
    MedicinalProductUndesirableEffect MedicinalProductUndesirableEffect Describe the undesirable effects of the medicinal product.
    MessageHeader 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.
    NamingSystem 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.
    Observation Observation Measurements and simple assertions made about a patient, device or other subject.
    OperationDefinition OperationDefinition A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
    Organization 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.
    RiskEvidenceSynthesis 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.
    SearchParameter SearchParameter A search parameter that defines a named search item that can be used to search/filter on a resource.
    Slot Slot A slot of time on a schedule that may be available for booking appointments.
    SpecimenDefinition SpecimenDefinition A kind of specimen with associated set of requirements.
    StructureMap StructureMap A Map of relationships between 2 structures that can be used to transform data.
    Substance Substance A homogeneous material with a definite composition.
    SubstanceNucleicAcid 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 SubstancePolymer Todo.
    SubstanceProtein 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 SubstanceReferenceInformation Todo.
    SubstanceSourceMaterial 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 SubstanceSpecification The detailed description of a substance, typically at a level beyond what is used for prescribing.
    SupplyRequest SupplyRequest A record of a request for a medication, substance or device used in the healthcare setting.
    TerminologyCapabilities TerminologyCapabilities A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
    TestScript TestScript A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.
    VerificationResult VerificationResult Describes validation requirements, source(s), status and dates for one or more elements.
    Account 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 ActivityDefinition This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
    AdverseEvent 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 AllergyIntolerance Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
    Appointment 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 AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
    AuditEvent 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 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 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 BiologicallyDerivedProduct A material substance originating from a biological entity intended to be transplanted or infused
    into another (possibly the same) biological entity.
    BodyStructure 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 Bundle A container for a collection of resources.
    CapabilityStatement 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 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 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 CatalogEntry Catalog entries are wrappers that contextualize items included in a catalog.
    ChargeItem 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 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 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 ClaimResponse This resource provides the adjudication details from the processing of a Claim resource.
    ClinicalImpression 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 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 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 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 CompartmentDefinition A compartment definition that defines how resources are accessed on a server.
    Composition 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 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 Condition A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
    Consent 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 Contract Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.
    Coverage Coverage Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
    CoverageEligibilityRequest 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 CoverageEligibilityResponse This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.
    DetectedIssue 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 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 DeviceDefinition The characteristics, operational status and capabilities of a medical-related component of a medical device.
    DeviceMetric DeviceMetric Describes a measurement, calculation or setting capability of a medical device.
    DeviceRequest 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 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 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 DocumentManifest A collection of documents compiled for a purpose together with metadata that applies to the collection.
    DocumentReference 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 DomainResource A resource that includes narrative, extensions, and contained resources.
    Encounter 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 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.
    EnrollmentResponse EnrollmentResponse This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.
    EventDefinition EventDefinition The EventDefinition resource provides a reusable description of when a particular event can occur.
    EvidenceVariable EvidenceVariable The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
    ExplanationOfBenefit 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.
    Flag Flag Prospective warnings of potential issues when providing care to the patient.
    GraphDefinition 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.
    GuidanceResponse 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.
    ImagingStudy 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.
    ImmunizationEvaluation ImmunizationEvaluation Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.
    ImplementationGuide 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 InsurancePlan Details of a Health Insurance product/plan provided by an organization.
    Invoice Invoice Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
    Library 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 Linkage Identifies two or more records (resource instances) that refer to the same real-world "occurrence".
    Location Location Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
    MeasureReport MeasureReport The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.
    Medication 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.
    MedicationDispense 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.
    MedicationRequest 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.
    MessageDefinition 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.
    MolecularSequence MolecularSequence Raw data describing a biological sequence.
    NutritionOrder NutritionOrder A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
    ObservationDefinition ObservationDefinition Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
    OperationOutcome OperationOutcome A collection of error, warning, or information messages that result from a system action.
    OrganizationAffiliation OrganizationAffiliation Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.
    Parameters Parameters This resource is a non-persisted resource used to pass information into and back from an [operation](https://hl7.org/fhir/operations.html). It has no other use, and there is no RESTful endpoint associated with it.
    Patient Patient Demographics and other administrative information about an individual or animal receiving care or other health-related services.
    PaymentNotice PaymentNotice This resource provides the status of the payment for goods and services rendered, and the request and response resource references.
    PaymentReconciliation PaymentReconciliation This resource provides the details including amount of a payment and allocates the payment items being paid.
    Person Person Demographics and administrative information about a person independent of a specific health-related context.
    PlanDefinition 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 Practitioner A person who is directly or indirectly involved in the provisioning of healthcare.
    PractitionerRole PractitionerRole A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
    Procedure 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 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 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 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 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 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 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 ResearchElementDefinition The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.
    ResearchStudy 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 ResearchSubject A physical entity which is the primary unit of operational and/or administrative interest in a study.
    Resource Resource This is the base resource type for everything.
    RiskAssessment RiskAssessment An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
    Schedule Schedule A container for slots of time that may be available for booking appointments.
    ServiceRequest ServiceRequest A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
    Specimen Specimen A sample to be used for analysis.
    StructureDefinition 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.
    Subscription 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.
    SupplyDelivery SupplyDelivery Record of delivery of what is supplied.
    Task Task A task to be performed.
    TestReport TestReport A summary of information based on the results of executing a TestScript.
    ValueSet 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](https://hl7.org/fhir/R4/CodeSystem.html) definitions and their use in [coded elements](https://hl7.org/fhir/terminologies.html).
    VisionPrescription VisionPrescription An authorization for the provision of glasses and/or contact lenses to a patient.

 

Expansion

This value set expansion contains 211 concepts.

CodeSystemDisplayDefinition
  Agehttp://hl7.org/fhir/data-typesAgeA duration of time during which an organism (or a process) has existed.
  Attachmenthttp://hl7.org/fhir/data-typesAttachmentFor referring to data content defined in other formats.
  CodeableConcepthttp://hl7.org/fhir/data-typesCodeableConceptA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
  ContactDetailhttp://hl7.org/fhir/data-typesContactDetailSpecifies contact information for a person or organization.
  Contributorhttp://hl7.org/fhir/data-typesContributorA contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
  DataRequirementhttp://hl7.org/fhir/data-typesDataRequirementDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
  Dosagehttp://hl7.org/fhir/data-typesDosageIndicates how the medication is/was taken or should be taken by the patient.
  Elementhttp://hl7.org/fhir/data-typesElementBase definition for all elements in a resource.
  Expressionhttp://hl7.org/fhir/data-typesExpressionA 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.
  HumanNamehttp://hl7.org/fhir/data-typesHumanNameA human's name with the ability to identify parts and usage.
  MarketingStatushttp://hl7.org/fhir/data-typesMarketingStatusThe 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.
  Moneyhttp://hl7.org/fhir/data-typesMoneyAn amount of economic utility in some recognized currency.
  Narrativehttp://hl7.org/fhir/data-typesNarrativeA human-readable summary of the resource conveying the essential clinical and business information for the resource.
  Periodhttp://hl7.org/fhir/data-typesPeriodA time period defined by a start and end date and optionally time.
  ProdCharacteristichttp://hl7.org/fhir/data-typesProdCharacteristicThe 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.
  Quantityhttp://hl7.org/fhir/data-typesQuantityA 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.
  Ratiohttp://hl7.org/fhir/data-typesRatioA relationship of two Quantity values - expressed as a numerator and a denominator.
  RelatedArtifacthttp://hl7.org/fhir/data-typesRelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.
  Signaturehttp://hl7.org/fhir/data-typesSignatureA 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.
  SubstanceAmounthttp://hl7.org/fhir/data-typesSubstanceAmountChemical 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.
  EffectEvidenceSynthesishttp://hl7.org/fhir/resource-typesEffectEvidenceSynthesis

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.

  EnrollmentRequesthttp://hl7.org/fhir/resource-typesEnrollmentRequest

This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

  EpisodeOfCarehttp://hl7.org/fhir/resource-typesEpisodeOfCare

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.

  Evidencehttp://hl7.org/fhir/resource-typesEvidence

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.

  ExampleScenariohttp://hl7.org/fhir/resource-typesExampleScenario

Example of workflow instance.

  FamilyMemberHistoryhttp://hl7.org/fhir/resource-typesFamilyMemberHistory

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

  Goalhttp://hl7.org/fhir/resource-typesGoal

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.

  Grouphttp://hl7.org/fhir/resource-typesGroup

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.

  HealthcareServicehttp://hl7.org/fhir/resource-typesHealthcareService

The details of a healthcare service available at a location.

  Immunizationhttp://hl7.org/fhir/resource-typesImmunization

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.

  ImmunizationRecommendationhttp://hl7.org/fhir/resource-typesImmunizationRecommendation

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

  Listhttp://hl7.org/fhir/resource-typesList

A list is a curated collection of resources.

  Measurehttp://hl7.org/fhir/resource-typesMeasure

The Measure resource provides the definition of a quality measure.

  Mediahttp://hl7.org/fhir/resource-typesMedia

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

  MedicationAdministrationhttp://hl7.org/fhir/resource-typesMedicationAdministration

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.

  MedicationKnowledgehttp://hl7.org/fhir/resource-typesMedicationKnowledge

Information about a medication that is used to support knowledge.

  MedicationStatementhttp://hl7.org/fhir/resource-typesMedicationStatement

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.

  MedicinalProducthttp://hl7.org/fhir/resource-typesMedicinalProduct

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

  MedicinalProductAuthorizationhttp://hl7.org/fhir/resource-typesMedicinalProductAuthorization

The regulatory authorization of a medicinal product.

  MedicinalProductContraindicationhttp://hl7.org/fhir/resource-typesMedicinalProductContraindication

The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.

  MedicinalProductIndicationhttp://hl7.org/fhir/resource-typesMedicinalProductIndication

Indication for the Medicinal Product.

  MedicinalProductIngredienthttp://hl7.org/fhir/resource-typesMedicinalProductIngredient

An ingredient of a manufactured item or pharmaceutical product.

  MedicinalProductInteractionhttp://hl7.org/fhir/resource-typesMedicinalProductInteraction

The interactions of the medicinal product with other medicinal products, or other forms of interactions.

  MedicinalProductManufacturedhttp://hl7.org/fhir/resource-typesMedicinalProductManufactured

The manufactured item as contained in the packaged medicinal product.

  MedicinalProductPackagedhttp://hl7.org/fhir/resource-typesMedicinalProductPackaged

A medicinal product in a container or package.

  MedicinalProductPharmaceuticalhttp://hl7.org/fhir/resource-typesMedicinalProductPharmaceutical

A pharmaceutical product described in terms of its composition and dose form.

  MedicinalProductUndesirableEffecthttp://hl7.org/fhir/resource-typesMedicinalProductUndesirableEffect

Describe the undesirable effects of the medicinal product.

  MessageHeaderhttp://hl7.org/fhir/resource-typesMessageHeader

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.

  NamingSystemhttp://hl7.org/fhir/resource-typesNamingSystem

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.

  Observationhttp://hl7.org/fhir/resource-typesObservation

Measurements and simple assertions made about a patient, device or other subject.

  OperationDefinitionhttp://hl7.org/fhir/resource-typesOperationDefinition

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

  Organizationhttp://hl7.org/fhir/resource-typesOrganization

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.

  RiskEvidenceSynthesishttp://hl7.org/fhir/resource-typesRiskEvidenceSynthesis

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.

  SearchParameterhttp://hl7.org/fhir/resource-typesSearchParameter

A search parameter that defines a named search item that can be used to search/filter on a resource.

  Slothttp://hl7.org/fhir/resource-typesSlot

A slot of time on a schedule that may be available for booking appointments.

  SpecimenDefinitionhttp://hl7.org/fhir/resource-typesSpecimenDefinition

A kind of specimen with associated set of requirements.

  StructureMaphttp://hl7.org/fhir/resource-typesStructureMap

A Map of relationships between 2 structures that can be used to transform data.

  Substancehttp://hl7.org/fhir/resource-typesSubstance

A homogeneous material with a definite composition.

  SubstanceNucleicAcidhttp://hl7.org/fhir/resource-typesSubstanceNucleicAcid

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.

  SubstancePolymerhttp://hl7.org/fhir/resource-typesSubstancePolymer

Todo.

  SubstanceProteinhttp://hl7.org/fhir/resource-typesSubstanceProtein

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.

  SubstanceReferenceInformationhttp://hl7.org/fhir/resource-typesSubstanceReferenceInformation

Todo.

  SubstanceSourceMaterialhttp://hl7.org/fhir/resource-typesSubstanceSourceMaterial

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.

  SubstanceSpecificationhttp://hl7.org/fhir/resource-typesSubstanceSpecification

The detailed description of a substance, typically at a level beyond what is used for prescribing.

  SupplyRequesthttp://hl7.org/fhir/resource-typesSupplyRequest

A record of a request for a medication, substance or device used in the healthcare setting.

  TerminologyCapabilitieshttp://hl7.org/fhir/resource-typesTerminologyCapabilities

A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

  TestScripthttp://hl7.org/fhir/resource-typesTestScript

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

  VerificationResulthttp://hl7.org/fhir/resource-typesVerificationResult

Describes validation requirements, source(s), status and dates for one or more elements.

  Addresshttp://hl7.org/fhir/data-typesAddressAn 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.
  Annotationhttp://hl7.org/fhir/data-typesAnnotationA text note which also contains information about who made the statement and when.
  BackboneElementhttp://hl7.org/fhir/data-typesBackboneElementBase definition for all elements that are defined inside a resource - but not those in a data type.
  Codinghttp://hl7.org/fhir/data-typesCodingA reference to a code defined by a terminology system.
  ContactPointhttp://hl7.org/fhir/data-typesContactPointDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
  Counthttp://hl7.org/fhir/data-typesCountA 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.
  Distancehttp://hl7.org/fhir/data-typesDistanceA length - a value with a unit that is a physical distance.
  Durationhttp://hl7.org/fhir/data-typesDurationA length of time.
  ElementDefinitionhttp://hl7.org/fhir/data-typesElementDefinitionCaptures constraints on each element within the resource, profile, or extension.
  Extensionhttp://hl7.org/fhir/data-typesExtensionOptional Extension Element - found in all resources.
  Identifierhttp://hl7.org/fhir/data-typesIdentifierAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
  Metahttp://hl7.org/fhir/data-typesMetaThe 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.
  MoneyQuantityhttp://hl7.org/fhir/data-typesMoneyQuantity
  ParameterDefinitionhttp://hl7.org/fhir/data-typesParameterDefinitionThe 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.
  Populationhttp://hl7.org/fhir/data-typesPopulationA populatioof people with some set of grouping criteria.
  ProductShelfLifehttp://hl7.org/fhir/data-typesProductShelfLifeThe shelf-life and storage information for a medicinal product item or container can be described using this class.
  Rangehttp://hl7.org/fhir/data-typesRangeA set of ordered Quantities defined by a low and high limit.
  Referencehttp://hl7.org/fhir/data-typesReferenceA reference from one resource to another.
  SampledDatahttp://hl7.org/fhir/data-typesSampledDataA series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
  SimpleQuantityhttp://hl7.org/fhir/data-typesSimpleQuantity
  Timinghttp://hl7.org/fhir/data-typesTimingSpecifies 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.
  TriggerDefinitionhttp://hl7.org/fhir/data-typesTriggerDefinitionA description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.
  UsageContexthttp://hl7.org/fhir/data-typesUsageContextSpecifies 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).
  base64Binaryhttp://hl7.org/fhir/data-typesbase64BinaryA stream of bytes
  booleanhttp://hl7.org/fhir/data-typesbooleanValue of "true" or "false"
  canonicalhttp://hl7.org/fhir/data-typescanonicalA URI that is a reference to a canonical URL on a FHIR resource
  codehttp://hl7.org/fhir/data-typescodeA 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
  datehttp://hl7.org/fhir/data-typesdateA 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.
  dateTimehttp://hl7.org/fhir/data-typesdateTimeA 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.
  decimalhttp://hl7.org/fhir/data-typesdecimalA rational number with implicit precision
  idhttp://hl7.org/fhir/data-typesidAny 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.
  instanthttp://hl7.org/fhir/data-typesinstantAn instant in time - known at least to the second
  integerhttp://hl7.org/fhir/data-typesintegerA whole number
  markdownhttp://hl7.org/fhir/data-typesmarkdownA string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
  oidhttp://hl7.org/fhir/data-typesoidAn OID represented as a URI
  positiveInthttp://hl7.org/fhir/data-typespositiveIntAn integer with a value that is positive (e.g. >0)
  stringhttp://hl7.org/fhir/data-typesstringA sequence of Unicode characters
  timehttp://hl7.org/fhir/data-typestimeA time during the day, with no date specified
  unsignedInthttp://hl7.org/fhir/data-typesunsignedIntAn integer with a value that is not negative (e.g. >= 0)
  urihttp://hl7.org/fhir/data-typesuriString of characters used to identify a name or a resource
  urlhttp://hl7.org/fhir/data-typesurlA URI that is a literal reference
  uuidhttp://hl7.org/fhir/data-typesuuidA UUID, represented as a URI
  xhtmlhttp://hl7.org/fhir/data-typesXHTMLXHTML format, as defined by W3C, but restricted usage (mainly, no active content)
  Accounthttp://hl7.org/fhir/resource-typesAccount

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.

  ActivityDefinitionhttp://hl7.org/fhir/resource-typesActivityDefinition

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

  AdverseEventhttp://hl7.org/fhir/resource-typesAdverseEvent

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.

  AllergyIntolerancehttp://hl7.org/fhir/resource-typesAllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

  Appointmenthttp://hl7.org/fhir/resource-typesAppointment

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).

  AppointmentResponsehttp://hl7.org/fhir/resource-typesAppointmentResponse

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

  AuditEventhttp://hl7.org/fhir/resource-typesAuditEvent

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.

  Basichttp://hl7.org/fhir/resource-typesBasic

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.

  Binaryhttp://hl7.org/fhir/resource-typesBinary

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.

  BiologicallyDerivedProducthttp://hl7.org/fhir/resource-typesBiologicallyDerivedProduct

A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.

  BodyStructurehttp://hl7.org/fhir/resource-typesBodyStructure

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.

  Bundlehttp://hl7.org/fhir/resource-typesBundle

A container for a collection of resources.

  CapabilityStatementhttp://hl7.org/fhir/resource-typesCapabilityStatement

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.

  CarePlanhttp://hl7.org/fhir/resource-typesCarePlan

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.

  CareTeamhttp://hl7.org/fhir/resource-typesCareTeam

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

  CatalogEntryhttp://hl7.org/fhir/resource-typesCatalogEntry

Catalog entries are wrappers that contextualize items included in a catalog.

  ChargeItemhttp://hl7.org/fhir/resource-typesChargeItem

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.

  ChargeItemDefinitionhttp://hl7.org/fhir/resource-typesChargeItemDefinition

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.

  Claimhttp://hl7.org/fhir/resource-typesClaim

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.

  ClaimResponsehttp://hl7.org/fhir/resource-typesClaimResponse

This resource provides the adjudication details from the processing of a Claim resource.

  ClinicalImpressionhttp://hl7.org/fhir/resource-typesClinicalImpression

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.

  CodeSystemhttp://hl7.org/fhir/resource-typesCodeSystem

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.

  Communicationhttp://hl7.org/fhir/resource-typesCommunication

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.

  CommunicationRequesthttp://hl7.org/fhir/resource-typesCommunicationRequest

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.

  CompartmentDefinitionhttp://hl7.org/fhir/resource-typesCompartmentDefinition

A compartment definition that defines how resources are accessed on a server.

  Compositionhttp://hl7.org/fhir/resource-typesComposition

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.).

  ConceptMaphttp://hl7.org/fhir/resource-typesConceptMap

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.

  Conditionhttp://hl7.org/fhir/resource-typesCondition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

  Consenthttp://hl7.org/fhir/resource-typesConsent

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.

  Contracthttp://hl7.org/fhir/resource-typesContract

Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

  Coveragehttp://hl7.org/fhir/resource-typesCoverage

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

  CoverageEligibilityRequesthttp://hl7.org/fhir/resource-typesCoverageEligibilityRequest

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.

  CoverageEligibilityResponsehttp://hl7.org/fhir/resource-typesCoverageEligibilityResponse

This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

  DetectedIssuehttp://hl7.org/fhir/resource-typesDetectedIssue

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.

  Devicehttp://hl7.org/fhir/resource-typesDevice

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.

  DeviceDefinitionhttp://hl7.org/fhir/resource-typesDeviceDefinition

The characteristics, operational status and capabilities of a medical-related component of a medical device.

  DeviceMetrichttp://hl7.org/fhir/resource-typesDeviceMetric

Describes a measurement, calculation or setting capability of a medical device.

  DeviceRequesthttp://hl7.org/fhir/resource-typesDeviceRequest

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.

  DeviceUseStatementhttp://hl7.org/fhir/resource-typesDeviceUseStatement

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.

  DiagnosticReporthttp://hl7.org/fhir/resource-typesDiagnosticReport

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.

  DocumentManifesthttp://hl7.org/fhir/resource-typesDocumentManifest

A collection of documents compiled for a purpose together with metadata that applies to the collection.

  DocumentReferencehttp://hl7.org/fhir/resource-typesDocumentReference

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.

  DomainResourcehttp://hl7.org/fhir/resource-typesDomainResource

A resource that includes narrative, extensions, and contained resources.

  Encounterhttp://hl7.org/fhir/resource-typesEncounter

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.

  Endpointhttp://hl7.org/fhir/resource-typesEndpoint

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.

  EnrollmentResponsehttp://hl7.org/fhir/resource-typesEnrollmentResponse

This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.

  EventDefinitionhttp://hl7.org/fhir/resource-typesEventDefinition

The EventDefinition resource provides a reusable description of when a particular event can occur.

  EvidenceVariablehttp://hl7.org/fhir/resource-typesEvidenceVariable

The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

  ExplanationOfBenefithttp://hl7.org/fhir/resource-typesExplanationOfBenefit

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.

  Flaghttp://hl7.org/fhir/resource-typesFlag

Prospective warnings of potential issues when providing care to the patient.

  GraphDefinitionhttp://hl7.org/fhir/resource-typesGraphDefinition

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.

  GuidanceResponsehttp://hl7.org/fhir/resource-typesGuidanceResponse

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.

  ImagingStudyhttp://hl7.org/fhir/resource-typesImagingStudy

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.

  ImmunizationEvaluationhttp://hl7.org/fhir/resource-typesImmunizationEvaluation

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

  ImplementationGuidehttp://hl7.org/fhir/resource-typesImplementationGuide

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.

  InsurancePlanhttp://hl7.org/fhir/resource-typesInsurancePlan

Details of a Health Insurance product/plan provided by an organization.

  Invoicehttp://hl7.org/fhir/resource-typesInvoice

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

  Libraryhttp://hl7.org/fhir/resource-typesLibrary

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.

  Linkagehttp://hl7.org/fhir/resource-typesLinkage

Identifies two or more records (resource instances) that refer to the same real-world "occurrence".

  Locationhttp://hl7.org/fhir/resource-typesLocation

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

  MeasureReporthttp://hl7.org/fhir/resource-typesMeasureReport

The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.

  Medicationhttp://hl7.org/fhir/resource-typesMedication

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.

  MedicationDispensehttp://hl7.org/fhir/resource-typesMedicationDispense

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.

  MedicationRequesthttp://hl7.org/fhir/resource-typesMedicationRequest

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.

  MessageDefinitionhttp://hl7.org/fhir/resource-typesMessageDefinition

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.

  MolecularSequencehttp://hl7.org/fhir/resource-typesMolecularSequence

Raw data describing a biological sequence.

  NutritionOrderhttp://hl7.org/fhir/resource-typesNutritionOrder

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

  ObservationDefinitionhttp://hl7.org/fhir/resource-typesObservationDefinition

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

  OperationOutcomehttp://hl7.org/fhir/resource-typesOperationOutcome

A collection of error, warning, or information messages that result from a system action.

  OrganizationAffiliationhttp://hl7.org/fhir/resource-typesOrganizationAffiliation

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

  Parametershttp://hl7.org/fhir/resource-typesParameters

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

  Patienthttp://hl7.org/fhir/resource-typesPatient

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

  PaymentNoticehttp://hl7.org/fhir/resource-typesPaymentNotice

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

  PaymentReconciliationhttp://hl7.org/fhir/resource-typesPaymentReconciliation

This resource provides the details including amount of a payment and allocates the payment items being paid.

  Personhttp://hl7.org/fhir/resource-typesPerson

Demographics and administrative information about a person independent of a specific health-related context.

  PlanDefinitionhttp://hl7.org/fhir/resource-typesPlanDefinition

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.

  Practitionerhttp://hl7.org/fhir/resource-typesPractitioner

A person who is directly or indirectly involved in the provisioning of healthcare.

  PractitionerRolehttp://hl7.org/fhir/resource-typesPractitionerRole

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

  Procedurehttp://hl7.org/fhir/resource-typesProcedure

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.

  Provenancehttp://hl7.org/fhir/resource-typesProvenance

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.

  Questionnairehttp://hl7.org/fhir/resource-typesQuestionnaire

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.

  QuestionnaireResponsehttp://hl7.org/fhir/resource-typesQuestionnaireResponse

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.

  RelatedPersonhttp://hl7.org/fhir/resource-typesRelatedPerson

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.

  RequestGrouphttp://hl7.org/fhir/resource-typesRequestGroup

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".

  ResearchDefinitionhttp://hl7.org/fhir/resource-typesResearchDefinition

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.

  ResearchElementDefinitionhttp://hl7.org/fhir/resource-typesResearchElementDefinition

The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

  ResearchStudyhttp://hl7.org/fhir/resource-typesResearchStudy

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.

  ResearchSubjecthttp://hl7.org/fhir/resource-typesResearchSubject

A physical entity which is the primary unit of operational and/or administrative interest in a study.

  Resourcehttp://hl7.org/fhir/resource-typesResource

This is the base resource type for everything.

  RiskAssessmenthttp://hl7.org/fhir/resource-typesRiskAssessment

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

  Schedulehttp://hl7.org/fhir/resource-typesSchedule

A container for slots of time that may be available for booking appointments.

  ServiceRequesthttp://hl7.org/fhir/resource-typesServiceRequest

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

  Specimenhttp://hl7.org/fhir/resource-typesSpecimen

A sample to be used for analysis.

  StructureDefinitionhttp://hl7.org/fhir/resource-typesStructureDefinition

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.

  Subscriptionhttp://hl7.org/fhir/resource-typesSubscription

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.

  SupplyDeliveryhttp://hl7.org/fhir/resource-typesSupplyDelivery

Record of delivery of what is supplied.

  Taskhttp://hl7.org/fhir/resource-typesTask

A task to be performed.

  TestReporthttp://hl7.org/fhir/resource-typesTestReport

A summary of information based on the results of executing a TestScript.

  ValueSethttp://hl7.org/fhir/resource-typesValueSet

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.

  VisionPrescriptionhttp://hl7.org/fhir/resource-typesVisionPrescription

An authorization for the provision of glasses and/or contact lenses to a patient.


Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
System The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance)
Display The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code