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: ImmunizationRecommendation: obligations

This profile defines how to represent Immunization Recommandations 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
ImmunizationRecommendation		0..*	ImmunizationRecommendationEuHdr	Guidance or advice relating to an immunization 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
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
patient	OΣ	1..1	Reference(Patient (EU core))	Who this profile is for ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
date	OΣ	1..1	dateTime	When recomendation was created ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
recommendation	ΣC	1..*	BackboneElement	Generic description of the vaccine/prophylaxis or its component(s) ele-1: All FHIR elements must have a @value or children imr-1: One of vaccineCode or targetDisease SHALL be present
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
vaccineCode	OΣ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to 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
targetDisease	OΣ	0..1	CodeableConcept	Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
forecastStatus	?!Σ	1..1	CodeableConcept	Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. ele-1: All FHIR elements must have a @value or children
Slices for dateCriterion		0..*	BackboneElement	Dates governing proposed immunization Slice: Unordered, Open by value:code ele-1: All FHIR elements must have a @value or children
dateCriterion: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
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). ele-1: All FHIR elements must have a @value or children
value		1..1	dateTime	Recommended date ele-1: All FHIR elements must have a @value or children
dateCriterion:nextDose	O	0..1	BackboneElement	Dates governing proposed immunization 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
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). 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://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
value		1..1	dateTime	Recommended date ele-1: All FHIR elements must have a @value or children
Slices for doseNumber[x]	Σ	0..1		Recommended dose number within series Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	OΣ	0..1	positiveInt	Dose Number ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt	O	0..1	positiveInt	Number of doses ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ImmunizationRecommendation.recommendation.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
ImmunizationRecommendation.recommendation.targetDisease	preferred	ConditionHdrVS http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	ImmunizationRecommendationDateCriterionCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.code	example	Pattern: LOINC Code 30980-7 http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ImmunizationRecommendation	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	ImmunizationRecommendation	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	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ImmunizationRecommendation	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()
imr-1	error	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendationEuHdr

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendationEuHdr	Guidance or advice relating to an immunization
patient	O	1..1	Reference(Patient (EU core))	Who this profile is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
date	O	1..1	dateTime	When recomendation was created Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
recommendation
vaccineCode	O	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
targetDisease	O	0..1	CodeableConcept	Disease or agent that the vaccination provides protection against Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Slices for dateCriterion				Content/Rules for all slices
dateCriterion:nextDose	O	0..1	BackboneElement	Dates governing proposed immunization Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Slices for doseNumber[x]				Content/Rules for all slices
doseNumber[x]:doseNumberPositiveInt	O	0..1	positiveInt	Dose Number Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for seriesDoses[x]				Content/Rules for all slices
seriesDoses[x]:seriesDosesPositiveInt	O	0..1	positiveInt	Number of doses Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendationEuHdr	Guidance or advice relating to an immunization
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
patient	OΣ	1..1	Reference(Patient (EU core))	Who this profile is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
date	OΣ	1..1	dateTime	When recomendation was created Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
authority		0..1	Reference(Organization)	Who is responsible for protocol
recommendation	ΣC	1..*	BackboneElement	Generic description of the vaccine/prophylaxis or its component(s) imr-1: One of vaccineCode or targetDisease 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
vaccineCode	OΣ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to 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
targetDisease	OΣ	0..1	CodeableConcept	Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
contraindicatedVaccineCode	Σ	0..*	CodeableConcept	Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
forecastStatus	?!Σ	1..1	CodeableConcept	Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
forecastReason	Σ	0..*	CodeableConcept	Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
Slices for dateCriterion		0..*	BackboneElement	Dates governing proposed immunization Slice: Unordered, Open by value:code
dateCriterion: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
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
value		1..1	dateTime	Recommended date
dateCriterion:nextDose	O	0..1	BackboneElement	Dates governing proposed immunization 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
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). 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://loinc.org
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
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
value		1..1	dateTime	Recommended date
description		0..1	string	Protocol details
series		0..1	string	Name of vaccination series
Slices for doseNumber[x]	Σ	0..1		Recommended dose number within series Slice: Unordered, Closed by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	OΣ	0..1	positiveInt	Dose Number Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Closed by type:$this
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt	O	0..1	positiveInt	Number of doses Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
supportingImmunization		0..*	Reference(Immunization | ImmunizationEvaluation)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(Resource)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ImmunizationRecommendation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ImmunizationRecommendation.recommendation.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
ImmunizationRecommendation.recommendation.targetDisease	preferred	ConditionHdrVS http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReason	example	ImmunizationRecommendationReasonCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-reason from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	ImmunizationRecommendationDateCriterionCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.code	example	Pattern: LOINC Code 30980-7 http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ImmunizationRecommendation	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	ImmunizationRecommendation	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	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ImmunizationRecommendation	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()
imr-1	error	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendationEuHdr

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendationEuHdr	Guidance or advice relating to an immunization 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
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
patient	OΣ	1..1	Reference(Patient (EU core))	Who this profile is for ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
date	OΣ	1..1	dateTime	When recomendation was created ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
recommendation	ΣC	1..*	BackboneElement	Generic description of the vaccine/prophylaxis or its component(s) ele-1: All FHIR elements must have a @value or children imr-1: One of vaccineCode or targetDisease SHALL be present
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
vaccineCode	OΣ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to 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
targetDisease	OΣ	0..1	CodeableConcept	Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
forecastStatus	?!Σ	1..1	CodeableConcept	Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. ele-1: All FHIR elements must have a @value or children
Slices for dateCriterion		0..*	BackboneElement	Dates governing proposed immunization Slice: Unordered, Open by value:code ele-1: All FHIR elements must have a @value or children
dateCriterion: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
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). ele-1: All FHIR elements must have a @value or children
value		1..1	dateTime	Recommended date ele-1: All FHIR elements must have a @value or children
dateCriterion:nextDose	O	0..1	BackboneElement	Dates governing proposed immunization 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
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). 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://loinc.org
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
value		1..1	dateTime	Recommended date ele-1: All FHIR elements must have a @value or children
Slices for doseNumber[x]	Σ	0..1		Recommended dose number within series Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	OΣ	0..1	positiveInt	Dose Number ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt	O	0..1	positiveInt	Number of doses ele-1: All FHIR elements must have a @value or children Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ImmunizationRecommendation.recommendation.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
ImmunizationRecommendation.recommendation.targetDisease	preferred	ConditionHdrVS http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	ImmunizationRecommendationDateCriterionCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.code	example	Pattern: LOINC Code 30980-7 http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ImmunizationRecommendation	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	ImmunizationRecommendation	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	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ImmunizationRecommendation	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()
imr-1	error	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()

Differential View

This structure is derived from ImmunizationRecommendationEuHdr

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendationEuHdr	Guidance or advice relating to an immunization
patient	O	1..1	Reference(Patient (EU core))	Who this profile is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
date	O	1..1	dateTime	When recomendation was created Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
recommendation
vaccineCode	O	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
targetDisease	O	0..1	CodeableConcept	Disease or agent that the vaccination provides protection against Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Slices for dateCriterion				Content/Rules for all slices
dateCriterion:nextDose	O	0..1	BackboneElement	Dates governing proposed immunization Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
Slices for doseNumber[x]				Content/Rules for all slices
doseNumber[x]:doseNumberPositiveInt	O	0..1	positiveInt	Dose Number Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for seriesDoses[x]				Content/Rules for all slices
seriesDoses[x]:seriesDosesPositiveInt	O	0..1	positiveInt	Number of doses Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendationEuHdr	Guidance or advice relating to an immunization
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
patient	OΣ	1..1	Reference(Patient (EU core))	Who this profile is for Obligations Actor SHALL:handle HDRConsumer SHALL:able-to-populate HDRCreator
date	OΣ	1..1	dateTime	When recomendation was created Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
authority		0..1	Reference(Organization)	Who is responsible for protocol
recommendation	ΣC	1..*	BackboneElement	Generic description of the vaccine/prophylaxis or its component(s) imr-1: One of vaccineCode or targetDisease 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
vaccineCode	OΣ	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to 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
targetDisease	OΣ	0..1	CodeableConcept	Disease or agent that the vaccination provides protection against Binding: Condition Value Set (preferred) Obligations Actor SHALL:handle HDRConsumer SHOULD:able-to-populate HDRCreator
contraindicatedVaccineCode	Σ	0..*	CodeableConcept	Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
forecastStatus	?!Σ	1..1	CodeableConcept	Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
forecastReason	Σ	0..*	CodeableConcept	Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
Slices for dateCriterion		0..*	BackboneElement	Dates governing proposed immunization Slice: Unordered, Open by value:code
dateCriterion: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
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
value		1..1	dateTime	Recommended date
dateCriterion:nextDose	O	0..1	BackboneElement	Dates governing proposed immunization 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
code		1..1	CodeableConcept	Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). 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://loinc.org
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 30980-7
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
value		1..1	dateTime	Recommended date
description		0..1	string	Protocol details
series		0..1	string	Name of vaccination series
Slices for doseNumber[x]	Σ	0..1		Recommended dose number within series Slice: Unordered, Closed by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	OΣ	0..1	positiveInt	Dose Number Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
Slices for seriesDoses[x]		0..1		Recommended number of doses for immunity Slice: Unordered, Closed by type:$this
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
seriesDoses[x]:seriesDosesPositiveInt	O	0..1	positiveInt	Number of doses Obligations Actor SHALL:handle HDRConsumer MAY:able-to-populate HDRCreator
supportingImmunization		0..*	Reference(Immunization | ImmunizationEvaluation)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(Resource)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ImmunizationRecommendation.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
ImmunizationRecommendation.recommendation.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
ImmunizationRecommendation.recommendation.targetDisease	preferred	ConditionHdrVS http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr from this IG
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReason	example	ImmunizationRecommendationReasonCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-reason from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	ImmunizationRecommendationDateCriterionCodes http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.code	example	Pattern: LOINC Code 30980-7 http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	ImmunizationRecommendation	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	ImmunizationRecommendation	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	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	ImmunizationRecommendation	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()
imr-1	error	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendationEuHdr

Summary

Other representations of profile: CSV, Excel, Schematron