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

Logical Model: Immunisation model

Official URL: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSImmunisation Version: 0.1.0
Draft as of 2025-07-25 Computable Name: EHDSImmunisation

EHDS refined base model for Immunisation

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSImmunisation 0..* EHDSDataSet
Elements defined in Ancestors:header, presentedForm
Immunisation model
Instances of this logical model can be the target of a Reference
... header 1..1 Base Common header for all patient-related data
.... subject 1..1 EHDSPatient Subject
.... identifier 0..* Identifier Business identifier for the object
.... authorship 1..* Base Authorship
..... author[x] 1..1 Author
...... authorEHDSHealthProfessional EHDSHealthProfessional
...... authorEHDSOrganisation EHDSOrganisation
...... authorEHDSDevice EHDSDevice
..... datetime 1..1 dateTime Date and time of authoring/issuing
.... lastUpdate 0..1 dateTime Date and time of the last update to the resource
.... status 1..1 CodeableConcept Status of the resource
.... statusReason[x] 0..1 Reason for the current status of the resource.
..... statusReasonCodeableConcept CodeableConcept
..... statusReasonString string
.... language 0..1 CodeableConcept Language
Binding Description: (preferred): BCP 47
.... version 0..1 string Version
... presentedForm 0..* EHDSAttachment A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document
... diseaseOrAgentTargeted 0..* CodeableConcept Disease or agent targeted
Binding Description: (preferred): ICD-10, SNOMED CT
... administeredProduct 0..1 EHDSMedication Administered medicinal product
... doseNumber 0..1 integer Number in a series of vaccinations / doses
... dateOfVaccination 1..1 date Date of vaccination
... administeringCentre 0..* EHDSOrganisation Administering centre
... vaccineAdministrator 0..* EHDSHealthProfessional Administrator of vaccine
... nextVaccinationDate 0..1 date Next vaccination date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSImmunisation.header.languagepreferred
EHDSImmunisation.diseaseOrAgentTargetedpreferred
EHDSImmunisation.vaccinepreferred

This structure is derived from EHDSDataSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSImmunisation 0..* EHDSDataSet
Elements defined in Ancestors:header, presentedForm
Immunisation model
Instances of this logical model can be the target of a Reference
... header
.... status 1..1 CodeableConcept Status of the resource
... diseaseOrAgentTargeted 0..* CodeableConcept Disease or agent targeted
Binding Description: (preferred): ICD-10, SNOMED CT
... vaccine 1..1 CodeableConcept Type of vaccine
Binding Description: (preferred): SNOMED CT, ATC
... doseNumber 0..1 integer Number in a series of vaccinations / doses
... dateOfVaccination 1..1 date Date of vaccination
... administeringCentre 0..* EHDSOrganisation Administering centre
... vaccineAdministrator 0..* EHDSHealthProfessional Administrator of vaccine
... nextVaccinationDate 0..1 date Next vaccination date

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EHDSImmunisation.diseaseOrAgentTargetedpreferred
EHDSImmunisation.vaccinepreferred
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSImmunisation 0..* EHDSDataSet
Elements defined in Ancestors:header, presentedForm
Immunisation model
Instances of this logical model can be the target of a Reference
... header 1..1 Base Common header for all patient-related data
.... subject 1..1 EHDSPatient Subject
.... identifier 0..* Identifier Business identifier for the object
.... authorship 1..* Base Authorship
..... author[x] 1..1 Author
...... authorEHDSHealthProfessional EHDSHealthProfessional
...... authorEHDSOrganisation EHDSOrganisation
...... authorEHDSDevice EHDSDevice
..... datetime 1..1 dateTime Date and time of authoring/issuing
.... lastUpdate 0..1 dateTime Date and time of the last update to the resource
.... status 1..1 CodeableConcept Status of the resource
.... statusReason[x] 0..1 Reason for the current status of the resource.
..... statusReasonCodeableConcept CodeableConcept
..... statusReasonString string
.... language 0..1 CodeableConcept Language
Binding Description: (preferred): BCP 47
.... version 0..1 string Version
... presentedForm 0..* EHDSAttachment A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document
... diseaseOrAgentTargeted 0..* CodeableConcept Disease or agent targeted
Binding Description: (preferred): ICD-10, SNOMED CT
... administeredProduct 0..1 EHDSMedication Administered medicinal product
... doseNumber 0..1 integer Number in a series of vaccinations / doses
... dateOfVaccination 1..1 date Date of vaccination
... administeringCentre 0..* EHDSOrganisation Administering centre
... vaccineAdministrator 0..* EHDSHealthProfessional Administrator of vaccine
... nextVaccinationDate 0..1 date Next vaccination date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSImmunisation.header.languagepreferred
EHDSImmunisation.diseaseOrAgentTargetedpreferred
EHDSImmunisation.vaccinepreferred

This structure is derived from EHDSDataSet

Summary

Mandatory: 0 element(2 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSImmunisation 0..* EHDSDataSet
Elements defined in Ancestors:header, presentedForm
Immunisation model
Instances of this logical model can be the target of a Reference
... header 1..1 Base Common header for all patient-related data
.... subject 1..1 EHDSPatient Subject
.... identifier 0..* Identifier Business identifier for the object
.... authorship 1..* Base Authorship
..... author[x] 1..1 Author
...... authorEHDSHealthProfessional EHDSHealthProfessional
...... authorEHDSOrganisation EHDSOrganisation
...... authorEHDSDevice EHDSDevice
..... datetime 1..1 dateTime Date and time of authoring/issuing
.... lastUpdate 0..1 dateTime Date and time of the last update to the resource
.... status 1..1 CodeableConcept Status of the resource
.... statusReason[x] 0..1 Reason for the current status of the resource.
..... statusReasonCodeableConcept CodeableConcept
..... statusReasonString string
.... language 0..1 CodeableConcept Language
Binding Description: (preferred): BCP 47
.... version 0..1 string Version
... presentedForm 0..* EHDSAttachment A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document
... diseaseOrAgentTargeted 0..* CodeableConcept Disease or agent targeted
Binding Description: (preferred): ICD-10, SNOMED CT
... administeredProduct 0..1 EHDSMedication Administered medicinal product
... doseNumber 0..1 integer Number in a series of vaccinations / doses
... dateOfVaccination 1..1 date Date of vaccination
... administeringCentre 0..* EHDSOrganisation Administering centre
... vaccineAdministrator 0..* EHDSHealthProfessional Administrator of vaccine
... nextVaccinationDate 0..1 date Next vaccination date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSImmunisation.header.languagepreferred
EHDSImmunisation.diseaseOrAgentTargetedpreferred
EHDSImmunisation.vaccinepreferred

Differential View

This structure is derived from EHDSDataSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSImmunisation 0..* EHDSDataSet
Elements defined in Ancestors:header, presentedForm
Immunisation model
Instances of this logical model can be the target of a Reference
... header
.... status 1..1 CodeableConcept Status of the resource
... diseaseOrAgentTargeted 0..* CodeableConcept Disease or agent targeted
Binding Description: (preferred): ICD-10, SNOMED CT
... vaccine 1..1 CodeableConcept Type of vaccine
Binding Description: (preferred): SNOMED CT, ATC
... doseNumber 0..1 integer Number in a series of vaccinations / doses
... dateOfVaccination 1..1 date Date of vaccination
... administeringCentre 0..* EHDSOrganisation Administering centre
... vaccineAdministrator 0..* EHDSHealthProfessional Administrator of vaccine
... nextVaccinationDate 0..1 date Next vaccination date

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EHDSImmunisation.diseaseOrAgentTargetedpreferred
EHDSImmunisation.vaccinepreferred

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSImmunisation 0..* EHDSDataSet
Elements defined in Ancestors:header, presentedForm
Immunisation model
Instances of this logical model can be the target of a Reference
... header 1..1 Base Common header for all patient-related data
.... subject 1..1 EHDSPatient Subject
.... identifier 0..* Identifier Business identifier for the object
.... authorship 1..* Base Authorship
..... author[x] 1..1 Author
...... authorEHDSHealthProfessional EHDSHealthProfessional
...... authorEHDSOrganisation EHDSOrganisation
...... authorEHDSDevice EHDSDevice
..... datetime 1..1 dateTime Date and time of authoring/issuing
.... lastUpdate 0..1 dateTime Date and time of the last update to the resource
.... status 1..1 CodeableConcept Status of the resource
.... statusReason[x] 0..1 Reason for the current status of the resource.
..... statusReasonCodeableConcept CodeableConcept
..... statusReasonString string
.... language 0..1 CodeableConcept Language
Binding Description: (preferred): BCP 47
.... version 0..1 string Version
... presentedForm 0..* EHDSAttachment A narrative easy-to-read representation of the full data set, e.g. PDF-version of a document
... diseaseOrAgentTargeted 0..* CodeableConcept Disease or agent targeted
Binding Description: (preferred): ICD-10, SNOMED CT
... administeredProduct 0..1 EHDSMedication Administered medicinal product
... doseNumber 0..1 integer Number in a series of vaccinations / doses
... dateOfVaccination 1..1 date Date of vaccination
... administeringCentre 0..* EHDSOrganisation Administering centre
... vaccineAdministrator 0..* EHDSHealthProfessional Administrator of vaccine
... nextVaccinationDate 0..1 date Next vaccination date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSImmunisation.header.languagepreferred
EHDSImmunisation.diseaseOrAgentTargetedpreferred
EHDSImmunisation.vaccinepreferred

This structure is derived from EHDSDataSet

Summary

Mandatory: 0 element(2 nested mandatory elements)

 

Other representations of profile: CSV, Excel