HL7 Europe Hospital Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/hdr/ and changes regularly. See the Directory of published versions

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

Resource Profile: Immunization: obligations

This profile defines obligations for the Immunization resource for the purpose of this guide.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

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
Immunization		0..*	ImmunizationEuHdr	Immunization event information This profile also imposes the profile Immunization (IPS) (2.0.0) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:basedOn		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x]		1..1	Reference(ImmunizationRecommendation (HDR))	Value of extension ele-1: All FHIR elements must have a @value or children
extension:administeredProduct	O	0..1	(Complex)	Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for extension				Content/Rules for all slices
extension:concept		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"concept"
extension:reference		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"reference"
url		1..1	uri	"http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
vaccineCode	OΣ	1..1	CodeableConcept	Vaccine product administered Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
patient	OΣ	1..1	Reference(Patient (EU core))	Who was immunized ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
occurrence[x]	OΣ	1..1	dateTime	Vaccine administration date ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Slices for performer	Σ	0..*	BackboneElement	Who performed event Slice: Unordered, Open by value:$this.function ele-1: All FHIR elements must have a @value or children
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
performer:administeringCentre	OΣ	0..*	BackboneElement	Administering centre ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
actor	Σ	1..1	Reference(Organization (EU core))	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
performer:administeringHp	OΣ	0..*	BackboneElement	Administering Health Professional ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
actor	Σ	1..1	Reference(PractitionerRole (EU core) | Practitioner (EU core))	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
isSubpotent	?!Σ	0..1	boolean	Dose potency ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.performer:administeringCentre.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:administeringHp.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 ImmunizationEuHdr

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationEuHdr	Immunization event information This profile also imposes the profile Immunization (IPS) (2.0.0)
Slices for extension				Content/Rules for all slices
extension:administeredProduct	O	0..1	ImmunizationAdministeredProduct	Immunization AdministeredProduct Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
vaccineCode	O	1..1	CodeableConcept	Vaccine product administered Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
patient	O	1..1	Reference(Patient (EU core))	Who was immunized Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
occurrence[x]	O	1..1	dateTime	Vaccine administration date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Slices for performer				Content/Rules for all slices
performer:administeringCentre	O	0..*	BackboneElement	Administering centre Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
performer:administeringHp	O	0..*	BackboneElement	Administering Health Professional Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
protocolApplied
targetDisease	O	0..*	CodeableConcept	Vaccine preventatable disease being targetted Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationEuHdr	Immunization event information This profile also imposes the profile Immunization (IPS) (2.0.0)
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 resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:basedOn		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x]		1..1	Reference(ImmunizationRecommendation (HDR))	Value of extension
extension:administeredProduct	O	0..1	(Complex)	Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:concept		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"concept"
value[x]		0..1	CodeableConcept	Value of extension
extension:reference		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"reference"
value[x]		0..1	Reference(Medication (HDR))	Value of extension
url		1..1	uri	"http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	OΣ	1..1	CodeableConcept	Vaccine product administered Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
patient	OΣ	1..1	Reference(Patient (EU core))	Who was immunized Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	OΣ	1..1	dateTime	Vaccine administration date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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		0..1	Reference(Location (EU base))	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer/MAH
lotNumber		0..1	string	Batch/lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
Slices for performer	Σ	0..*	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:administeringCentre	OΣ	0..*	BackboneElement	Administering centre Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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 (EU core))	Individual or organization who was performing
performer:administeringHp	OΣ	0..*	BackboneElement	Administering Health Professional Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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(PractitionerRole (EU core) | Practitioner (EU core))	Individual or organization who was performing
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred 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 imm-1: One of documentType or reference SHALL be present
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		0..*	BackboneElement	Details of a reaction that follows immunization
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		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
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: Condition Value Set (preferred) Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt		0..1	positiveInt	Dose Number
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt		0..1	positiveInt	Number of doses
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:administeringCentre.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:administeringHp.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	ConditionHdrVS http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 ImmunizationEuHdr

Summary

Maturity: 0

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationEuHdr	Immunization event information This profile also imposes the profile Immunization (IPS) (2.0.0) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:basedOn		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x]		1..1	Reference(ImmunizationRecommendation (HDR))	Value of extension ele-1: All FHIR elements must have a @value or children
extension:administeredProduct	O	0..1	(Complex)	Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for extension				Content/Rules for all slices
extension:concept		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"concept"
extension:reference		0..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"reference"
url		1..1	uri	"http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children
vaccineCode	OΣ	1..1	CodeableConcept	Vaccine product administered Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
patient	OΣ	1..1	Reference(Patient (EU core))	Who was immunized ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
occurrence[x]	OΣ	1..1	dateTime	Vaccine administration date ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Slices for performer	Σ	0..*	BackboneElement	Who performed event Slice: Unordered, Open by value:$this.function ele-1: All FHIR elements must have a @value or children
performer:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
performer:administeringCentre	OΣ	0..*	BackboneElement	Administering centre ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
actor	Σ	1..1	Reference(Organization (EU core))	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
performer:administeringHp	OΣ	0..*	BackboneElement	Administering Health Professional ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code		1..1	code	Symbol in syntax defined by the system Fixed Value: AP
actor	Σ	1..1	Reference(PractitionerRole (EU core) | Practitioner (EU core))	Individual or organization who was performing ele-1: All FHIR elements must have a @value or children
isSubpotent	?!Σ	0..1	boolean	Dose potency ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.performer:administeringCentre.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:administeringHp.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 ImmunizationEuHdr

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationEuHdr	Immunization event information This profile also imposes the profile Immunization (IPS) (2.0.0)
Slices for extension				Content/Rules for all slices
extension:administeredProduct	O	0..1	ImmunizationAdministeredProduct	Immunization AdministeredProduct Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
vaccineCode	O	1..1	CodeableConcept	Vaccine product administered Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
patient	O	1..1	Reference(Patient (EU core))	Who was immunized Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
occurrence[x]	O	1..1	dateTime	Vaccine administration date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Slices for performer				Content/Rules for all slices
performer:administeringCentre	O	0..*	BackboneElement	Administering centre Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
performer:administeringHp	O	0..*	BackboneElement	Administering Health Professional Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
protocolApplied
targetDisease	O	0..*	CodeableConcept	Vaccine preventatable disease being targetted Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationEuHdr	Immunization event information This profile also imposes the profile Immunization (IPS) (2.0.0)
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 resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:basedOn		0..1	(Complex)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x]		1..1	Reference(ImmunizationRecommendation (HDR))	Value of extension
extension:administeredProduct	O	0..1	(Complex)	Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:concept		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"concept"
value[x]		0..1	CodeableConcept	Value of extension
extension:reference		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"reference"
value[x]		0..1	Reference(Medication (HDR))	Value of extension
url		1..1	uri	"http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	OΣ	1..1	CodeableConcept	Vaccine product administered Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
patient	OΣ	1..1	Reference(Patient (EU core))	Who was immunized Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	OΣ	1..1	dateTime	Vaccine administration date Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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		0..1	Reference(Location (EU base))	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer/MAH
lotNumber		0..1	string	Batch/lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
Slices for performer	Σ	0..*	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:administeringCentre	OΣ	0..*	BackboneElement	Administering centre Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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 (EU core))	Individual or organization who was performing
performer:administeringHp	OΣ	0..*	BackboneElement	Administering Health Professional Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
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(PractitionerRole (EU core) | Practitioner (EU core))	Individual or organization who was performing
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred 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 imm-1: One of documentType or reference SHALL be present
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		0..*	BackboneElement	Details of a reaction that follows immunization
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		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
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: Condition Value Set (preferred) Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt		0..1	positiveInt	Dose Number
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt		0..1	positiveInt	Number of doses
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:administeringCentre.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer:administeringHp.function	extensible	Pattern: AP http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	ConditionHdrVS http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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 ImmunizationEuHdr

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron