MyHealth@Eu Vaccination - Local Development build (v10.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Vaccination (EUVAC)

This profile constrains the Vaccination resource to represent the MyHealth@EU Vaccination History requirements (items 41–53).

This profile constrains the Vaccination resource for the purpose of this guide.

Usages:

• Refer to this Profile: Vaccination History (EUVAC)
• Examples for this Profile: Immunization/vacc-full-euvac and Immunization/vacc-minimal-euvac

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
Immunization		0..*	ImmunizationMyHealthCore	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:administeredProduct	O	1..1	(Complex)	R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1 Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:_datatype		1..1	Extension	DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/_datatype"
value[x]		1..1	string	Value of extension Fixed Value: CodeableReference
extension:concept		0..1	Extension	R5: Reference to a concept (by class) Constraints: ext-1
url		1..1	uri	"concept"
extension:reference		0..1	Extension	Extension Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"reference"
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
extension:informationSource		0..1	(Complex)	R5: Indicates the source of a reported record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Constraints: ext-1
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:_datatype		1..1	Extension	DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/_datatype"
value[x]		1..1	string	Value of extension Fixed Value: CodeableReference
extension:concept		0..1	Extension	R5: Reference to a concept (by class) Constraints: ext-1
url		1..1	uri	"concept"
extension:reference		0..1	Extension	Extension Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"reference"
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
vaccineCode	OΣ	1..1	CodeableConcept	Vaccine product administered Binding: eHDSI Vaccine (required) Additional Bindings Purpose Documentation VaccinesWhoAtcUvIps (2.0.0) Preferred For when WHO ATC code system is preferred eHDSI Vaccine Preferred For EU cross-border use Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
patient	Σ	1..1	Reference(Patient (Core))	Who was immunized
Slices for occurrence[x]	OΣ	1..1		Date of vaccination Slice: Unordered, Closed by type:$this Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Vaccine administration date
Slices for extension				Content/Rules for all slices
extension:periodOfLife		0..1	(Complex)	Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
location	O	1..1	Reference(Location (Core))	Where immunization occurred Obligations Actor SHALL:handle MyHealth@EU Handler
manufacturer	O	0..1	Reference(Organization)	Vaccine manufacturer/MAH Obligations Actor SHALL:handle MyHealth@EU Handler
lotNumber	O	0..1	string	Batch/lot number Obligations Actor SHALL:handle MyHealth@EU Handler
Slices for performer	Σ	1..*	BackboneElement	Who performed event Slice: Unordered, Open by value:$this.function
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
performer:administeringCentreOrHp	OΣ	1..*	BackboneElement	Administering centre Obligations Actor SHALL:handle MyHealth@EU Handler
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Organization (Core) | PractitionerRole (Core) | Practitioner (Core))	Individual or organization who was performing
note	OΣ	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:handle MyHealth@EU Handler
text	Σ	1..1	markdown	Additional notes about the immunization
isSubpotent	?!Σ	0..1	boolean	Dose potency
reaction	O	0..*	BackboneElement	Details of a reaction that follows immunization Obligations Actor SHALL:handle MyHealth@EU Handler
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
detail	O	0..1	Reference(Observation)	Additional information on reaction Obligations Actor SHALL:handle MyHealth@EU Handler
reported	O	0..1	boolean	Indicates self-reported reaction Obligations Actor SHALL:handle MyHealth@EU Handler
protocolApplied	O	1..*	BackboneElement	Protocol followed by the provider Obligations Actor SHALL:handle MyHealth@EU Handler
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
targetDisease	O	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: eHDSI Illness and Disorder (required) Additional Bindings Purpose Documentation eHDSI Illness and Disorder Preferred For when WHO ATC code system is preferred Obligations Actor SHALL:handle MyHealth@EU Handler
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumber[x]	O	1..1		Dose Number Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumberPositiveInt			positiveInt
doseNumberString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.vaccineCode	Base	required	eHDSI Vaccine	📦9.1.0	This IG
Immunization.performer:administeringCentreOrHp.​function	Base	extensible	Immunization Function Codes	📍4.0.1	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	required	eHDSI Illness and Disorder	📦9.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from ImmunizationMyHealthCore

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationMyHealthCore	Immunization event information
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:administeredProduct	O	1..1	R5 Immunization.administeredProduct	R5: Product that was administered (new) Obligations Actor Source SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
vaccineCode	O	1..1	CodeableConcept	Vaccine product administered Binding: eHDSI Vaccine (required) Obligations Actor Source SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
text	O	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
occurrence[x]	O	1..1	dateTime, string	Date of vaccination Obligations Actor Source SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
location	O	1..1	Reference(Location (Core))	Where immunization occurred Obligations Actor SHALL:handle MyHealth@EU Handler
manufacturer	O	0..1	Reference(Organization)	Vaccine manufacturer/MAH Obligations Actor SHALL:handle MyHealth@EU Handler
lotNumber	O	0..1	string	Batch/lot number Obligations Actor SHALL:handle MyHealth@EU Handler
performer		1..*	BackboneElement	Who performed event
Slices for performer				Content/Rules for all slices
performer:administeringCentreOrHp	O	1..*	BackboneElement	Administering centre Obligations Actor SHALL:handle MyHealth@EU Handler
note	O	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:handle MyHealth@EU Handler
reaction	O	0..*	BackboneElement	Details of a reaction that follows immunization Obligations Actor SHALL:handle MyHealth@EU Handler
detail	O	0..1	Reference(Observation)	Additional information on reaction Obligations Actor SHALL:handle MyHealth@EU Handler
reported	O	0..1	boolean	Indicates self-reported reaction Obligations Actor SHALL:handle MyHealth@EU Handler
protocolApplied	O	1..*	BackboneElement	Protocol followed by the provider Obligations Actor SHALL:handle MyHealth@EU Handler
targetDisease	O	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: eHDSI Illness and Disorder (required) Obligations Actor SHALL:handle MyHealth@EU Handler
text	O	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumber[x]	O	1..1	positiveInt, string	Dose Number Obligations Actor SHALL:handle MyHealth@EU Handler
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Immunization.vaccineCode	Base	required	eHDSI Vaccine	📦9.1.0	This IG
Immunization.protocolApplied.​targetDisease	Base	required	eHDSI Illness and Disorder	📦9.1.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationMyHealthCore	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the immunization content Binding: eHDSI Language (required)
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:administeredProduct	O	1..1	(Complex)	R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1 Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:_datatype		1..1	Extension	DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/_datatype"
value[x]		1..1	string	Value of extension Fixed Value: CodeableReference
extension:concept		0..1	Extension	R5: Reference to a concept (by class) Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"concept"
value[x]		0..1	CodeableConcept	Reference to a concept (by class)
extension:reference		0..1	Extension	Extension Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"reference"
value[x]		0..1	Reference(Medication (Core))	Reference to a resource (by instance)
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
extension:informationSource		0..1	(Complex)	R5: Indicates the source of a reported record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:_datatype		1..1	Extension	DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/_datatype"
value[x]		1..1	string	Value of extension Fixed Value: CodeableReference
extension:concept		0..1	Extension	R5: Reference to a concept (by class) Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"concept"
value[x]		0..1	CodeableConcept	Reference to a concept (by class) Binding: ImmunizationOriginCodes (preferred)
extension:reference		0..1	Extension	Extension Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"reference"
value[x]		0..1	Reference(Patient (EU core) | Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson | Organization (EU core))	Reference to a resource (by instance)
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Identifier of the immunization
status	?!Σ	1..1	code	Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason for not performing. Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	OΣ	1..1	CodeableConcept	Vaccine product administered Binding: eHDSI Vaccine (required) Additional Bindings Purpose Documentation VaccinesWhoAtcUvIps (2.0.0) Preferred For when WHO ATC code system is preferred eHDSI Vaccine Preferred For EU cross-border use Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
patient	Σ	1..1	Reference(Patient (Core))	Who was immunized
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
Slices for occurrence[x]	OΣ	1..1		Date of vaccination Slice: Unordered, Closed by type:$this Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Vaccine administration date
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:periodOfLife		0..1	(Complex)	Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
value[x]		0..1	CodeableConcept	Value of extension Binding: Periods of Life (preferred)
value		0..1	dateTime	Primitive value for dateTime
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location	O	1..1	Reference(Location (Core))	Where immunization occurred Obligations Actor SHALL:handle MyHealth@EU Handler
manufacturer	O	0..1	Reference(Organization)	Vaccine manufacturer/MAH Obligations Actor SHALL:handle MyHealth@EU Handler
lotNumber	O	0..1	string	Batch/lot number Obligations Actor SHALL:handle MyHealth@EU Handler
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: eHDSI Body Site With Exceptions (required)
route		0..1	CodeableConcept	How vaccine entered body Binding: eHDSI Route of Administration (extensible)
doseQuantity		0..1	SimpleQuantityMyHealth	Amount of vaccine administered
Slices for performer	Σ	1..*	BackboneElement	Who performed event Slice: Unordered, Open by value:$this.function
performer:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
performer:administeringCentreOrHp	OΣ	1..*	BackboneElement	Administering centre Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Organization (Core) | PractitionerRole (Core) | Practitioner (Core))	Individual or organization who was performing
note	OΣ	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
author[x]	Σ	0..1		Individual responsible for the annotation
authorReference			Reference(Practitioner | Patient | RelatedPerson | Organization)
authorString			string
time	Σ	0..1	dateTime	When the annotation was made
text	Σ	1..1	markdown	Additional notes about the immunization
reasonCode		0..*	CodeableConcept	Reasons for the administration. Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient Constraints: imm-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction	O	0..*	BackboneElement	Details of a reaction that follows immunization Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail	O	0..1	Reference(Observation)	Additional information on reaction Obligations Actor SHALL:handle MyHealth@EU Handler
reported	O	0..1	boolean	Indicates self-reported reaction Obligations Actor SHALL:handle MyHealth@EU Handler
protocolApplied	O	1..*	BackboneElement	Protocol followed by the provider Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	O	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: eHDSI Illness and Disorder (required) Additional Bindings Purpose Documentation eHDSI Illness and Disorder Preferred For when WHO ATC code system is preferred Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumber[x]	O	1..1		Dose Number Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Number of doses
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.language	Base	required	eHDSI Language	📦9.1.0	This IG
Immunization.extension:informationSource.​extension:concept.value[x]	Base	preferred	Immunization Origin Codes	📍4.0.1	FHIR Std.
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📍4.0.1	FHIR Std.
Immunization.vaccineCode	Base	required	eHDSI Vaccine	📦9.1.0	This IG
Immunization.occurrence[x]:occurrenceDateTime.​extension:periodOfLife.​value[x]	Base	preferred	Periods of Life	📦2.0.0	HL7 Europe Base and Core FHIR IG v2.0
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📍4.0.1	FHIR Std.
Immunization.site	Base	required	eHDSI Body Site With Exceptions	📦1.0.0	MyHealth@EU Core v1.0
Immunization.route	Base	extensible	eHDSI Route of Administration	📦9.1.0	This IG
Immunization.performer.​function	Base	extensible	Immunization Function Codes	📍4.0.1	FHIR Std.
Immunization.performer:administeringCentreOrHp.​function	Base	extensible	Immunization Function Codes	📍4.0.1	FHIR Std.
Immunization.reasonCode	Base	example	Immunization Reason Codes	📍4.0.1	FHIR Std.
Immunization.subpotentReason	Base	example	Immunization Subpotent Reason	📍4.0.1	FHIR Std.
Immunization.programEligibility	Base	example	Immunization Program Eligibility	📍4.0.1	FHIR Std.
Immunization.fundingSource	Base	example	Immunization Funding Source	📍4.0.1	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	required	eHDSI Illness and Disorder	📦9.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present	documentType.exists() or reference.exists()

This structure is derived from ImmunizationMyHealthCore

Summary

Mandatory: 6 elements

Maturity: 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationMyHealthCore	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:administeredProduct	O	1..1	(Complex)	R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1 Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:_datatype		1..1	Extension	DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/_datatype"
value[x]		1..1	string	Value of extension Fixed Value: CodeableReference
extension:concept		0..1	Extension	R5: Reference to a concept (by class) Constraints: ext-1
url		1..1	uri	"concept"
extension:reference		0..1	Extension	Extension Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"reference"
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
extension:informationSource		0..1	(Complex)	R5: Indicates the source of a reported record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Constraints: ext-1
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:_datatype		1..1	Extension	DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/_datatype"
value[x]		1..1	string	Value of extension Fixed Value: CodeableReference
extension:concept		0..1	Extension	R5: Reference to a concept (by class) Constraints: ext-1
url		1..1	uri	"concept"
extension:reference		0..1	Extension	Extension Constraints: ext-1
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"reference"
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
vaccineCode	OΣ	1..1	CodeableConcept	Vaccine product administered Binding: eHDSI Vaccine (required) Additional Bindings Purpose Documentation VaccinesWhoAtcUvIps (2.0.0) Preferred For when WHO ATC code system is preferred eHDSI Vaccine Preferred For EU cross-border use Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
patient	Σ	1..1	Reference(Patient (Core))	Who was immunized
Slices for occurrence[x]	OΣ	1..1		Date of vaccination Slice: Unordered, Closed by type:$this Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Vaccine administration date
Slices for extension				Content/Rules for all slices
extension:periodOfLife		0..1	(Complex)	Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
location	O	1..1	Reference(Location (Core))	Where immunization occurred Obligations Actor SHALL:handle MyHealth@EU Handler
manufacturer	O	0..1	Reference(Organization)	Vaccine manufacturer/MAH Obligations Actor SHALL:handle MyHealth@EU Handler
lotNumber	O	0..1	string	Batch/lot number Obligations Actor SHALL:handle MyHealth@EU Handler
Slices for performer	Σ	1..*	BackboneElement	Who performed event Slice: Unordered, Open by value:$this.function
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
performer:administeringCentreOrHp	OΣ	1..*	BackboneElement	Administering centre Obligations Actor SHALL:handle MyHealth@EU Handler
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Organization (Core) | PractitionerRole (Core) | Practitioner (Core))	Individual or organization who was performing
note	OΣ	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:handle MyHealth@EU Handler
text	Σ	1..1	markdown	Additional notes about the immunization
isSubpotent	?!Σ	0..1	boolean	Dose potency
reaction	O	0..*	BackboneElement	Details of a reaction that follows immunization Obligations Actor SHALL:handle MyHealth@EU Handler
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
detail	O	0..1	Reference(Observation)	Additional information on reaction Obligations Actor SHALL:handle MyHealth@EU Handler
reported	O	0..1	boolean	Indicates self-reported reaction Obligations Actor SHALL:handle MyHealth@EU Handler
protocolApplied	O	1..*	BackboneElement	Protocol followed by the provider Obligations Actor SHALL:handle MyHealth@EU Handler
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
targetDisease	O	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: eHDSI Illness and Disorder (required) Additional Bindings Purpose Documentation eHDSI Illness and Disorder Preferred For when WHO ATC code system is preferred Obligations Actor SHALL:handle MyHealth@EU Handler
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumber[x]	O	1..1		Dose Number Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumberPositiveInt			positiveInt
doseNumberString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.vaccineCode	Base	required	eHDSI Vaccine	📦9.1.0	This IG
Immunization.performer:administeringCentreOrHp.​function	Base	extensible	Immunization Function Codes	📍4.0.1	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	required	eHDSI Illness and Disorder	📦9.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from ImmunizationMyHealthCore

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationMyHealthCore	Immunization event information
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:administeredProduct	O	1..1	R5 Immunization.administeredProduct	R5: Product that was administered (new) Obligations Actor Source SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
vaccineCode	O	1..1	CodeableConcept	Vaccine product administered Binding: eHDSI Vaccine (required) Obligations Actor Source SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
text	O	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
occurrence[x]	O	1..1	dateTime, string	Date of vaccination Obligations Actor Source SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
location	O	1..1	Reference(Location (Core))	Where immunization occurred Obligations Actor SHALL:handle MyHealth@EU Handler
manufacturer	O	0..1	Reference(Organization)	Vaccine manufacturer/MAH Obligations Actor SHALL:handle MyHealth@EU Handler
lotNumber	O	0..1	string	Batch/lot number Obligations Actor SHALL:handle MyHealth@EU Handler
performer		1..*	BackboneElement	Who performed event
Slices for performer				Content/Rules for all slices
performer:administeringCentreOrHp	O	1..*	BackboneElement	Administering centre Obligations Actor SHALL:handle MyHealth@EU Handler
note	O	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:handle MyHealth@EU Handler
reaction	O	0..*	BackboneElement	Details of a reaction that follows immunization Obligations Actor SHALL:handle MyHealth@EU Handler
detail	O	0..1	Reference(Observation)	Additional information on reaction Obligations Actor SHALL:handle MyHealth@EU Handler
reported	O	0..1	boolean	Indicates self-reported reaction Obligations Actor SHALL:handle MyHealth@EU Handler
protocolApplied	O	1..*	BackboneElement	Protocol followed by the provider Obligations Actor SHALL:handle MyHealth@EU Handler
targetDisease	O	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: eHDSI Illness and Disorder (required) Obligations Actor SHALL:handle MyHealth@EU Handler
text	O	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumber[x]	O	1..1	positiveInt, string	Dose Number Obligations Actor SHALL:handle MyHealth@EU Handler
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Immunization.vaccineCode	Base	required	eHDSI Vaccine	📦9.1.0	This IG
Immunization.protocolApplied.​targetDisease	Base	required	eHDSI Illness and Disorder	📦9.1.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationMyHealthCore	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the immunization content Binding: eHDSI Language (required)
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:administeredProduct	O	1..1	(Complex)	R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1 Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:_datatype		1..1	Extension	DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/_datatype"
value[x]		1..1	string	Value of extension Fixed Value: CodeableReference
extension:concept		0..1	Extension	R5: Reference to a concept (by class) Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"concept"
value[x]		0..1	CodeableConcept	Reference to a concept (by class)
extension:reference		0..1	Extension	Extension Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"reference"
value[x]		0..1	Reference(Medication (Core))	Reference to a resource (by instance)
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
extension:informationSource		0..1	(Complex)	R5: Indicates the source of a reported record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Constraints: ext-1
extension:_datatype		1..1	Extension	DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/_datatype"
value[x]		1..1	string	Value of extension Fixed Value: CodeableReference
extension:concept		0..1	Extension	R5: Reference to a concept (by class) Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"concept"
value[x]		0..1	CodeableConcept	Reference to a concept (by class) Binding: ImmunizationOriginCodes (preferred)
extension:reference		0..1	Extension	Extension Constraints: ext-1
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url Constraints: ext-1
url		1..1	uri	"reference"
value[x]		0..1	Reference(Patient (EU core) | Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson | Organization (EU core))	Reference to a resource (by instance)
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Identifier of the immunization
status	?!Σ	1..1	code	Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason for not performing. Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	OΣ	1..1	CodeableConcept	Vaccine product administered Binding: eHDSI Vaccine (required) Additional Bindings Purpose Documentation VaccinesWhoAtcUvIps (2.0.0) Preferred For when WHO ATC code system is preferred eHDSI Vaccine Preferred For EU cross-border use Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
patient	Σ	1..1	Reference(Patient (Core))	Who was immunized
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
Slices for occurrence[x]	OΣ	1..1		Date of vaccination Slice: Unordered, Closed by type:$this Obligations Actor Source SHOULD:handle MyHealth@EU Handler from Immunization (Core) SHOULD:handle & SHALL:handle MyHealth@EU HandlerMyHealth@EU Handler from Immunization (Core)
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	Σ	0..1	dateTime	Vaccine administration date
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:periodOfLife		0..1	(Complex)	Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
value[x]		0..1	CodeableConcept	Value of extension Binding: Periods of Life (preferred)
value		0..1	dateTime	Primitive value for dateTime
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location	O	1..1	Reference(Location (Core))	Where immunization occurred Obligations Actor SHALL:handle MyHealth@EU Handler
manufacturer	O	0..1	Reference(Organization)	Vaccine manufacturer/MAH Obligations Actor SHALL:handle MyHealth@EU Handler
lotNumber	O	0..1	string	Batch/lot number Obligations Actor SHALL:handle MyHealth@EU Handler
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: eHDSI Body Site With Exceptions (required)
route		0..1	CodeableConcept	How vaccine entered body Binding: eHDSI Route of Administration (extensible)
doseQuantity		0..1	SimpleQuantityMyHealth	Amount of vaccine administered
Slices for performer	Σ	1..*	BackboneElement	Who performed event Slice: Unordered, Open by value:$this.function
performer:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
performer:administeringCentreOrHp	OΣ	1..*	BackboneElement	Administering centre Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
actor	Σ	1..1	Reference(Organization (Core) | PractitionerRole (Core) | Practitioner (Core))	Individual or organization who was performing
note	OΣ	0..*	Annotation	Additional immunization notes Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
author[x]	Σ	0..1		Individual responsible for the annotation
authorReference			Reference(Practitioner | Patient | RelatedPerson | Organization)
authorString			string
time	Σ	0..1	dateTime	When the annotation was made
text	Σ	1..1	markdown	Additional notes about the immunization
reasonCode		0..*	CodeableConcept	Reasons for the administration. Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient Constraints: imm-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction	O	0..*	BackboneElement	Details of a reaction that follows immunization Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail	O	0..1	Reference(Observation)	Additional information on reaction Obligations Actor SHALL:handle MyHealth@EU Handler
reported	O	0..1	boolean	Indicates self-reported reaction Obligations Actor SHALL:handle MyHealth@EU Handler
protocolApplied	O	1..*	BackboneElement	Protocol followed by the provider Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	O	0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: eHDSI Illness and Disorder (required) Additional Bindings Purpose Documentation eHDSI Illness and Disorder Preferred For when WHO ATC code system is preferred Obligations Actor SHALL:handle MyHealth@EU Handler
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	OΣ	0..1	string	Plain text representation of the concept Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumber[x]	O	1..1		Dose Number Obligations Actor SHALL:handle MyHealth@EU Handler
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Number of doses
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.language	Base	required	eHDSI Language	📦9.1.0	This IG
Immunization.extension:informationSource.​extension:concept.value[x]	Base	preferred	Immunization Origin Codes	📍4.0.1	FHIR Std.
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📍4.0.1	FHIR Std.
Immunization.vaccineCode	Base	required	eHDSI Vaccine	📦9.1.0	This IG
Immunization.occurrence[x]:occurrenceDateTime.​extension:periodOfLife.​value[x]	Base	preferred	Periods of Life	📦2.0.0	HL7 Europe Base and Core FHIR IG v2.0
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📍4.0.1	FHIR Std.
Immunization.site	Base	required	eHDSI Body Site With Exceptions	📦1.0.0	MyHealth@EU Core v1.0
Immunization.route	Base	extensible	eHDSI Route of Administration	📦9.1.0	This IG
Immunization.performer.​function	Base	extensible	Immunization Function Codes	📍4.0.1	FHIR Std.
Immunization.performer:administeringCentreOrHp.​function	Base	extensible	Immunization Function Codes	📍4.0.1	FHIR Std.
Immunization.reasonCode	Base	example	Immunization Reason Codes	📍4.0.1	FHIR Std.
Immunization.subpotentReason	Base	example	Immunization Subpotent Reason	📍4.0.1	FHIR Std.
Immunization.programEligibility	Base	example	Immunization Program Eligibility	📍4.0.1	FHIR Std.
Immunization.fundingSource	Base	example	Immunization Funding Source	📍4.0.1	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	required	eHDSI Illness and Disorder	📦9.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present	documentType.exists() or reference.exists()

This structure is derived from ImmunizationMyHealthCore

Summary

Mandatory: 6 elements

Maturity: 1