Xt-EHR
0.1.0 - ci-build
Xt-EHR
0.1.0 - ci-build
Xt-EHR, 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/ and changes regularly. See the Directory of published versions
| Draft as of 2024-11-13 |
Definitions for the EHDSImmunization logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. EHDSImmunization | |
| Definition | C.24 - EHDS refined base model for Immunization |
| Short | Immunization |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSImmunization.identifier | |
| Definition | Immunization identifier |
| Short | C.24.1 - Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSImmunization.status | |
| Definition | Indicates the current status of the immunization event (completed, not-done). |
| Short | C.24.2 - Status |
| Control | 1..1 |
| Type | CodeableConcept |
| 6. EHDSImmunization.diseaseOrAgentTargeted | |
| Definition | Disease or agent that the vaccination provides protection against. |
| Short | C.24.3 - Disease or agent targeted |
| Control | 0..* |
| Binding | ICD-10*, SNOMED CT |
| Type | CodeableConcept |
| 8. EHDSImmunization.vaccine | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s). |
| Short | C.24.4 - Vaccine |
| Control | 1..1 |
| Binding | SNOMED CT, ATC (IDMP/ EMA SPOR SMS) |
| Type | CodeableConcept |
| 10. EHDSImmunization.administeredProduct | |
| Definition | Medicinal product administered. |
| Short | C.24.5 - Administered product |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
| 12. EHDSImmunization.doseNumber | |
| Definition | Order in the vaccination course. |
| Short | C.24.7 - Number in a series of vaccinations / doses |
| Control | 0..1 |
| Type | integer64 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. EHDSImmunization.batchNumber | |
| Definition | A distinctive combination of numbers and/or letters which specifically identifies a batch. |
| Short | C.24.8 - Batch number |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. EHDSImmunization.dateOfVaccination | |
| Definition | The date and time when the vaccination was administered |
| Short | C.24.9 - Date of vaccination |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. EHDSImmunization.administeringCentre | |
| Definition | Name/code of administering centre or a health authority responsible for the vaccination event |
| Short | C.24.10 - Administering centre |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
| 20. EHDSImmunization.healthProfessionalIdentification | |
| Definition | Name or health professional code responsible for administering the vaccine or prophylaxis |
| Short | C.24.11 - Health Professional identification |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| 22. EHDSImmunization.countryOfVaccination | |
| Definition | The country in which the individual has been vaccinated |
| Short | C.24.12 - Country of vaccination |
| Control | 0..1 |
| Binding | ISO 3166 |
| Type | CodeableConcept |
| 24. EHDSImmunization.nextVaccinationDate | |
| Definition | The date when the vaccination is planned to be given/repeated (e.g. next dose) |
| Short | C.24.13 - Next vaccination date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. EHDSImmunization.subject | |
| Definition | The patient who either received or did not receive the immunization. |
| Short | C.24.14 - Subject |
| Control | 1..1 |
| Type | Reference(Patient (model)) |
Guidance on how to interpret the contents of this table can be found here
| 0. EHDSImmunization | |
| Definition | C.24 - EHDS refined base model for Immunization Base definition for all types defined in FHIR type system. |
| Short | ImmunizationBase 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. EHDSImmunization.identifier | |
| Definition | Immunization identifier |
| Short | C.24.1 - Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSImmunization.status | |
| Definition | Indicates the current status of the immunization event (completed, not-done). |
| Short | C.24.2 - Status |
| Control | 1..1 |
| Type | CodeableConcept |
| 6. EHDSImmunization.diseaseOrAgentTargeted | |
| Definition | Disease or agent that the vaccination provides protection against. |
| Short | C.24.3 - Disease or agent targeted |
| Control | 0..* |
| Binding | ICD-10*, SNOMED CT |
| Type | CodeableConcept |
| 8. EHDSImmunization.vaccine | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s). |
| Short | C.24.4 - Vaccine |
| Control | 1..1 |
| Binding | SNOMED CT, ATC (IDMP/ EMA SPOR SMS) |
| Type | CodeableConcept |
| 10. EHDSImmunization.administeredProduct | |
| Definition | Medicinal product administered. |
| Short | C.24.5 - Administered product |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
| 12. EHDSImmunization.doseNumber | |
| Definition | Order in the vaccination course. |
| Short | C.24.7 - Number in a series of vaccinations / doses |
| Control | 0..1 |
| Type | integer64 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. EHDSImmunization.batchNumber | |
| Definition | A distinctive combination of numbers and/or letters which specifically identifies a batch. |
| Short | C.24.8 - Batch number |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. EHDSImmunization.dateOfVaccination | |
| Definition | The date and time when the vaccination was administered |
| Short | C.24.9 - Date of vaccination |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. EHDSImmunization.administeringCentre | |
| Definition | Name/code of administering centre or a health authority responsible for the vaccination event |
| Short | C.24.10 - Administering centre |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
| 20. EHDSImmunization.healthProfessionalIdentification | |
| Definition | Name or health professional code responsible for administering the vaccine or prophylaxis |
| Short | C.24.11 - Health Professional identification |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| 22. EHDSImmunization.countryOfVaccination | |
| Definition | The country in which the individual has been vaccinated |
| Short | C.24.12 - Country of vaccination |
| Control | 0..1 |
| Binding | ISO 3166 |
| Type | CodeableConcept |
| 24. EHDSImmunization.nextVaccinationDate | |
| Definition | The date when the vaccination is planned to be given/repeated (e.g. next dose) |
| Short | C.24.13 - Next vaccination date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. EHDSImmunization.subject | |
| Definition | The patient who either received or did not receive the immunization. |
| Short | C.24.14 - Subject |
| Control | 1..1 |
| Type | Reference(Patient (model)) |
Guidance on how to interpret the contents of this table can be found here
| 0. EHDSImmunization | |
| Definition | C.24 - EHDS refined base model for Immunization |
| Short | Immunization |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. EHDSImmunization.identifier | |
| Definition | Immunization identifier |
| Short | C.24.1 - Identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 4. EHDSImmunization.status | |
| Definition | Indicates the current status of the immunization event (completed, not-done). |
| Short | C.24.2 - Status |
| Control | 1..1 |
| Type | CodeableConcept |
| 6. EHDSImmunization.diseaseOrAgentTargeted | |
| Definition | Disease or agent that the vaccination provides protection against. |
| Short | C.24.3 - Disease or agent targeted |
| Control | 0..* |
| Binding | ICD-10*, SNOMED CT |
| Type | CodeableConcept |
| 8. EHDSImmunization.vaccine | |
| Definition | Generic description of the vaccine/prophylaxis or its component(s). |
| Short | C.24.4 - Vaccine |
| Control | 1..1 |
| Binding | SNOMED CT, ATC (IDMP/ EMA SPOR SMS) |
| Type | CodeableConcept |
| 10. EHDSImmunization.administeredProduct | |
| Definition | Medicinal product administered. |
| Short | C.24.5 - Administered product |
| Control | 0..1 |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication |
| 12. EHDSImmunization.doseNumber | |
| Definition | Order in the vaccination course. |
| Short | C.24.7 - Number in a series of vaccinations / doses |
| Control | 0..1 |
| Type | integer64 |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. EHDSImmunization.batchNumber | |
| Definition | A distinctive combination of numbers and/or letters which specifically identifies a batch. |
| Short | C.24.8 - Batch number |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. EHDSImmunization.dateOfVaccination | |
| Definition | The date and time when the vaccination was administered |
| Short | C.24.9 - Date of vaccination |
| Control | 1..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. EHDSImmunization.administeringCentre | |
| Definition | Name/code of administering centre or a health authority responsible for the vaccination event |
| Short | C.24.10 - Administering centre |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization |
| 20. EHDSImmunization.healthProfessionalIdentification | |
| Definition | Name or health professional code responsible for administering the vaccine or prophylaxis |
| Short | C.24.11 - Health Professional identification |
| Control | 0..* |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional |
| 22. EHDSImmunization.countryOfVaccination | |
| Definition | The country in which the individual has been vaccinated |
| Short | C.24.12 - Country of vaccination |
| Control | 0..1 |
| Binding | ISO 3166 |
| Type | CodeableConcept |
| 24. EHDSImmunization.nextVaccinationDate | |
| Definition | The date when the vaccination is planned to be given/repeated (e.g. next dose) |
| Short | C.24.13 - Next vaccination date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. EHDSImmunization.subject | |
| Definition | The patient who either received or did not receive the immunization. |
| Short | C.24.14 - Subject |
| Control | 1..1 |
| Type | Reference(Patient (model)) |
IG © 2022+ Xt-EHR. Package hl7.eu.fhir.xt-ehr.common#0.1.0 based on FHIR 5.0.0. Generated 2024-11-13
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.
