HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/ and changes regularly. See the Directory of published versions
| Official URL: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSImmunisation | Version: 0.1.0 | |||
| Draft as of 2025-08-05 | Computable Name: EHDSImmunisation | |||
| Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License | ||||
EHDS refined base model for Immunisation
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   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 | |
|    vaccine | 1..1 | CodeableConcept | Type of vaccine Binding Description: (preferred): SNOMED CT, ATC | |
|    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 | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| EHDSImmunisation.header.language | preferred | ||
| EHDSImmunisation.diseaseOrAgentTargeted | preferred | ||
| EHDSImmunisation.vaccine | preferred | 
This structure is derived from EHDSDataSet
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   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 | |
|    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 | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| EHDSImmunisation.diseaseOrAgentTargeted | preferred | ||
| EHDSImmunisation.vaccine | preferred | 
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   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 | |
|    vaccine | 1..1 | CodeableConcept | Type of vaccine Binding Description: (preferred): SNOMED CT, ATC | |
|    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 | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| EHDSImmunisation.header.language | preferred | ||
| EHDSImmunisation.diseaseOrAgentTargeted | preferred | ||
| EHDSImmunisation.vaccine | preferred | 
This structure is derived from EHDSDataSet
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   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 | |
|    vaccine | 1..1 | CodeableConcept | Type of vaccine Binding Description: (preferred): SNOMED CT, ATC | |
|    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 | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| EHDSImmunisation.header.language | preferred | ||
| EHDSImmunisation.diseaseOrAgentTargeted | preferred | ||
| EHDSImmunisation.vaccine | preferred | 
Differential View
This structure is derived from EHDSDataSet
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   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 | |
|    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 | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| EHDSImmunisation.diseaseOrAgentTargeted | preferred | ||
| EHDSImmunisation.vaccine | preferred | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   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 | |
|    vaccine | 1..1 | CodeableConcept | Type of vaccine Binding Description: (preferred): SNOMED CT, ATC | |
|    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 | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| EHDSImmunisation.header.language | preferred | ||
| EHDSImmunisation.diseaseOrAgentTargeted | preferred | ||
| EHDSImmunisation.vaccine | preferred | 
This structure is derived from EHDSDataSet