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

Draft as of 2026-02-23

Definitions for the EHDSImmunisation logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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.
Short | Immunisation modelBase for all types and resources
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. EHDSImmunisation.header
Definition | Basic metadata for this information
Short | Basic metadata for this information
Control | 1..1
Type | Base
4. EHDSImmunisation.header.subject
Definition | Patient/subject information
Short | Patient/subject information
Control | 1..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
6. EHDSImmunisation.header.identifier
Definition | Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
Short | Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
8. EHDSImmunisation.header.author[x]
Definition | The author of the immunisation statement.
Short | The author of the immunisation statement.
Control | 0..*
Type | Choice 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] Note | SeeChoice of Data Typesfor further information about how to use [x]
10. EHDSImmunisation.header.date
Definition | Date and optionally time of authoring/issuing
Short | Date and optionally time of authoring/issuing
Control | 0..1
Type | dateTime
Primitive Value | This 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).
Short | Status of the immunisation event (completed, not-done).
Control | 1..1
Type | CodeableConcept
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.
Short | 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.
Control | 0..1
Type | CodeableConcept
16. EHDSImmunisation.header.language
Definition | Language in which the resource is written. Language is expressed by the IETF language tag.
Short | Language in which the resource is written. Language is expressed by the IETF language tag.
Control | 0..1
Binding | BCP 47
Type | CodeableConcept
18. EHDSImmunisation.diseaseOrAgentTargeted
Definition | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
Short | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
Control | 0..*
Binding | ICD-10, SNOMED CT
Type | CodeableConcept
20. EHDSImmunisation.vaccine
Definition | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
Short | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
Control | 1..1
Binding | SNOMED CT, ATC
Type | CodeableConcept
22. EHDSImmunisation.administeredProduct
Definition | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
Short | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication
24. EHDSImmunisation.administrationTime
Definition | The date and optionally the exact time when the vaccination was administered.
Short | The date and optionally the exact time when the vaccination was administered.
Control | 1..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
26. EHDSImmunisation.administeringCentre
Definition | Administering centre or a health authority responsible for the vaccination event
Short | Administering centre or a health authority responsible for the vaccination event
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
28. EHDSImmunisation.administrator
Definition | Health professional responsible for administering the immunisation product.
Short | Health professional responsible for administering the immunisation product.
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
30. EHDSImmunisation.note
Definition | Any additional free-text information about the immunisation
Short | Any additional free-text information about the immunisation
Control | 0..1
Type | string
Primitive Value | This 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
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.
Short | Immunisation model
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. EHDSImmunisation.header
4. EHDSImmunisation.header.author[x]
Definition | The author of the immunisation statement.
Short | The author of the immunisation statement.
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
6. EHDSImmunisation.header.status
Definition | Status of the immunisation event (completed, not-done).
Short | Status of the immunisation event (completed, not-done).
8. EHDSImmunisation.diseaseOrAgentTargeted
Definition | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
Short | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
Control | 0..*
Binding | ICD-10, SNOMED CT
Type | CodeableConcept
10. EHDSImmunisation.vaccine
Definition | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
Short | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
Control | 1..1
Binding | SNOMED CT, ATC
Type | CodeableConcept
12. EHDSImmunisation.administeredProduct
Definition | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
Short | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication
14. EHDSImmunisation.administrationTime
Definition | The date and optionally the exact time when the vaccination was administered.
Short | The date and optionally the exact time when the vaccination was administered.
Control | 1..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
16. EHDSImmunisation.administeringCentre
Definition | Administering centre or a health authority responsible for the vaccination event
Short | Administering centre or a health authority responsible for the vaccination event
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
18. EHDSImmunisation.administrator
Definition | Health professional responsible for administering the immunisation product.
Short | Health professional responsible for administering the immunisation product.
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
20. EHDSImmunisation.note
Definition | Any additional free-text information about the immunisation
Short | Any additional free-text information about the immunisation
Control | 0..1
Type | string
Primitive Value | This 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
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.
Short | Immunisation model
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. EHDSImmunisation.header
Definition | Basic metadata for this information
Short | Basic metadata for this information
Control | 1..1
Type | Base
4. EHDSImmunisation.header.subject
Definition | Patient/subject information
Short | Patient/subject information
Control | 1..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
6. EHDSImmunisation.header.identifier
Definition | Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
Short | Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
8. EHDSImmunisation.header.author[x]
Definition | The author of the immunisation statement.
Short | The author of the immunisation statement.
Control | 0..*
Type | Choice 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] Note | SeeChoice of Data Typesfor further information about how to use [x]
10. EHDSImmunisation.header.date
Definition | Date and optionally time of authoring/issuing
Short | Date and optionally time of authoring/issuing
Control | 0..1
Type | dateTime
Primitive Value | This 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).
Short | Status of the immunisation event (completed, not-done).
Control | 1..1
Type | CodeableConcept
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.
Short | 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.
Control | 0..1
Type | CodeableConcept
16. EHDSImmunisation.header.language
Definition | Language in which the resource is written. Language is expressed by the IETF language tag.
Short | Language in which the resource is written. Language is expressed by the IETF language tag.
Control | 0..1
Binding | BCP 47
Type | CodeableConcept
18. EHDSImmunisation.diseaseOrAgentTargeted
Definition | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
Short | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
Control | 0..*
Binding | ICD-10, SNOMED CT
Type | CodeableConcept
20. EHDSImmunisation.vaccine
Definition | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
Short | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
Control | 1..1
Binding | SNOMED CT, ATC
Type | CodeableConcept
22. EHDSImmunisation.administeredProduct
Definition | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
Short | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication
24. EHDSImmunisation.administrationTime
Definition | The date and optionally the exact time when the vaccination was administered.
Short | The date and optionally the exact time when the vaccination was administered.
Control | 1..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
26. EHDSImmunisation.administeringCentre
Definition | Administering centre or a health authority responsible for the vaccination event
Short | Administering centre or a health authority responsible for the vaccination event
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
28. EHDSImmunisation.administrator
Definition | Health professional responsible for administering the immunisation product.
Short | Health professional responsible for administering the immunisation product.
Control | 0..1
Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
30. EHDSImmunisation.note
Definition | Any additional free-text information about the immunisation
Short | Any additional free-text information about the immunisation
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension