XpanDH Patient Summary
0.1.0 - ci-build 150

XpanDH Patient Summary, published by XpanDH Project. 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/hl7-eu/xpandh-ps/ and changes regularly. See the Directory of published versions

Logical Model: VaccinationPsEhn - Detailed Descriptions

Draft as of 2024-12-12

Definitions for the Vaccination logical model.

Guidance on how to interpret the contents of this table can be found here

0. Vaccination
Definition

Vaccination/ prophylaxis information. Sections A2.2.2.1 of the eHN guideline.

ShortA.2.2.1 - Vaccination/ prophylaxis information
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Vaccination.targetDisease
Definition

Disease or agent that the vaccination provides protection against - Preferred system(s): ICD-10*, SNOMED CT GPS

ShortA.2.2.1.1 Disease or agent targeted
Control0..*
TypeCodeableConcept
4. Vaccination.vaccine
Definition

Generic description of the vaccine/prophylaxis or its component(s) - Preferred system(s): SNOMED CT GPS ATC* (IDMP, when available)

ShortA.2.2.1.2 Vaccine/prophylaxis
Control0..*
TypeCodeableConcept
6. Vaccination.productName
Definition

Brand name of the vaccine medicinal product.z

ShortA.2.2.1.3 Vaccine medicinal product name
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Vaccination.productId
Definition

Identifier for the vaccine medicinal product. It could be MPID according to ISO 11615, EMA PMS ID and/or a national identifier. EMA PMS

ShortA.2.2.1.3.1 Identifier of the vaccine medicinal product
Control0..*
TypeCodeableConcept
10. Vaccination.marketingAuthorisationHolder
Definition

Marketing Authorisation Holder EMA's Organisations System data (SPOR)

ShortA.2.2.1.4 Marketing Autorisation Holder
Control0..*
TypeCodeableConcept
12. Vaccination.numberInSeries
Definition

Vaccination in the vaccination course

ShortA.2.2.1.5 Number in a series of vaccinations/doses
Control0..*
TypeBackboneElement
14. Vaccination.batchNumber
Definition

A distinctive combination of numbers and/or letters which specifically identifies a batch

ShortA.2.2.1.6 Batch/lot number
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Vaccination.dateOfVaccination
Definition

The date when the vaccination was administered - Preferred system(s): ISO 8601

ShortA.2.2.1.7 Date of vaccination
Control0..*
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Vaccination.administeringCentre
Definition

Name/code of administering centre or a health authority responsible for the vaccination event

ShortA.2.2.1.8 Administering centre
Control0..*
TypeOrganization
20. Vaccination.healthProfessionalId
Definition

Name or health professional code responsible for administering the vaccine or prophylaxis

ShortA.2.2.1.9 Health Professional identification
Control0..*
TypeExtension(Identifier) (Extension Type: Identifier)
22. Vaccination.countryOfVaccination
Definition

The country in which the individual has been vaccinated - Preferred system(s): ISO 3166

ShortA.2.2.1.10 Country of vaccination
Control0..*
TypeCodeableConcept
24. Vaccination.dateOfNextVaccination
Definition

The date when the vaccination is planned to be given/repeated (e.g. next dose) - Preferred system(s): ISO 8601

ShortA.2.2.1.11 Next vaccination date
Control0..*
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Vaccination
Definition

Vaccination/ prophylaxis information. Sections A2.2.2.1 of the eHN guideline.

ShortA.2.2.1 - Vaccination/ prophylaxis information
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Vaccination.targetDisease
Definition

Disease or agent that the vaccination provides protection against - Preferred system(s): ICD-10*, SNOMED CT GPS

ShortA.2.2.1.1 Disease or agent targeted
Control0..*
TypeCodeableConcept
4. Vaccination.vaccine
Definition

Generic description of the vaccine/prophylaxis or its component(s) - Preferred system(s): SNOMED CT GPS ATC* (IDMP, when available)

ShortA.2.2.1.2 Vaccine/prophylaxis
Control0..*
TypeCodeableConcept
6. Vaccination.productName
Definition

Brand name of the vaccine medicinal product.z

ShortA.2.2.1.3 Vaccine medicinal product name
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Vaccination.productId
Definition

Identifier for the vaccine medicinal product. It could be MPID according to ISO 11615, EMA PMS ID and/or a national identifier. EMA PMS

ShortA.2.2.1.3.1 Identifier of the vaccine medicinal product
Control0..*
TypeCodeableConcept
10. Vaccination.marketingAuthorisationHolder
Definition

Marketing Authorisation Holder EMA's Organisations System data (SPOR)

ShortA.2.2.1.4 Marketing Autorisation Holder
Control0..*
TypeCodeableConcept
12. Vaccination.numberInSeries
Definition

Vaccination in the vaccination course

ShortA.2.2.1.5 Number in a series of vaccinations/doses
Control0..*
TypeBackboneElement
14. Vaccination.batchNumber
Definition

A distinctive combination of numbers and/or letters which specifically identifies a batch

ShortA.2.2.1.6 Batch/lot number
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Vaccination.dateOfVaccination
Definition

The date when the vaccination was administered - Preferred system(s): ISO 8601

ShortA.2.2.1.7 Date of vaccination
Control0..*
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Vaccination.administeringCentre
Definition

Name/code of administering centre or a health authority responsible for the vaccination event

ShortA.2.2.1.8 Administering centre
Control0..*
TypeOrganization
20. Vaccination.healthProfessionalId
Definition

Name or health professional code responsible for administering the vaccine or prophylaxis

ShortA.2.2.1.9 Health Professional identification
Control0..*
TypeExtension(Identifier) (Extension Type: Identifier)
22. Vaccination.countryOfVaccination
Definition

The country in which the individual has been vaccinated - Preferred system(s): ISO 3166

ShortA.2.2.1.10 Country of vaccination
Control0..*
TypeCodeableConcept
24. Vaccination.dateOfNextVaccination
Definition

The date when the vaccination is planned to be given/repeated (e.g. next dose) - Preferred system(s): ISO 8601

ShortA.2.2.1.11 Next vaccination date
Control0..*
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Vaccination
Definition

Vaccination/ prophylaxis information. Sections A2.2.2.1 of the eHN guideline.

ShortA.2.2.1 - Vaccination/ prophylaxis information
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Vaccination.targetDisease
Definition

Disease or agent that the vaccination provides protection against - Preferred system(s): ICD-10*, SNOMED CT GPS

ShortA.2.2.1.1 Disease or agent targeted
Control0..*
TypeCodeableConcept
4. Vaccination.vaccine
Definition

Generic description of the vaccine/prophylaxis or its component(s) - Preferred system(s): SNOMED CT GPS ATC* (IDMP, when available)

ShortA.2.2.1.2 Vaccine/prophylaxis
Control0..*
TypeCodeableConcept
6. Vaccination.productName
Definition

Brand name of the vaccine medicinal product.z

ShortA.2.2.1.3 Vaccine medicinal product name
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Vaccination.productId
Definition

Identifier for the vaccine medicinal product. It could be MPID according to ISO 11615, EMA PMS ID and/or a national identifier. EMA PMS

ShortA.2.2.1.3.1 Identifier of the vaccine medicinal product
Control0..*
TypeCodeableConcept
10. Vaccination.marketingAuthorisationHolder
Definition

Marketing Authorisation Holder EMA's Organisations System data (SPOR)

ShortA.2.2.1.4 Marketing Autorisation Holder
Control0..*
TypeCodeableConcept
12. Vaccination.numberInSeries
Definition

Vaccination in the vaccination course

ShortA.2.2.1.5 Number in a series of vaccinations/doses
Control0..*
TypeBackboneElement
14. Vaccination.batchNumber
Definition

A distinctive combination of numbers and/or letters which specifically identifies a batch

ShortA.2.2.1.6 Batch/lot number
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Vaccination.dateOfVaccination
Definition

The date when the vaccination was administered - Preferred system(s): ISO 8601

ShortA.2.2.1.7 Date of vaccination
Control0..*
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Vaccination.administeringCentre
Definition

Name/code of administering centre or a health authority responsible for the vaccination event

ShortA.2.2.1.8 Administering centre
Control0..*
TypeOrganization
20. Vaccination.healthProfessionalId
Definition

Name or health professional code responsible for administering the vaccine or prophylaxis

ShortA.2.2.1.9 Health Professional identification
Control0..*
TypeExtension(Identifier) (Extension Type: Identifier)
22. Vaccination.countryOfVaccination
Definition

The country in which the individual has been vaccinated - Preferred system(s): ISO 3166

ShortA.2.2.1.10 Country of vaccination
Control0..*
TypeCodeableConcept
24. Vaccination.dateOfNextVaccination
Definition

The date when the vaccination is planned to be given/repeated (e.g. next dose) - Preferred system(s): ISO 8601

ShortA.2.2.1.11 Next vaccination date
Control0..*
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension