EHDS Logical Information Models
0.1.0 - ci-build
EHDS Logical Information Models
0.1.0 - ci-build
EHDS Logical Information Models, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.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/tree/main and changes regularly. See the Directory of published versions
| Draft as of 2025-07-25 |
Definitions for the EHDSImmunisation logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. EHDSImmunisation | |
| Definition | EHDS refined base model for Immunisation 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 | Common header for all patient-related data |
| Short | Common header for all patient-related data |
| Control | 1..1 |
| Type | Base |
| 4. EHDSImmunisation.header.subject | |
| Definition | Patient/subject information |
| Short | Subject |
| Control | 1..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
| 6. EHDSImmunisation.header.identifier | |
| Definition | Business identifier for the object |
| Short | Business identifier for the object |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 8. EHDSImmunisation.header.authorship | |
| Definition | Resource authoring details |
| Short | Authorship |
| Control | 1..* |
| Type | Base |
| 10. EHDSImmunisation.header.authorship.author[x] | |
| Definition | Author(s) by whom the resource was/were authored. Multiple authors could be provided. |
| Short | Author |
| Control | 1..1 |
| Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganisation, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 12. EHDSImmunisation.header.authorship.datetime | |
| Definition | Date and time of the issuing the document/resource by its author. |
| Short | Date and time of authoring/issuing |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. EHDSImmunisation.header.lastUpdate | |
| Definition | Date and time of the last update to the document/information |
| Short | Date and time of the last update to the resource |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. EHDSImmunisation.header.status | |
| Definition | Indicates the current status of the immunisation event (completed, not-done). |
| Short | Status of the resource |
| Control | 1..1 |
| Type | CodeableConcept |
| 18. EHDSImmunisation.header.statusReason[x] | |
| Definition | Reason for the current status of the resource. |
| Short | Reason for the current status of the resource. |
| Control | 0..1 |
| Type | Choice of: CodeableConcept, string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. EHDSImmunisation.header.language | |
| Definition | Language in which the resource is written. Language is expressed by the IETF language tag. |
| Short | Language |
| Control | 0..1 |
| Binding | BCP 47 |
| Type | CodeableConcept |
| 22. EHDSImmunisation.header.version | |
| Definition | Business version of the resource. |
| Short | Version |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. EHDSImmunisation.presentedForm | |
| Definition | A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document |
| Short | A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment |
| 26. EHDSImmunisation.diseaseOrAgentTargeted | |
| Definition | Disease or agent that the vaccination provides protection against. |
| Short | Disease or agent targeted |
| Control | 0..* |
| Binding | ICD-10, SNOMED CT |
| Type | CodeableConcept |
| 28. EHDSImmunisation.vaccine | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s). |
| Short | Type of vaccine |
| Control | 1..1 |
| Binding | SNOMED CT, ATC |
| Type | CodeableConcept |
| 30. EHDSImmunisation.administeredProduct | |
| Definition | Administered medicinal product |
| Short | Administered medicinal product |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
| 32. EHDSImmunisation.doseNumber | |
| Definition | Order in the vaccination course. |
| Short | Number in a series of vaccinations / doses |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. EHDSImmunisation.dateOfVaccination | |
| Definition | The date and time when the vaccination was administered |
| Short | Date of vaccination |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. EHDSImmunisation.administeringCentre | |
| Definition | Name/code of administering centre or a health authority responsible for the vaccination event |
| Short | Administering centre |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganisation |
| 38. EHDSImmunisation.vaccineAdministrator | |
| Definition | Health professional responsible for administering the vaccine or prophylaxis |
| Short | Administrator of vaccine |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| 40. EHDSImmunisation.nextVaccinationDate | |
| Definition | The date when the vaccination is planned to be given/repeated (e.g. next dose) |
| Short | Next vaccination date |
| Control | 0..1 |
| Type | date |
| 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 | EHDS refined base model for Immunisation |
| 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.status | |
| Definition | Indicates the current status of the immunisation event (completed, not-done). |
| 6. EHDSImmunisation.diseaseOrAgentTargeted | |
| Definition | Disease or agent that the vaccination provides protection against. |
| Short | Disease or agent targeted |
| Control | 0..* |
| Binding | ICD-10, SNOMED CT |
| Type | CodeableConcept |
| 8. EHDSImmunisation.vaccine | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s). |
| Short | Type of vaccine |
| Control | 1..1 |
| Binding | SNOMED CT, ATC |
| Type | CodeableConcept |
| 10. EHDSImmunisation.administeredProduct | |
| Definition | Administered medicinal product |
| Short | Administered medicinal product |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
| 12. EHDSImmunisation.doseNumber | |
| Definition | Order in the vaccination course. |
| Short | Number in a series of vaccinations / doses |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. EHDSImmunisation.dateOfVaccination | |
| Definition | The date and time when the vaccination was administered |
| Short | Date of vaccination |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. EHDSImmunisation.administeringCentre | |
| Definition | Name/code of administering centre or a health authority responsible for the vaccination event |
| Short | Administering centre |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganisation |
| 18. EHDSImmunisation.vaccineAdministrator | |
| Definition | Health professional responsible for administering the vaccine or prophylaxis |
| Short | Administrator of vaccine |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| 20. EHDSImmunisation.nextVaccinationDate | |
| Definition | The date when the vaccination is planned to be given/repeated (e.g. next dose) |
| Short | Next vaccination date |
| Control | 0..1 |
| Type | date |
| 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 | EHDS refined base model for Immunisation |
| 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 | Common header for all patient-related data |
| Short | Common header for all patient-related data |
| Control | 1..1 |
| Type | Base |
| 4. EHDSImmunisation.header.subject | |
| Definition | Patient/subject information |
| Short | Subject |
| Control | 1..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient |
| 6. EHDSImmunisation.header.identifier | |
| Definition | Business identifier for the object |
| Short | Business identifier for the object |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 8. EHDSImmunisation.header.authorship | |
| Definition | Resource authoring details |
| Short | Authorship |
| Control | 1..* |
| Type | Base |
| 10. EHDSImmunisation.header.authorship.author[x] | |
| Definition | Author(s) by whom the resource was/were authored. Multiple authors could be provided. |
| Short | Author |
| Control | 1..1 |
| Type | Choice of: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganisation, https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDevice |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 12. EHDSImmunisation.header.authorship.datetime | |
| Definition | Date and time of the issuing the document/resource by its author. |
| Short | Date and time of authoring/issuing |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. EHDSImmunisation.header.lastUpdate | |
| Definition | Date and time of the last update to the document/information |
| Short | Date and time of the last update to the resource |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. EHDSImmunisation.header.status | |
| Definition | Indicates the current status of the immunisation event (completed, not-done). |
| Short | Status of the resource |
| Control | 1..1 |
| Type | CodeableConcept |
| 18. EHDSImmunisation.header.statusReason[x] | |
| Definition | Reason for the current status of the resource. |
| Short | Reason for the current status of the resource. |
| Control | 0..1 |
| Type | Choice of: CodeableConcept, string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. EHDSImmunisation.header.language | |
| Definition | Language in which the resource is written. Language is expressed by the IETF language tag. |
| Short | Language |
| Control | 0..1 |
| Binding | BCP 47 |
| Type | CodeableConcept |
| 22. EHDSImmunisation.header.version | |
| Definition | Business version of the resource. |
| Short | Version |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. EHDSImmunisation.presentedForm | |
| Definition | A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document |
| Short | A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSAttachment |
| 26. EHDSImmunisation.diseaseOrAgentTargeted | |
| Definition | Disease or agent that the vaccination provides protection against. |
| Short | Disease or agent targeted |
| Control | 0..* |
| Binding | ICD-10, SNOMED CT |
| Type | CodeableConcept |
| 28. EHDSImmunisation.vaccine | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s). |
| Short | Type of vaccine |
| Control | 1..1 |
| Binding | SNOMED CT, ATC |
| Type | CodeableConcept |
| 30. EHDSImmunisation.administeredProduct | |
| Definition | Administered medicinal product |
| Short | Administered medicinal product |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
| 32. EHDSImmunisation.doseNumber | |
| Definition | Order in the vaccination course. |
| Short | Number in a series of vaccinations / doses |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 34. EHDSImmunisation.dateOfVaccination | |
| Definition | The date and time when the vaccination was administered |
| Short | Date of vaccination |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. EHDSImmunisation.administeringCentre | |
| Definition | Name/code of administering centre or a health authority responsible for the vaccination event |
| Short | Administering centre |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganisation |
| 38. EHDSImmunisation.vaccineAdministrator | |
| Definition | Health professional responsible for administering the vaccine or prophylaxis |
| Short | Administrator of vaccine |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| 40. EHDSImmunisation.nextVaccinationDate | |
| Definition | The date when the vaccination is planned to be given/repeated (e.g. next dose) |
| Short | Next vaccination date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2022+ Xt-EHR. Package eu.ehds.models#0.1.0 based on FHIR 5.0.0. Generated 2025-07-25
Links:
Table of Contents |
QA Report
The Xt-EHR action is co-funded by the European Union, EU4Health Program 2021-2027, under Grant Agreement Nr.ยบ 101128085.
