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/stakeholder-consultation-D6-2 and changes regularly. See the Directory of published versions

## Logical Model: Immunization model

Official URL: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSImmunization | Version: 0.1.0
Draft as of 2025-05-26 | Computable Name: EHDSImmunization

C.24 - EHDS refined base model for Immunization

Usage:

- Use this Logical Model Profile: Hospital Discharge Report body model, Laboratory order body model, Laboratory report body model and Patient summary model

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
EHDSImmunization |  | 0..* | Base | Immunization model Instances of this logical model can be the target of a Reference
identifier |  | 0..* | Identifier | C.24.1 - Identifier
status |  | 1..1 | CodeableConcept | C.24.2 - Status
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | C.24.3 - Disease or agent targeted Binding Description (No ValueSet): (preferred): ICD-10*, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | C.24.4 - Vaccine Binding Description (No ValueSet): (preferred): SNOMED CT, ATC (IDMP/ EMA SPOR SMS)
administeredProduct |  | 0..1 | EHDSMedication | C.24.5 - Administered product
doseNumber |  | 0..1 | integer64 | C.24.7 - Number in a series of vaccinations / doses
batchNumber |  | 0..* | string | C.24.8 - Batch number
dateOfVaccination |  | 1..1 | date | C.24.9 - Date of vaccination
administeringCentre |  | 0..* | EHDSOrganization | C.24.10 - Administering centre
healthProfessionalIdentification |  | 0..* | EHDSHealthProfessional | C.24.11 - Health Professional identification
countryOfVaccination |  | 0..1 | CodeableConcept | C.24.12 - Country of vaccination Binding Description (No ValueSet): (preferred): ISO 3166
nextVaccinationDate |  | 0..1 | date | C.24.13 - Next vaccination date
subject |  | 1..1 | Reference(Patient model) | C.24.14 - Subject
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
EHDSImmunization.diseaseOrAgentTargeted | preferred |
EHDSImmunization.vaccine | preferred |
EHDSImmunization.countryOfVaccination | preferred |

This structure is derived from Base

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
EHDSImmunization |  | 0..* | Base | Immunization model Instances of this logical model can be the target of a Reference
identifier |  | 0..* | Identifier | C.24.1 - Identifier
status |  | 1..1 | CodeableConcept | C.24.2 - Status
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | C.24.3 - Disease or agent targeted Binding Description (No ValueSet): (preferred): ICD-10*, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | C.24.4 - Vaccine Binding Description (No ValueSet): (preferred): SNOMED CT, ATC (IDMP/ EMA SPOR SMS)
administeredProduct |  | 0..1 | EHDSMedication | C.24.5 - Administered product
doseNumber |  | 0..1 | integer64 | C.24.7 - Number in a series of vaccinations / doses
batchNumber |  | 0..* | string | C.24.8 - Batch number
dateOfVaccination |  | 1..1 | date | C.24.9 - Date of vaccination
administeringCentre |  | 0..* | EHDSOrganization | C.24.10 - Administering centre
healthProfessionalIdentification |  | 0..* | EHDSHealthProfessional | C.24.11 - Health Professional identification
countryOfVaccination |  | 0..1 | CodeableConcept | C.24.12 - Country of vaccination Binding Description (No ValueSet): (preferred): ISO 3166
nextVaccinationDate |  | 0..1 | date | C.24.13 - Next vaccination date
subject |  | 1..1 | Reference(Patient model) | C.24.14 - Subject
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
EHDSImmunization.diseaseOrAgentTargeted | preferred |
EHDSImmunization.vaccine | preferred |
EHDSImmunization.countryOfVaccination | preferred |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
EHDSImmunization |  | 0..* | Base | Immunization model Instances of this logical model can be the target of a Reference
identifier |  | 0..* | Identifier | C.24.1 - Identifier
status |  | 1..1 | CodeableConcept | C.24.2 - Status
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | C.24.3 - Disease or agent targeted Binding Description (No ValueSet): (preferred): ICD-10*, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | C.24.4 - Vaccine Binding Description (No ValueSet): (preferred): SNOMED CT, ATC (IDMP/ EMA SPOR SMS)
administeredProduct |  | 0..1 | EHDSMedication | C.24.5 - Administered product
doseNumber |  | 0..1 | integer64 | C.24.7 - Number in a series of vaccinations / doses
batchNumber |  | 0..* | string | C.24.8 - Batch number
dateOfVaccination |  | 1..1 | date | C.24.9 - Date of vaccination
administeringCentre |  | 0..* | EHDSOrganization | C.24.10 - Administering centre
healthProfessionalIdentification |  | 0..* | EHDSHealthProfessional | C.24.11 - Health Professional identification
countryOfVaccination |  | 0..1 | CodeableConcept | C.24.12 - Country of vaccination Binding Description (No ValueSet): (preferred): ISO 3166
nextVaccinationDate |  | 0..1 | date | C.24.13 - Next vaccination date
subject |  | 1..1 | Reference(Patient model) | C.24.14 - Subject
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
EHDSImmunization.diseaseOrAgentTargeted | preferred |
EHDSImmunization.vaccine | preferred |
EHDSImmunization.countryOfVaccination | preferred |

