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: Immunisation model

Official URL: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation | Version: 0.4.0
Draft as of 2026-03-03 | Computable Name: EHDSImmunisation

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.

Usages:

- Derived from this Logical Model: Immunisation obligations
- Use this Logical Model: Laboratory report model and Patient summary model

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.

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
EHDSImmunisation |  | 0..* | EHDSDataSet | Immunisation model Elements defined in Ancestors:header
header |  | 1..1 | Base | Basic metadata for this information
subject |  | 1..1 | EHDSPatient | Patient/subject information
identifier |  | 0..* | Identifier | Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
author[x] |  | 0..* |  | The author of the immunisation statement.
authorEHDSHealthProfessional |  |  | EHDSHealthProfessional |
authorEHDSOrganisation |  |  | EHDSOrganisation |
authorEHDSDevice |  |  | EHDSDevice |
date |  | 0..1 | dateTime | Date and optionally time of authoring/issuing
status |  | 1..1 | CodeableConcept | Status of the immunisation event (completed, not-done).
source |  | 0..1 | CodeableConcept | 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.
language |  | 0..1 | CodeableConcept | Language in which the resource is written. Language is expressed by the IETF language tag. Binding Description: (preferred): BCP 47
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product. Binding Description: (preferred): SNOMED CT, ATC
administeredProduct |  | 0..1 | EHDSMedication | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
administrationTime |  | 1..1 | dateTime | The date and optionally the exact time when the vaccination was administered.
administeringCentre |  | 0..1 | EHDSOrganisation | Administering centre or a health authority responsible for the vaccination event
administrator |  | 0..1 | EHDSHealthProfessional | Health professional responsible for administering the immunisation product.
note |  | 0..1 | string | Any additional free-text information about the immunisation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
EHDSImmunisation.header.​language | Base | preferred |  | Not State | Unknown
EHDSImmunisation.diseaseOrAgentTargeted | Base | preferred |  | Not State | Unknown
EHDSImmunisation.vaccine | Base | preferred |  | Not State | Unknown

This structure is derived from EHDSDataSet

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
EHDSImmunisation |  | 0..* | EHDSDataSet | Immunisation model Elements defined in Ancestors:header
header |  |  |  |
author[x] |  | 0..* | EHDSHealthProfessional, EHDSOrganisation, EHDSDevice | The author of the immunisation statement.
status |  | 1..1 | CodeableConcept | Status of the immunisation event (completed, not-done).
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product. Binding Description: (preferred): SNOMED CT, ATC
administeredProduct |  | 0..1 | EHDSMedication | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
administrationTime |  | 1..1 | dateTime | The date and optionally the exact time when the vaccination was administered.
administeringCentre |  | 0..1 | EHDSOrganisation | Administering centre or a health authority responsible for the vaccination event
administrator |  | 0..1 | EHDSHealthProfessional | Health professional responsible for administering the immunisation product.
note |  | 0..1 | string | Any additional free-text information about the immunisation
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
EHDSImmunisation.diseaseOrAgentTargeted | Base | preferred |  | Not State | Unknown
EHDSImmunisation.vaccine | Base | preferred |  | Not State | Unknown

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
EHDSImmunisation |  | 0..* | EHDSDataSet | Immunisation model Elements defined in Ancestors:header
header |  | 1..1 | Base | Basic metadata for this information
subject |  | 1..1 | EHDSPatient | Patient/subject information
identifier |  | 0..* | Identifier | Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
author[x] |  | 0..* |  | The author of the immunisation statement.
authorEHDSHealthProfessional |  |  | EHDSHealthProfessional |
authorEHDSOrganisation |  |  | EHDSOrganisation |
authorEHDSDevice |  |  | EHDSDevice |
date |  | 0..1 | dateTime | Date and optionally time of authoring/issuing
status |  | 1..1 | CodeableConcept | Status of the immunisation event (completed, not-done).
source |  | 0..1 | CodeableConcept | 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.
language |  | 0..1 | CodeableConcept | Language in which the resource is written. Language is expressed by the IETF language tag. Binding Description: (preferred): BCP 47
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product. Binding Description: (preferred): SNOMED CT, ATC
administeredProduct |  | 0..1 | EHDSMedication | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
administrationTime |  | 1..1 | dateTime | The date and optionally the exact time when the vaccination was administered.
administeringCentre |  | 0..1 | EHDSOrganisation | Administering centre or a health authority responsible for the vaccination event
administrator |  | 0..1 | EHDSHealthProfessional | Health professional responsible for administering the immunisation product.
note |  | 0..1 | string | Any additional free-text information about the immunisation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
EHDSImmunisation.header.​language | Base | preferred |  | Not State | Unknown
EHDSImmunisation.diseaseOrAgentTargeted | Base | preferred |  | Not State | Unknown
EHDSImmunisation.vaccine | Base | preferred |  | Not State | Unknown

This structure is derived from EHDSDataSet

Summary

Mandatory: 0 element(2 nested mandatory elements)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
EHDSImmunisation |  | 0..* | EHDSDataSet | Immunisation model Elements defined in Ancestors:header
header |  | 1..1 | Base | Basic metadata for this information
subject |  | 1..1 | EHDSPatient | Patient/subject information
identifier |  | 0..* | Identifier | Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
author[x] |  | 0..* |  | The author of the immunisation statement.
authorEHDSHealthProfessional |  |  | EHDSHealthProfessional |
authorEHDSOrganisation |  |  | EHDSOrganisation |
authorEHDSDevice |  |  | EHDSDevice |
date |  | 0..1 | dateTime | Date and optionally time of authoring/issuing
status |  | 1..1 | CodeableConcept | Status of the immunisation event (completed, not-done).
source |  | 0..1 | CodeableConcept | 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.
language |  | 0..1 | CodeableConcept | Language in which the resource is written. Language is expressed by the IETF language tag. Binding Description: (preferred): BCP 47
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product. Binding Description: (preferred): SNOMED CT, ATC
administeredProduct |  | 0..1 | EHDSMedication | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
administrationTime |  | 1..1 | dateTime | The date and optionally the exact time when the vaccination was administered.
administeringCentre |  | 0..1 | EHDSOrganisation | Administering centre or a health authority responsible for the vaccination event
administrator |  | 0..1 | EHDSHealthProfessional | Health professional responsible for administering the immunisation product.
note |  | 0..1 | string | Any additional free-text information about the immunisation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
EHDSImmunisation.header.​language | Base | preferred |  | Not State | Unknown
EHDSImmunisation.diseaseOrAgentTargeted | Base | preferred |  | Not State | Unknown
EHDSImmunisation.vaccine | Base | preferred |  | Not State | Unknown

Differential View

This structure is derived from EHDSDataSet

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
EHDSImmunisation |  | 0..* | EHDSDataSet | Immunisation model Elements defined in Ancestors:header
header |  |  |  |
author[x] |  | 0..* | EHDSHealthProfessional, EHDSOrganisation, EHDSDevice | The author of the immunisation statement.
status |  | 1..1 | CodeableConcept | Status of the immunisation event (completed, not-done).
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product. Binding Description: (preferred): SNOMED CT, ATC
administeredProduct |  | 0..1 | EHDSMedication | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
administrationTime |  | 1..1 | dateTime | The date and optionally the exact time when the vaccination was administered.
administeringCentre |  | 0..1 | EHDSOrganisation | Administering centre or a health authority responsible for the vaccination event
administrator |  | 0..1 | EHDSHealthProfessional | Health professional responsible for administering the immunisation product.
note |  | 0..1 | string | Any additional free-text information about the immunisation
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
EHDSImmunisation.diseaseOrAgentTargeted | Base | preferred |  | Not State | Unknown
EHDSImmunisation.vaccine | Base | preferred |  | Not State | Unknown

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
EHDSImmunisation |  | 0..* | EHDSDataSet | Immunisation model Elements defined in Ancestors:header
header |  | 1..1 | Base | Basic metadata for this information
subject |  | 1..1 | EHDSPatient | Patient/subject information
identifier |  | 0..* | Identifier | Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
author[x] |  | 0..* |  | The author of the immunisation statement.
authorEHDSHealthProfessional |  |  | EHDSHealthProfessional |
authorEHDSOrganisation |  |  | EHDSOrganisation |
authorEHDSDevice |  |  | EHDSDevice |
date |  | 0..1 | dateTime | Date and optionally time of authoring/issuing
status |  | 1..1 | CodeableConcept | Status of the immunisation event (completed, not-done).
source |  | 0..1 | CodeableConcept | 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.
language |  | 0..1 | CodeableConcept | Language in which the resource is written. Language is expressed by the IETF language tag. Binding Description: (preferred): BCP 47
diseaseOrAgentTargeted |  | 0..* | CodeableConcept | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT
vaccine |  | 1..1 | CodeableConcept | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product. Binding Description: (preferred): SNOMED CT, ATC
administeredProduct |  | 0..1 | EHDSMedication | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
administrationTime |  | 1..1 | dateTime | The date and optionally the exact time when the vaccination was administered.
administeringCentre |  | 0..1 | EHDSOrganisation | Administering centre or a health authority responsible for the vaccination event
administrator |  | 0..1 | EHDSHealthProfessional | Health professional responsible for administering the immunisation product.
note |  | 0..1 | string | Any additional free-text information about the immunisation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
EHDSImmunisation.header.​language | Base | preferred |  | Not State | Unknown
EHDSImmunisation.diseaseOrAgentTargeted | Base | preferred |  | Not State | Unknown
EHDSImmunisation.vaccine | Base | preferred |  | Not State | Unknown

This structure is derived from EHDSDataSet

Summary

Mandatory: 0 element(2 nested mandatory elements)

Other representations of profile: CSV, Excel