EHDS Logical Information Models
0.4.0 - draft

EHDS Logical Information Models, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/ and changes regularly. See the Directory of published versions

Logical Model: EHDSImmunisationObligations - Detailed Descriptions

Draft as of 2026-02-22

Definitions for the EHDSImmunisationObligations logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. EHDSImmunisation
Definition

Model describes the administration of immunisation products, including vaccines and immunoglobulins, covering active and passive immunisations. It focuses on immunisation as a clinical procedure rather than the resulting immunity. The model supports routine immunisations at standard doses and may overlap with medication summaries or prescription lists. Natural immunity, immunisation outcomes, refusals, and administration or planning details are out of scope.


Base definition for all types defined in FHIR type system.

ShortImmunisation modelBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSImmunisation.header
Definition

Basic metadata for this information

ShortBasic metadata for this information
Control1..1
TypeBase
4. EHDSImmunisation.header.subject
Definition

Patient/subject information

ShortPatient/subject information
Control1..1
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
Obligations
    ObligationsActor
    SHALL:able-to-populateProducer
    6. EHDSImmunisation.header.identifier
    Definition

    Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).

    ShortBusiness identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Obligations
      ObligationsActor
      SHOULD:able-to-populateProducer
      8. EHDSImmunisation.header.author[x]
      Definition

      The author of the immunisation statement.

      ShortThe author of the immunisation statement.
      Control0..*
      TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. EHDSImmunisation.header.date
      Definition

      Date and optionally time of authoring/issuing

      ShortDate and optionally time of authoring/issuing
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      12. EHDSImmunisation.header.status
      Definition

      Status of the immunisation event (completed, not-done).

      ShortStatus of the immunisation event (completed, not-done).
      Control1..1
      TypeCodeableConcept
      Obligations
        ObligationsActor
        SHALL:able-to-populateProducer
        14. EHDSImmunisation.header.source
        Definition

        Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.

        ShortSource of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.
        Control0..1
        TypeCodeableConcept
        16. EHDSImmunisation.header.language
        Definition

        Language in which the resource is written. Language is expressed by the IETF language tag.

        ShortLanguage in which the resource is written. Language is expressed by the IETF language tag.
        Control0..1
        Binding

        BCP 47

        TypeCodeableConcept
        18. EHDSImmunisation.diseaseOrAgentTargeted
        Definition

        Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).

        ShortDisease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
        Control0..*
        Binding

        ICD-10, SNOMED CT

        TypeCodeableConcept
        20. EHDSImmunisation.vaccine
        Definition

        Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.

        ShortType of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
        Control1..1
        Binding

        SNOMED CT, ATC

        TypeCodeableConcept
        Obligations
          ObligationsActor
          SHALL:able-to-populateProducer
          22. EHDSImmunisation.administeredProduct
          Definition

          Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.

          ShortAdministered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
          Control0..1
          Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication
          Obligations
            ObligationsActor
            SHOULD:able-to-populateProducer
            24. EHDSImmunisation.administeredProduct.identifyingCode[x]
            Definition

            An identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.

            ShortAn identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.
            Control0..*
            TypeChoice of: CodeableConcept, Identifier
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Obligations
              ObligationsActor
              SHOULD:able-to-populateProducer
              26. EHDSImmunisation.administeredProduct.classification
              Definition

              Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.)

              ShortClassification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.)
              Control0..*
              Binding

              WHO ATC

              TypeCodeableConcept
              28. EHDSImmunisation.administeredProduct.productName
              Definition

              Current trade name (authorised name) of the product. When medication is specified by a CodeableConcept, the name may be omitted when available as the display name of the concept.

              ShortCurrent trade name (authorised name) of the product. When medication is specified by a CodeableConcept, the name may be omitted when available as the display name of the concept.
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Obligations
                ObligationsActor
                SHOULD:able-to-populateProducer
                30. EHDSImmunisation.administeredProduct.marketingAuthorisationHolder
                Definition

                Marketing authorisation holder of the medicinal product. Relevant for identifying the exact product. If the product does not have a marketing authorisation, the manufacturer information may be used.

                ShortMarketing authorisation holder of the medicinal product. Relevant for identifying the exact product. If the product does not have a marketing authorisation, the manufacturer information may be used.
                Control0..1
                TypeBase
                32. EHDSImmunisation.administeredProduct.marketingAuthorisationHolder.organisationName
                Definition

                Name of the organisation holding the authorisation for marketing/manufacturing

                ShortName of the organisation holding the authorisation for marketing/manufacturing
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                34. EHDSImmunisation.administeredProduct.marketingAuthorisationHolder.organisationIdentifier
                Definition

                Identifier of the organisation and/or its physical location

                ShortIdentifier of the organisation and/or its physical location
                Control0..*
                TypeIdentifier
                36. EHDSImmunisation.administeredProduct.doseForm
                Definition

                Dose form at the package level (e.g. authorised dose form), corresponding to IDMP Combined Pharmaceutical Dose Form (this includes terms from EDQM Combination Pack or Combined Dose Form lists). Dose form for a single package item is defined in item.doseForm.

                ShortDose form at the package level (e.g. authorised dose form), corresponding to IDMP Combined Pharmaceutical Dose Form (this includes terms from EDQM Combination Pack or Combined Dose Form lists). Dose form for a single package item is defined in item.doseForm.
                Control0..1
                Binding

                EDQM Standard Terms

                TypeCodeableConcept
                38. EHDSImmunisation.administeredProduct.description
                Definition

                Textual description of the product, e.g. including package description.

                ShortTextual description of the product, e.g. including package description.
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                40. EHDSImmunisation.administeredProduct.item
                Definition

                A medication item. For combination packs, this can be multiple manufactured items with each item having its own dose form and ingredients+strengths defined

                ShortA medication item. For combination packs, this can be multiple manufactured items with each item having its own dose form and ingredients+strengths defined
                Control0..*
                TypeBase
                42. EHDSImmunisation.administeredProduct.item.doseForm
                Definition

                Administrable or manufactured item dose form, depending on the type of medication definition. This should not include combined dose forms.

                ShortAdministrable or manufactured item dose form, depending on the type of medication definition. This should not include combined dose forms.
                Control0..1
                Binding

                EDQM Standard Terms

                TypeCodeableConcept
                44. EHDSImmunisation.administeredProduct.item.ingredient
                Definition

                Ingredients

                ShortIngredients
                Control1..*
                TypeBase
                46. EHDSImmunisation.administeredProduct.item.ingredient.isActive
                Definition

                Marks whether the ingredient is considered an active ingredient. Excipients are typically not needed, and by default only active ingredients are expected.

                ShortMarks whether the ingredient is considered an active ingredient. Excipients are typically not needed, and by default only active ingredients are expected.
                Control0..1
                Typeboolean
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                48. EHDSImmunisation.administeredProduct.item.ingredient.substance
                Definition

                Substance

                ShortSubstance
                Control1..1
                Binding

                EMA SPOR SMS

                TypeCodeableConcept
                50. EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo
                Definition

                Strength of the product - amount of substance per unit

                ShortStrength of the product - amount of substance per unit
                Control0..1
                TypeBase
                52. EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo.strength
                Definition

                Concentration or presentation strength, e.g '100 mg/1 ml' or '500 mg per 1 tablet'

                ShortConcentration or presentation strength, e.g '100 mg/1 ml' or '500 mg per 1 tablet'
                Control1..1
                TypeRatio
                54. EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo.basisOfStrengthSubstance
                Definition

                Substance that the strength refers to, especially when different from .item.strength.substance

                ShortSubstance that the strength refers to, especially when different from .item.strength.substance
                Control0..1
                Binding

                EMA SPOR SMS

                TypeCodeableConcept
                56. EHDSImmunisation.administeredProduct.item.unitOfPresentation
                Definition

                Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package.

                ShortUnit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package.
                Control0..1
                Binding

                EDQM Standard Terms

                TypeCodeableConcept
                58. EHDSImmunisation.administeredProduct.item.containedQuantity
                Definition

                Manufactured item quantity per one item (3 ml / 1 vial)

                ShortManufactured item quantity per one item (3 ml / 1 vial)
                Control0..1
                TypeRatio
                60. EHDSImmunisation.administeredProduct.item.amount
                Definition

                Number of such items in this product (5 vials). The combined amount of all items will be considered to be the total package size.

                ShortNumber of such items in this product (5 vials). The combined amount of all items will be considered to be the total package size.
                Control0..1
                Binding

                UCUM for units of measure. EDQM Standard Terms for units of presentation.

                TypeQuantity
                62. EHDSImmunisation.administeredProduct.item.packageType
                Definition

                Type of package of the medication item

                ShortType of package of the medication item
                Control0..1
                Binding

                EDQM Standard Terms for packaging.

                TypeCodeableConcept
                64. EHDSImmunisation.administeredProduct.device
                Definition

                Administration device included in the product. Devices that are not inside the medication package are excluded.

                ShortAdministration device included in the product. Devices that are not inside the medication package are excluded.
                Control0..*
                TypeBase
                66. EHDSImmunisation.administeredProduct.device.deviceQuantity
                Definition

                Number of such devices

                ShortNumber of such devices
                Control1..1
                TypeQuantity
                68. EHDSImmunisation.administeredProduct.device.device[x]
                Definition

                Device coded

                ShortDevice coded
                Control1..1
                TypeChoice of: CodeableConcept, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                70. EHDSImmunisation.administeredProduct.characteristic
                Definition

                Additional features of the product (e.g. reimbursable, sugar-free, easy-open cap, score-lined). It is expected that implementers will define a valueset supporting their use cases.

                ShortAdditional features of the product (e.g. reimbursable, sugar-free, easy-open cap, score-lined). It is expected that implementers will define a valueset supporting their use cases.
                Control0..*
                TypeBase
                72. EHDSImmunisation.administeredProduct.characteristic.type
                Definition

                A code expressing the type of characteristic.

                ShortA code expressing the type of characteristic.
                Control1..1
                TypeCodeableConcept
                74. EHDSImmunisation.administeredProduct.characteristic.value[x]
                Definition

                Description of the characteristic value.

                ShortDescription of the characteristic value.
                Control0..1
                TypeChoice of: boolean, CodeableConcept, string, Quantity, dateTime, integer, decimal, Ratio
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                76. EHDSImmunisation.administeredProduct.batch
                Definition

                Batch information of a medicinal product. Typically recorded during dispense or administration, rarely known or relevant for a prescription/request.

                ShortBatch information of a medicinal product. Typically recorded during dispense or administration, rarely known or relevant for a prescription/request.
                Control0..1
                TypeBase
                Obligations
                  ObligationsActor
                  SHOULD:able-to-populateProducer
                  78. EHDSImmunisation.administeredProduct.batch.lotNumber
                  Definition

                  Batch identifier of the medicinal product.

                  ShortBatch identifier of the medicinal product.
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Obligations
                    ObligationsActor
                    SHOULD:able-to-populateProducer
                    80. EHDSImmunisation.administeredProduct.batch.expirationDate
                    Definition

                    Batch expiration date of the medicinal product.

                    ShortBatch expiration date of the medicinal product.
                    Control0..1
                    TypedateTime
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    82. EHDSImmunisation.administrationTime
                    Definition

                    The date and optionally the exact time when the vaccination was administered.

                    ShortThe date and optionally the exact time when the vaccination was administered.
                    Control1..1
                    TypedateTime
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Obligations
                      ObligationsActor
                      SHALL:able-to-populateProducer
                      84. EHDSImmunisation.administeringCentre
                      Definition

                      Administering centre or a health authority responsible for the vaccination event

                      ShortAdministering centre or a health authority responsible for the vaccination event
                      Control0..1
                      Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
                      86. EHDSImmunisation.administrator
                      Definition

                      Health professional responsible for administering the immunisation product.

                      ShortHealth professional responsible for administering the immunisation product.
                      Control0..1
                      Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
                      88. EHDSImmunisation.note
                      Definition

                      Any additional free-text information about the immunisation

                      ShortAny additional free-text information about the immunisation
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

                      Guidance on how to interpret the contents of this table can be foundhere

                      0. EHDSImmunisation
                      Logical ModelInstances of this logical model are not marked to be the target of a Reference
                      2. EHDSImmunisation.header
                      4. EHDSImmunisation.header.subject
                      Obligations
                        ObligationsActor
                        SHALL:able-to-populateProducer
                        6. EHDSImmunisation.header.identifier
                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Obligations
                          ObligationsActor
                          SHOULD:able-to-populateProducer
                          8. EHDSImmunisation.header.status
                          Obligations
                            ObligationsActor
                            SHALL:able-to-populateProducer
                            10. EHDSImmunisation.vaccine
                            Obligations
                              ObligationsActor
                              SHALL:able-to-populateProducer
                              12. EHDSImmunisation.administeredProduct
                              Obligations
                                ObligationsActor
                                SHOULD:able-to-populateProducer
                                14. EHDSImmunisation.administeredProduct.identifyingCode[x]
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Obligations
                                  ObligationsActor
                                  SHOULD:able-to-populateProducer
                                  16. EHDSImmunisation.administeredProduct.productName
                                  Obligations
                                    ObligationsActor
                                    SHOULD:able-to-populateProducer
                                    18. EHDSImmunisation.administeredProduct.batch
                                    Obligations
                                      ObligationsActor
                                      SHOULD:able-to-populateProducer
                                      20. EHDSImmunisation.administeredProduct.batch.lotNumber
                                      Obligations
                                        ObligationsActor
                                        SHOULD:able-to-populateProducer
                                        22. EHDSImmunisation.administrationTime
                                        Obligations
                                          ObligationsActor
                                          SHALL:able-to-populateProducer

                                          Guidance on how to interpret the contents of this table can be foundhere

                                          0. EHDSImmunisation
                                          Definition

                                          Model describes the administration of immunisation products, including vaccines and immunoglobulins, covering active and passive immunisations. It focuses on immunisation as a clinical procedure rather than the resulting immunity. The model supports routine immunisations at standard doses and may overlap with medication summaries or prescription lists. Natural immunity, immunisation outcomes, refusals, and administration or planning details are out of scope.

                                          ShortImmunisation model
                                          Control0..*
                                          Is Modifierfalse
                                          Logical ModelInstances of this logical model are not marked to be the target of a Reference
                                          2. EHDSImmunisation.header
                                          Definition

                                          Basic metadata for this information

                                          ShortBasic metadata for this information
                                          Control1..1
                                          TypeBase
                                          4. EHDSImmunisation.header.subject
                                          Definition

                                          Patient/subject information

                                          ShortPatient/subject information
                                          Control1..1
                                          Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
                                          Obligations
                                            ObligationsActor
                                            SHALL:able-to-populateProducer
                                            6. EHDSImmunisation.header.identifier
                                            Definition

                                            Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).

                                            ShortBusiness identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                            Control0..*
                                            TypeIdentifier
                                            Obligations
                                              ObligationsActor
                                              SHOULD:able-to-populateProducer
                                              8. EHDSImmunisation.header.author[x]
                                              Definition

                                              The author of the immunisation statement.

                                              ShortThe author of the immunisation statement.
                                              Control0..*
                                              TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                              10. EHDSImmunisation.header.date
                                              Definition

                                              Date and optionally time of authoring/issuing

                                              ShortDate and optionally time of authoring/issuing
                                              Control0..1
                                              TypedateTime
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              12. EHDSImmunisation.header.status
                                              Definition

                                              Status of the immunisation event (completed, not-done).

                                              ShortStatus of the immunisation event (completed, not-done).
                                              Control1..1
                                              TypeCodeableConcept
                                              Obligations
                                                ObligationsActor
                                                SHALL:able-to-populateProducer
                                                14. EHDSImmunisation.header.source
                                                Definition

                                                Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.

                                                ShortSource of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.
                                                Control0..1
                                                TypeCodeableConcept
                                                16. EHDSImmunisation.header.language
                                                Definition

                                                Language in which the resource is written. Language is expressed by the IETF language tag.

                                                ShortLanguage in which the resource is written. Language is expressed by the IETF language tag.
                                                Control0..1
                                                Binding

                                                BCP 47

                                                TypeCodeableConcept
                                                18. EHDSImmunisation.diseaseOrAgentTargeted
                                                Definition

                                                Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).

                                                ShortDisease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
                                                Control0..*
                                                Binding

                                                ICD-10, SNOMED CT

                                                TypeCodeableConcept
                                                20. EHDSImmunisation.vaccine
                                                Definition

                                                Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.

                                                ShortType of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
                                                Control1..1
                                                Binding

                                                SNOMED CT, ATC

                                                TypeCodeableConcept
                                                Obligations
                                                  ObligationsActor
                                                  SHALL:able-to-populateProducer
                                                  22. EHDSImmunisation.administeredProduct
                                                  Definition

                                                  Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.

                                                  ShortAdministered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
                                                  Control0..1
                                                  Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication
                                                  Obligations
                                                    ObligationsActor
                                                    SHOULD:able-to-populateProducer
                                                    24. EHDSImmunisation.administeredProduct.identifyingCode[x]
                                                    Definition

                                                    An identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.

                                                    ShortAn identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.
                                                    Control0..*
                                                    TypeChoice of: CodeableConcept, Identifier
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    Obligations
                                                      ObligationsActor
                                                      SHOULD:able-to-populateProducer
                                                      26. EHDSImmunisation.administeredProduct.classification
                                                      Definition

                                                      Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.)

                                                      ShortClassification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.)
                                                      Control0..*
                                                      Binding

                                                      WHO ATC

                                                      TypeCodeableConcept
                                                      28. EHDSImmunisation.administeredProduct.productName
                                                      Definition

                                                      Current trade name (authorised name) of the product. When medication is specified by a CodeableConcept, the name may be omitted when available as the display name of the concept.

                                                      ShortCurrent trade name (authorised name) of the product. When medication is specified by a CodeableConcept, the name may be omitted when available as the display name of the concept.
                                                      Control0..1
                                                      Typestring
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Obligations
                                                        ObligationsActor
                                                        SHOULD:able-to-populateProducer
                                                        30. EHDSImmunisation.administeredProduct.marketingAuthorisationHolder
                                                        Definition

                                                        Marketing authorisation holder of the medicinal product. Relevant for identifying the exact product. If the product does not have a marketing authorisation, the manufacturer information may be used.

                                                        ShortMarketing authorisation holder of the medicinal product. Relevant for identifying the exact product. If the product does not have a marketing authorisation, the manufacturer information may be used.
                                                        Control0..1
                                                        TypeBase
                                                        32. EHDSImmunisation.administeredProduct.marketingAuthorisationHolder.organisationName
                                                        Definition

                                                        Name of the organisation holding the authorisation for marketing/manufacturing

                                                        ShortName of the organisation holding the authorisation for marketing/manufacturing
                                                        Control0..1
                                                        Typestring
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        34. EHDSImmunisation.administeredProduct.marketingAuthorisationHolder.organisationIdentifier
                                                        Definition

                                                        Identifier of the organisation and/or its physical location

                                                        ShortIdentifier of the organisation and/or its physical location
                                                        Control0..*
                                                        TypeIdentifier
                                                        36. EHDSImmunisation.administeredProduct.doseForm
                                                        Definition

                                                        Dose form at the package level (e.g. authorised dose form), corresponding to IDMP Combined Pharmaceutical Dose Form (this includes terms from EDQM Combination Pack or Combined Dose Form lists). Dose form for a single package item is defined in item.doseForm.

                                                        ShortDose form at the package level (e.g. authorised dose form), corresponding to IDMP Combined Pharmaceutical Dose Form (this includes terms from EDQM Combination Pack or Combined Dose Form lists). Dose form for a single package item is defined in item.doseForm.
                                                        Control0..1
                                                        Binding

                                                        EDQM Standard Terms

                                                        TypeCodeableConcept
                                                        38. EHDSImmunisation.administeredProduct.description
                                                        Definition

                                                        Textual description of the product, e.g. including package description.

                                                        ShortTextual description of the product, e.g. including package description.
                                                        Control0..1
                                                        Typestring
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        40. EHDSImmunisation.administeredProduct.item
                                                        Definition

                                                        A medication item. For combination packs, this can be multiple manufactured items with each item having its own dose form and ingredients+strengths defined

                                                        ShortA medication item. For combination packs, this can be multiple manufactured items with each item having its own dose form and ingredients+strengths defined
                                                        Control0..*
                                                        TypeBase
                                                        42. EHDSImmunisation.administeredProduct.item.doseForm
                                                        Definition

                                                        Administrable or manufactured item dose form, depending on the type of medication definition. This should not include combined dose forms.

                                                        ShortAdministrable or manufactured item dose form, depending on the type of medication definition. This should not include combined dose forms.
                                                        Control0..1
                                                        Binding

                                                        EDQM Standard Terms

                                                        TypeCodeableConcept
                                                        44. EHDSImmunisation.administeredProduct.item.ingredient
                                                        Definition

                                                        Ingredients

                                                        ShortIngredients
                                                        Control1..*
                                                        TypeBase
                                                        46. EHDSImmunisation.administeredProduct.item.ingredient.isActive
                                                        Definition

                                                        Marks whether the ingredient is considered an active ingredient. Excipients are typically not needed, and by default only active ingredients are expected.

                                                        ShortMarks whether the ingredient is considered an active ingredient. Excipients are typically not needed, and by default only active ingredients are expected.
                                                        Control0..1
                                                        Typeboolean
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        48. EHDSImmunisation.administeredProduct.item.ingredient.substance
                                                        Definition

                                                        Substance

                                                        ShortSubstance
                                                        Control1..1
                                                        Binding

                                                        EMA SPOR SMS

                                                        TypeCodeableConcept
                                                        50. EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo
                                                        Definition

                                                        Strength of the product - amount of substance per unit

                                                        ShortStrength of the product - amount of substance per unit
                                                        Control0..1
                                                        TypeBase
                                                        52. EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo.strength
                                                        Definition

                                                        Concentration or presentation strength, e.g '100 mg/1 ml' or '500 mg per 1 tablet'

                                                        ShortConcentration or presentation strength, e.g '100 mg/1 ml' or '500 mg per 1 tablet'
                                                        Control1..1
                                                        TypeRatio
                                                        54. EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo.basisOfStrengthSubstance
                                                        Definition

                                                        Substance that the strength refers to, especially when different from .item.strength.substance

                                                        ShortSubstance that the strength refers to, especially when different from .item.strength.substance
                                                        Control0..1
                                                        Binding

                                                        EMA SPOR SMS

                                                        TypeCodeableConcept
                                                        56. EHDSImmunisation.administeredProduct.item.unitOfPresentation
                                                        Definition

                                                        Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package.

                                                        ShortUnit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package.
                                                        Control0..1
                                                        Binding

                                                        EDQM Standard Terms

                                                        TypeCodeableConcept
                                                        58. EHDSImmunisation.administeredProduct.item.containedQuantity
                                                        Definition

                                                        Manufactured item quantity per one item (3 ml / 1 vial)

                                                        ShortManufactured item quantity per one item (3 ml / 1 vial)
                                                        Control0..1
                                                        TypeRatio
                                                        60. EHDSImmunisation.administeredProduct.item.amount
                                                        Definition

                                                        Number of such items in this product (5 vials). The combined amount of all items will be considered to be the total package size.

                                                        ShortNumber of such items in this product (5 vials). The combined amount of all items will be considered to be the total package size.
                                                        Control0..1
                                                        Binding

                                                        UCUM for units of measure. EDQM Standard Terms for units of presentation.

                                                        TypeQuantity
                                                        62. EHDSImmunisation.administeredProduct.item.packageType
                                                        Definition

                                                        Type of package of the medication item

                                                        ShortType of package of the medication item
                                                        Control0..1
                                                        Binding

                                                        EDQM Standard Terms for packaging.

                                                        TypeCodeableConcept
                                                        64. EHDSImmunisation.administeredProduct.device
                                                        Definition

                                                        Administration device included in the product. Devices that are not inside the medication package are excluded.

                                                        ShortAdministration device included in the product. Devices that are not inside the medication package are excluded.
                                                        Control0..*
                                                        TypeBase
                                                        66. EHDSImmunisation.administeredProduct.device.deviceQuantity
                                                        Definition

                                                        Number of such devices

                                                        ShortNumber of such devices
                                                        Control1..1
                                                        TypeQuantity
                                                        68. EHDSImmunisation.administeredProduct.device.device[x]
                                                        Definition

                                                        Device coded

                                                        ShortDevice coded
                                                        Control1..1
                                                        TypeChoice of: CodeableConcept, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        70. EHDSImmunisation.administeredProduct.characteristic
                                                        Definition

                                                        Additional features of the product (e.g. reimbursable, sugar-free, easy-open cap, score-lined). It is expected that implementers will define a valueset supporting their use cases.

                                                        ShortAdditional features of the product (e.g. reimbursable, sugar-free, easy-open cap, score-lined). It is expected that implementers will define a valueset supporting their use cases.
                                                        Control0..*
                                                        TypeBase
                                                        72. EHDSImmunisation.administeredProduct.characteristic.type
                                                        Definition

                                                        A code expressing the type of characteristic.

                                                        ShortA code expressing the type of characteristic.
                                                        Control1..1
                                                        TypeCodeableConcept
                                                        74. EHDSImmunisation.administeredProduct.characteristic.value[x]
                                                        Definition

                                                        Description of the characteristic value.

                                                        ShortDescription of the characteristic value.
                                                        Control0..1
                                                        TypeChoice of: boolean, CodeableConcept, string, Quantity, dateTime, integer, decimal, Ratio
                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        76. EHDSImmunisation.administeredProduct.batch
                                                        Definition

                                                        Batch information of a medicinal product. Typically recorded during dispense or administration, rarely known or relevant for a prescription/request.

                                                        ShortBatch information of a medicinal product. Typically recorded during dispense or administration, rarely known or relevant for a prescription/request.
                                                        Control0..1
                                                        TypeBase
                                                        Obligations
                                                          ObligationsActor
                                                          SHOULD:able-to-populateProducer
                                                          78. EHDSImmunisation.administeredProduct.batch.lotNumber
                                                          Definition

                                                          Batch identifier of the medicinal product.

                                                          ShortBatch identifier of the medicinal product.
                                                          Control0..1
                                                          Typestring
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Obligations
                                                            ObligationsActor
                                                            SHOULD:able-to-populateProducer
                                                            80. EHDSImmunisation.administeredProduct.batch.expirationDate
                                                            Definition

                                                            Batch expiration date of the medicinal product.

                                                            ShortBatch expiration date of the medicinal product.
                                                            Control0..1
                                                            TypedateTime
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            82. EHDSImmunisation.administrationTime
                                                            Definition

                                                            The date and optionally the exact time when the vaccination was administered.

                                                            ShortThe date and optionally the exact time when the vaccination was administered.
                                                            Control1..1
                                                            TypedateTime
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Obligations
                                                              ObligationsActor
                                                              SHALL:able-to-populateProducer
                                                              84. EHDSImmunisation.administeringCentre
                                                              Definition

                                                              Administering centre or a health authority responsible for the vaccination event

                                                              ShortAdministering centre or a health authority responsible for the vaccination event
                                                              Control0..1
                                                              Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
                                                              86. EHDSImmunisation.administrator
                                                              Definition

                                                              Health professional responsible for administering the immunisation product.

                                                              ShortHealth professional responsible for administering the immunisation product.
                                                              Control0..1
                                                              Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
                                                              88. EHDSImmunisation.note
                                                              Definition

                                                              Any additional free-text information about the immunisation

                                                              ShortAny additional free-text information about the immunisation
                                                              Control0..1
                                                              Typestring
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension