Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) 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: HCIM VaccinationRecommendation

This profile is one of two profile based on Vaccination as defined by the Dutch Health and Care Information models (Dutch: Zorginformatiebouwsteen or ZIB) version 3.1. This profile is also used for the Dutch Health and Care Information model PlannedCareActivityForTransfer version 3.1

The ZIB vaccinatie defines the concept DesiredDateForRevaccination. FHIR has a dedicated resources for this. To cover DesiredDateForRevaccination and to exand on the ZIB vaccination, the ImmunizationRecommendation Resource is used and profiled.

Usage:

• Examples for this Resource Profile: ImmunizationRecommendation/zib-vaccinationrecommendation-01

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ImmunizationRecommendation

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
orderStatus		0..1	(Complex)	OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus
valueCodeableConcept:valueCodeableConcept		0..1	CodeableConcept	OrderStatus Binding: OrderStatusCodelijst (extensible)
identifier		0..*	Identifier	Business identifier
patient		1..1	Reference(nl-core-patient)	Who this profile is for
recommendation
date		1..1	dateTime	DesiredDateForRevaccination
vaccineCode		0..1	CodeableConcept	ProductCode
Slices for coding		1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:productCodeGPKCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst
coding:productCodeHPKCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst
coding:productCodeZICodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst
coding:productCodeATCCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst
coding:productCodePRKCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst
coding:productCodeGTINCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst
dateCriterion		0..*	BackboneElement	StartDate / EndDate
protocol
authority		0..1	Reference(nl-core-organization)	Who is responsible for protocol
supportingImmunization		0..*	Reference(HCIM Vaccination)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(HCIM AllergyIntolerance)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ImmunizationRecommendation.extension:orderStatus.valueCodeableConcept:valueCodeableConcept	extensible	OrderStatusCodelijst
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst	extensible	ProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst	extensible	ProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst	extensible	ProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst	extensible	ProductCodeATCCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst	extensible	ProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst	extensible	ProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 from this IG

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
orderStatus		0..1	(Complex)	OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	OrderStatus Binding: OrderStatusCodelijst (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
patient	Σ	1..1	Reference(nl-core-patient)	Who this profile is for
recommendation	ΣC	1..*	BackboneElement	Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
date	Σ	1..1	dateTime	DesiredDateForRevaccination
vaccineCode	Σ	0..1	CodeableConcept	ProductCode Binding: Vaccine Administered Value Set (example): The type of vaccine administered
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:productCodeGPKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst
coding:productCodeHPKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst
coding:productCodeZICodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst
coding:productCodeATCCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst
coding:productCodePRKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst
coding:productCodeGTINCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst
forecastStatus	Σ	1..1	CodeableConcept	Vaccine administration status Binding: Immunization Recommendation Status Codes (example): The patient's status with respect to a vaccination protocol
dateCriterion		0..*	BackboneElement	StartDate / EndDate
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
code		1..1	CodeableConcept	Type of date Binding: Immunization Recommendation Date Criterion Codes (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
supportingImmunization		0..*	Reference(HCIM Vaccination)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(HCIM AllergyIntolerance)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ImmunizationRecommendation.extension:orderStatus.value[x]:valueCodeableConcept	extensible	OrderStatusCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode	example	Vaccine Administered Value Set http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst	extensible	ProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst	extensible	ProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst	extensible	ProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst	extensible	ProductCodeATCCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst	extensible	ProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst	extensible	ProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 from this IG
ImmunizationRecommendation.recommendation.forecastStatus	example	Immunization Recommendation Status Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	Immunization Recommendation Date Criterion Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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()

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	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: Common Languages (extensible): 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
orderStatus		0..1	(Complex)	OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	OrderStatus Binding: OrderStatusCodelijst (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
patient	Σ	1..1	Reference(nl-core-patient)	Who this profile is for
recommendation	ΣC	1..*	BackboneElement	Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
date	Σ	1..1	dateTime	DesiredDateForRevaccination
vaccineCode	Σ	0..1	CodeableConcept	ProductCode Binding: Vaccine Administered Value Set (example): The type of vaccine administered
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:productCodeGPKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst
coding:productCodeHPKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst
coding:productCodeZICodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst
coding:productCodeATCCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst
coding:productCodePRKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst
coding:productCodeGTINCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst
text	Σ	0..1	string	Plain text representation of the concept
targetDisease	Σ	0..1	CodeableConcept	Disease to be immunized against Binding: Immunization Recommendation Target Disease Codes (example): The disease that the recommended vaccination targets
doseNumber	Σ	0..1	positiveInt	Recommended dose number
forecastStatus	Σ	1..1	CodeableConcept	Vaccine administration status Binding: Immunization Recommendation Status Codes (example): The patient's status with respect to a vaccination protocol
dateCriterion		0..*	BackboneElement	StartDate / EndDate
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
code		1..1	CodeableConcept	Type of date Binding: Immunization Recommendation Date Criterion Codes (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
protocol		0..1	BackboneElement	Protocol used by recommendation
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
doseSequence		0..1	positiveInt	Dose number within sequence
description		0..1	string	Protocol details
authority		0..1	Reference(nl-core-organization)	Who is responsible for protocol
series		0..1	string	Name of vaccination series
supportingImmunization		0..*	Reference(HCIM Vaccination)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(HCIM AllergyIntolerance)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ImmunizationRecommendation.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
ImmunizationRecommendation.extension:orderStatus.value[x]:valueCodeableConcept	extensible	OrderStatusCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode	example	Vaccine Administered Value Set http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst	extensible	ProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst	extensible	ProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst	extensible	ProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst	extensible	ProductCodeATCCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst	extensible	ProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst	extensible	ProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 from this IG
ImmunizationRecommendation.recommendation.targetDisease	example	Immunization Recommendation Target Disease Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatus	example	Immunization Recommendation Status Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	Immunization Recommendation Date Criterion Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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 ImmunizationRecommendation

Summary

Mandatory: 0 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

• nl-core-patient (http://fhir.nl/fhir/StructureDefinition/nl-core-patient)
• nl-core-organization (http://fhir.nl/fhir/StructureDefinition/nl-core-organization)
• HCIM Vaccination (http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination)
• HCIM AllergyIntolerance (http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance)

Extensions

This structure refers to these extensions:

• http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.vaccineCode.coding

Differential View

This structure is derived from ImmunizationRecommendation

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
orderStatus		0..1	(Complex)	OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus
valueCodeableConcept:valueCodeableConcept		0..1	CodeableConcept	OrderStatus Binding: OrderStatusCodelijst (extensible)
identifier		0..*	Identifier	Business identifier
patient		1..1	Reference(nl-core-patient)	Who this profile is for
recommendation
date		1..1	dateTime	DesiredDateForRevaccination
vaccineCode		0..1	CodeableConcept	ProductCode
Slices for coding		1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:productCodeGPKCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst
coding:productCodeHPKCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst
coding:productCodeZICodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst
coding:productCodeATCCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst
coding:productCodePRKCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst
coding:productCodeGTINCodelijst		0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst
dateCriterion		0..*	BackboneElement	StartDate / EndDate
protocol
authority		0..1	Reference(nl-core-organization)	Who is responsible for protocol
supportingImmunization		0..*	Reference(HCIM Vaccination)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(HCIM AllergyIntolerance)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ImmunizationRecommendation.extension:orderStatus.valueCodeableConcept:valueCodeableConcept	extensible	OrderStatusCodelijst
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst	extensible	ProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst	extensible	ProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst	extensible	ProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst	extensible	ProductCodeATCCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst	extensible	ProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst	extensible	ProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
orderStatus		0..1	(Complex)	OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	OrderStatus Binding: OrderStatusCodelijst (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
patient	Σ	1..1	Reference(nl-core-patient)	Who this profile is for
recommendation	ΣC	1..*	BackboneElement	Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
date	Σ	1..1	dateTime	DesiredDateForRevaccination
vaccineCode	Σ	0..1	CodeableConcept	ProductCode Binding: Vaccine Administered Value Set (example): The type of vaccine administered
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:productCodeGPKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst
coding:productCodeHPKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst
coding:productCodeZICodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst
coding:productCodeATCCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst
coding:productCodePRKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst
coding:productCodeGTINCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst
forecastStatus	Σ	1..1	CodeableConcept	Vaccine administration status Binding: Immunization Recommendation Status Codes (example): The patient's status with respect to a vaccination protocol
dateCriterion		0..*	BackboneElement	StartDate / EndDate
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
code		1..1	CodeableConcept	Type of date Binding: Immunization Recommendation Date Criterion Codes (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
supportingImmunization		0..*	Reference(HCIM Vaccination)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(HCIM AllergyIntolerance)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ImmunizationRecommendation.extension:orderStatus.value[x]:valueCodeableConcept	extensible	OrderStatusCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode	example	Vaccine Administered Value Set http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst	extensible	ProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst	extensible	ProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst	extensible	ProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst	extensible	ProductCodeATCCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst	extensible	ProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst	extensible	ProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 from this IG
ImmunizationRecommendation.recommendation.forecastStatus	example	Immunization Recommendation Status Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	Immunization Recommendation Date Criterion Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	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: Common Languages (extensible): 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
orderStatus		0..1	(Complex)	OrderStatus URL: http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	OrderStatus Binding: OrderStatusCodelijst (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Business identifier
patient	Σ	1..1	Reference(nl-core-patient)	Who this profile is for
recommendation	ΣC	1..*	BackboneElement	Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
date	Σ	1..1	dateTime	DesiredDateForRevaccination
vaccineCode	Σ	0..1	CodeableConcept	ProductCode Binding: Vaccine Administered Value Set (example): The type of vaccine administered
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system
coding:productCodeGPKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst
coding:productCodeHPKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst
coding:productCodeZICodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst
coding:productCodeATCCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst
coding:productCodePRKCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst
coding:productCodeGTINCodelijst	Σ	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst
text	Σ	0..1	string	Plain text representation of the concept
targetDisease	Σ	0..1	CodeableConcept	Disease to be immunized against Binding: Immunization Recommendation Target Disease Codes (example): The disease that the recommended vaccination targets
doseNumber	Σ	0..1	positiveInt	Recommended dose number
forecastStatus	Σ	1..1	CodeableConcept	Vaccine administration status Binding: Immunization Recommendation Status Codes (example): The patient's status with respect to a vaccination protocol
dateCriterion		0..*	BackboneElement	StartDate / EndDate
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
code		1..1	CodeableConcept	Type of date Binding: Immunization Recommendation Date Criterion Codes (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
protocol		0..1	BackboneElement	Protocol used by recommendation
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
doseSequence		0..1	positiveInt	Dose number within sequence
description		0..1	string	Protocol details
authority		0..1	Reference(nl-core-organization)	Who is responsible for protocol
series		0..1	string	Name of vaccination series
supportingImmunization		0..*	Reference(HCIM Vaccination)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(HCIM AllergyIntolerance)	Patient observations supporting recommendation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ImmunizationRecommendation.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
ImmunizationRecommendation.extension:orderStatus.value[x]:valueCodeableConcept	extensible	OrderStatusCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode	example	Vaccine Administered Value Set http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst	extensible	ProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst	extensible	ProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst	extensible	ProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst	extensible	ProductCodeATCCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst	extensible	ProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000 from this IG
ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst	extensible	ProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160) http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000 from this IG
ImmunizationRecommendation.recommendation.targetDisease	example	Immunization Recommendation Target Disease Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatus	example	Immunization Recommendation Status Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-status from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.code	example	Immunization Recommendation Date Criterion Codes http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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 ImmunizationRecommendation

Summary

Mandatory: 0 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

• nl-core-patient (http://fhir.nl/fhir/StructureDefinition/nl-core-patient)
• nl-core-organization (http://fhir.nl/fhir/StructureDefinition/nl-core-organization)
• HCIM Vaccination (http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination)
• HCIM AllergyIntolerance (http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance)

Extensions

This structure refers to these extensions:

• http://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.vaccineCode.coding

Other representations of profile: CSV, Excel, Schematron