This structure is derived from Base

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

- Patient model (https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
EHDSImmunization |  | 0..* | Base | Immunization model Instances of this logical model can be the target of a Reference
identifier |  | 0..* | Identifier | C.24.1 - Identifier
status |  | 1..1 | CodeableConcept | C.24.2 - Status
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | C.24.3 - Disease or agent targeted Binding Description (No ValueSet): (preferred): ICD-10*, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | C.24.4 - Vaccine Binding Description (No ValueSet): (preferred): SNOMED CT, ATC (IDMP/ EMA SPOR SMS)
administeredProduct |  | 0..1 | EHDSMedication | C.24.5 - Administered product
doseNumber |  | 0..1 | integer64 | C.24.7 - Number in a series of vaccinations / doses
batchNumber |  | 0..* | string | C.24.8 - Batch number
dateOfVaccination |  | 1..1 | date | C.24.9 - Date of vaccination
administeringCentre |  | 0..* | EHDSOrganization | C.24.10 - Administering centre
healthProfessionalIdentification |  | 0..* | EHDSHealthProfessional | C.24.11 - Health Professional identification
countryOfVaccination |  | 0..1 | CodeableConcept | C.24.12 - Country of vaccination Binding Description (No ValueSet): (preferred): ISO 3166
nextVaccinationDate |  | 0..1 | date | C.24.13 - Next vaccination date
subject |  | 1..1 | Reference(Patient model) | C.24.14 - Subject
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
EHDSImmunization.diseaseOrAgentTargeted | preferred |
EHDSImmunization.vaccine | preferred |
EHDSImmunization.countryOfVaccination | preferred |

Differential View

This structure is derived from Base

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
EHDSImmunization |  | 0..* | Base | Immunization model Instances of this logical model can be the target of a Reference
identifier |  | 0..* | Identifier | C.24.1 - Identifier
status |  | 1..1 | CodeableConcept | C.24.2 - Status
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | C.24.3 - Disease or agent targeted Binding Description (No ValueSet): (preferred): ICD-10*, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | C.24.4 - Vaccine Binding Description (No ValueSet): (preferred): SNOMED CT, ATC (IDMP/ EMA SPOR SMS)
administeredProduct |  | 0..1 | EHDSMedication | C.24.5 - Administered product
doseNumber |  | 0..1 | integer64 | C.24.7 - Number in a series of vaccinations / doses
batchNumber |  | 0..* | string | C.24.8 - Batch number
dateOfVaccination |  | 1..1 | date | C.24.9 - Date of vaccination
administeringCentre |  | 0..* | EHDSOrganization | C.24.10 - Administering centre
healthProfessionalIdentification |  | 0..* | EHDSHealthProfessional | C.24.11 - Health Professional identification
countryOfVaccination |  | 0..1 | CodeableConcept | C.24.12 - Country of vaccination Binding Description (No ValueSet): (preferred): ISO 3166
nextVaccinationDate |  | 0..1 | date | C.24.13 - Next vaccination date
subject |  | 1..1 | Reference(Patient model) | C.24.14 - Subject
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
EHDSImmunization.diseaseOrAgentTargeted | preferred |
EHDSImmunization.vaccine | preferred |
EHDSImmunization.countryOfVaccination | preferred |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
EHDSImmunization |  | 0..* | Base | Immunization model Instances of this logical model can be the target of a Reference
identifier |  | 0..* | Identifier | C.24.1 - Identifier
status |  | 1..1 | CodeableConcept | C.24.2 - Status
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | C.24.3 - Disease or agent targeted Binding Description (No ValueSet): (preferred): ICD-10*, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | C.24.4 - Vaccine Binding Description (No ValueSet): (preferred): SNOMED CT, ATC (IDMP/ EMA SPOR SMS)
administeredProduct |  | 0..1 | EHDSMedication | C.24.5 - Administered product
doseNumber |  | 0..1 | integer64 | C.24.7 - Number in a series of vaccinations / doses
batchNumber |  | 0..* | string | C.24.8 - Batch number
dateOfVaccination |  | 1..1 | date | C.24.9 - Date of vaccination
administeringCentre |  | 0..* | EHDSOrganization | C.24.10 - Administering centre
healthProfessionalIdentification |  | 0..* | EHDSHealthProfessional | C.24.11 - Health Professional identification
countryOfVaccination |  | 0..1 | CodeableConcept | C.24.12 - Country of vaccination Binding Description (No ValueSet): (preferred): ISO 3166
nextVaccinationDate |  | 0..1 | date | C.24.13 - Next vaccination date
subject |  | 1..1 | Reference(Patient model) | C.24.14 - Subject
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
EHDSImmunization.diseaseOrAgentTargeted | preferred |
EHDSImmunization.vaccine | preferred |
EHDSImmunization.countryOfVaccination | preferred |

This structure is derived from Base

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

- Patient model (https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient)

Other representations of profile: CSV, Excel