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: EHDSImmunisationLaboratoryObligations - Detailed Descriptions

Draft as of 2026-03-16

Definitions for the EHDSImmunisationLaboratoryObligations 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
    ObligationsActorDocumentation
    SHALL:able-to-populateProducer

    EHR systems SHALL provide information about the subject of care (patient).

    SHALL:displayConsumer

    EHR system SHALL render information about the subject of care in such a way that unambiguous assignment to the care subject is preserved.

    SHALL:processConsumer

    Information about the subject of care SHALL be processed by the EHR system in such a way that the identity of the subject of care cannot be confused.

    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
    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
      ObligationsActorDocumentation
      SHALL:able-to-populateProducer

      Immunization status (e.g., “completed", "not-done") SHALL be provided.

      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
        ObligationsActorDocumentation
        SHALL:able-to-populateProducer

        Type of immunisation SHELL be provided.

        SHALL:displayConsumer
        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
        24. 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
          ObligationsActorDocumentation
          SHALL:able-to-populateProducer

          Time of immunisation SHELL be provided.

          SHOULD:displayConsumer
          26. 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
          28. 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
          30. 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
            ObligationsActorDocumentation
            SHALL:able-to-populateProducer

            EHR systems SHALL provide information about the subject of care (patient).

            SHALL:displayConsumer

            EHR system SHALL render information about the subject of care in such a way that unambiguous assignment to the care subject is preserved.

            SHALL:processConsumer

            Information about the subject of care SHALL be processed by the EHR system in such a way that the identity of the subject of care cannot be confused.

            6. EHDSImmunisation.header.status
            Obligations
              ObligationsActorDocumentation
              SHALL:able-to-populateProducer

              Immunization status (e.g., “completed", "not-done") SHALL be provided.

              8. EHDSImmunisation.vaccine
              Obligations
                ObligationsActorDocumentation
                SHALL:able-to-populateProducer

                Type of immunisation SHELL be provided.

                SHALL:displayConsumer
                10. EHDSImmunisation.administrationTime
                Obligations
                  ObligationsActorDocumentation
                  SHALL:able-to-populateProducer

                  Time of immunisation SHELL be provided.

                  SHOULD:displayConsumer

                  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
                    ObligationsActorDocumentation
                    SHALL:able-to-populateProducer

                    EHR systems SHALL provide information about the subject of care (patient).

                    SHALL:displayConsumer

                    EHR system SHALL render information about the subject of care in such a way that unambiguous assignment to the care subject is preserved.

                    SHALL:processConsumer

                    Information about the subject of care SHALL be processed by the EHR system in such a way that the identity of the subject of care cannot be confused.

                    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
                    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
                      ObligationsActorDocumentation
                      SHALL:able-to-populateProducer

                      Immunization status (e.g., “completed", "not-done") SHALL be provided.

                      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
                        ObligationsActorDocumentation
                        SHALL:able-to-populateProducer

                        Type of immunisation SHELL be provided.

                        SHALL:displayConsumer
                        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
                        24. 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
                          ObligationsActorDocumentation
                          SHALL:able-to-populateProducer

                          Time of immunisation SHELL be provided.

                          SHOULD:displayConsumer
                          26. 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
                          28. 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
                          30. 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