This page is part of the MyHealth@Eu Patient Summary (v1.0.0-poc: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: Immunisation model

MyHealth@EU refined base model for Immunisation information in EPS

Usages:

• Use this Logical Model: 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
MyHealthEuImmunisationEps		0..*	MyHealthEuImmunisation	Immunisation model Elements defined in Ancestors:header, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note
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	O	0..*	CodeableConcept	Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
vaccine	O	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 Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administeredProduct	O	0..1	MyHealthEuMedication	Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary. Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administrationTime	O	1..1	dateTime	The date and optionally the exact time when the vaccination was administered. Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administeringCentre	O	0..1	MyHealthEuOrganisation	Administering centre or a health authority responsible for the vaccination event Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
administrator	O	0..1	MyHealthEuHealthProfessional	Health professional responsible for administering the immunisation product. Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
note	O	0..1	string	Any additional free-text information about the immunisation Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
doseNumber	O	0..1	positiveInt	Number in a series of vaccinations Obligations Actor MAY:able-to-populate MyHealth@EU Handler
countryOfVaccination	O	0..1	CodeableConcept	Country of vaccination Obligations Actor MAY:able-to-populate MyHealth@EU Handler
Documentation for this format

Terminology Bindings

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

This structure is derived from MyHealthEuImmunisation

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MyHealthEuImmunisationEps		0..*	MyHealthEuImmunisation	Immunisation model Elements defined in Ancestors:header, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note
doseNumber	O	0..1	positiveInt	Number in a series of vaccinations Obligations Actor MAY:able-to-populate MyHealth@EU Handler
countryOfVaccination	O	0..1	CodeableConcept	Country of vaccination Obligations Actor MAY:able-to-populate MyHealth@EU Handler
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MyHealthEuImmunisationEps		0..*	MyHealthEuImmunisation	Immunisation model Elements defined in Ancestors:header, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note
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	O	0..*	CodeableConcept	Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
vaccine	O	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 Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administeredProduct	O	0..1	MyHealthEuMedication	Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary. Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administrationTime	O	1..1	dateTime	The date and optionally the exact time when the vaccination was administered. Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administeringCentre	O	0..1	MyHealthEuOrganisation	Administering centre or a health authority responsible for the vaccination event Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
administrator	O	0..1	MyHealthEuHealthProfessional	Health professional responsible for administering the immunisation product. Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
note	O	0..1	string	Any additional free-text information about the immunisation Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
doseNumber	O	0..1	positiveInt	Number in a series of vaccinations Obligations Actor MAY:able-to-populate MyHealth@EU Handler
countryOfVaccination	O	0..1	CodeableConcept	Country of vaccination Obligations Actor MAY:able-to-populate MyHealth@EU Handler
Documentation for this format

Terminology Bindings

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

This structure is derived from MyHealthEuImmunisation

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MyHealthEuImmunisationEps		0..*	MyHealthEuImmunisation	Immunisation model Elements defined in Ancestors:header, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note
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	O	0..*	CodeableConcept	Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
vaccine	O	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 Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administeredProduct	O	0..1	MyHealthEuMedication	Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary. Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administrationTime	O	1..1	dateTime	The date and optionally the exact time when the vaccination was administered. Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administeringCentre	O	0..1	MyHealthEuOrganisation	Administering centre or a health authority responsible for the vaccination event Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
administrator	O	0..1	MyHealthEuHealthProfessional	Health professional responsible for administering the immunisation product. Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
note	O	0..1	string	Any additional free-text information about the immunisation Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
doseNumber	O	0..1	positiveInt	Number in a series of vaccinations Obligations Actor MAY:able-to-populate MyHealth@EU Handler
countryOfVaccination	O	0..1	CodeableConcept	Country of vaccination Obligations Actor MAY:able-to-populate MyHealth@EU Handler
Documentation for this format

Terminology Bindings

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

Differential View

This structure is derived from MyHealthEuImmunisation

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MyHealthEuImmunisationEps		0..*	MyHealthEuImmunisation	Immunisation model Elements defined in Ancestors:header, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note
doseNumber	O	0..1	positiveInt	Number in a series of vaccinations Obligations Actor MAY:able-to-populate MyHealth@EU Handler
countryOfVaccination	O	0..1	CodeableConcept	Country of vaccination Obligations Actor MAY:able-to-populate MyHealth@EU Handler
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MyHealthEuImmunisationEps		0..*	MyHealthEuImmunisation	Immunisation model Elements defined in Ancestors:header, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note
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	O	0..*	CodeableConcept	Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
vaccine	O	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 Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administeredProduct	O	0..1	MyHealthEuMedication	Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary. Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administrationTime	O	1..1	dateTime	The date and optionally the exact time when the vaccination was administered. Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunisation model
administeringCentre	O	0..1	MyHealthEuOrganisation	Administering centre or a health authority responsible for the vaccination event Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
administrator	O	0..1	MyHealthEuHealthProfessional	Health professional responsible for administering the immunisation product. Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
note	O	0..1	string	Any additional free-text information about the immunisation Obligations Actor Source MAY:able-to-populate MyHealth@EU Handler from Immunisation model
doseNumber	O	0..1	positiveInt	Number in a series of vaccinations Obligations Actor MAY:able-to-populate MyHealth@EU Handler
countryOfVaccination	O	0..1	CodeableConcept	Country of vaccination Obligations Actor MAY:able-to-populate MyHealth@EU Handler
Documentation for this format

Terminology Bindings

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

This structure is derived from MyHealthEuImmunisation

Summary

Other representations of profile: CSV, Excel