Introduction

The Aotearoa Immunisation Register (AIR) holds a collection of "Scheduled Events", where each Scheduled Event represents a dose of vaccine to be administered to a person in the future. As an example, when a newborn is enrolled into AIR, a Scheduled Event is created for each dose listed in the National Immunisation Schedule.

This AIRImmunizationRecommendation profile is the primary vehicle used by the AIR FHIR API to transmit information about each Scheduled Event.

Each recommendation element has a AIR Planned Event Type, supplied in the AIR Scheduled Event extension:

• Consumer Planned Event - created for a Consumer to plan the delivery of an immunisation as described in an Immunisation Schedule.
• Expected Event - created when the expected delivery date for a Consumer Planned Event must change as a result of an Immunisation Event for a prior dose.

Examples of these are provided in AIRBundleCarePlanExample.

For more information about Scheduled Events in AIR, see the AIR Care Plan Profile and View Consumer Planned Events use case.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
ImmunizationRecommendation.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
ImmunizationRecommendation.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
ImmunizationRecommendation.patient	Σ This element is included in summaries.	1..1	Reference(AIR Patient Profile)	Who this profile is for
ImmunizationRecommendation.date	Σ This element is included in summaries.	1..1	dateTime	Date recommendation(s) created
ImmunizationRecommendation.recommendation	Σ This element is included in summaries. C	1..*	BackboneElement	Vaccine administration recommendations Constraints: imr-1
ImmunizationRecommendation.recommendation.id		1..1	string	Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ImmunizationRecommendation.recommendation.Slices for extension.extension:id		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
ImmunizationRecommendation.recommendation.Slices for extension.extension:disease-covered		1..*	CodeableConcept	AIR Disease Covered URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered Binding: AIR Diseases Covered (required)
ImmunizationRecommendation.recommendation.Slices for extension.extension:antigen-group		1..1	(Complex)	AIR Antigen Group Vaccination Schedule URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs
ImmunizationRecommendation.recommendation.Slices for extension.extension:air-scheduled-event		1..1	(Complex)	AIR Scheduled Event URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
ImmunizationRecommendation.recommendation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
ImmunizationRecommendation.recommendation.vaccineCode	Σ This element is included in summaries.	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: AIR Vaccine Product (preferred)
ImmunizationRecommendation.recommendation.forecastStatus	?! This element is a modifier element. Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine recommendation status Binding: AIR Forecast Status (preferred)
ImmunizationRecommendation.recommendation.forecastReason	Σ This element is included in summaries.	0..*	CodeableConcept	Vaccine recommendation indication and alternative indications Binding: AIR Indication Code (preferred)
ImmunizationRecommendation.recommendation.doseNumber[x]	Σ This element is included in summaries.	0..1	positiveInt	Recommended dose number within series
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.vaccineCode	Base	preferred	AIR Vaccine Product	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastStatus	Base	preferred	AIR Forecast Status	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastReason	Base	preferred	AIR Indication Code	📦1.29.0-SNAPSHOT	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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 ImmunizationRecommendation

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
ImmunizationRecommendation.identifier		0..0		Business identifier
ImmunizationRecommendation.patient		1..1	Reference(AIR Patient Profile)	Who this profile is for
ImmunizationRecommendation.authority		0..0		Who is responsible for protocol
ImmunizationRecommendation.recommendation
ImmunizationRecommendation.recommendation.id		1..1	string	Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ImmunizationRecommendation.recommendation.Slices for extension.extension:id		1..1	string	AIR Recommendation Id URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
ImmunizationRecommendation.recommendation.Slices for extension.extension:disease-covered		1..*	CodeableConcept	AIR Disease Covered URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered Binding: AIR Diseases Covered (required)
ImmunizationRecommendation.recommendation.Slices for extension.extension:antigen-group		1..1	(Complex)	AIR Antigen Group Vaccination Schedule URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs
ImmunizationRecommendation.recommendation.Slices for extension.extension:air-scheduled-event		1..1	(Complex)	AIR Scheduled Event URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
ImmunizationRecommendation.recommendation.vaccineCode		0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: AIR Vaccine Product (preferred)
ImmunizationRecommendation.recommendation.targetDisease		0..0		Disease to be immunized against
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode		0..0		Vaccine which is contraindicated to fulfill the recommendation
ImmunizationRecommendation.recommendation.forecastStatus		1..1	CodeableConcept	Vaccine recommendation status Binding: AIR Forecast Status (preferred)
ImmunizationRecommendation.recommendation.forecastReason		0..*	CodeableConcept	Vaccine recommendation indication and alternative indications Binding: AIR Indication Code (preferred)
ImmunizationRecommendation.recommendation.dateCriterion
ImmunizationRecommendation.recommendation.dateCriterion.code		1..1	CodeableConcept	Type of date Binding: AIR Planned Event Date Type Code (preferred)
ImmunizationRecommendation.recommendation.doseNumber[x]		0..1	positiveInt	Recommended dose number within series
ImmunizationRecommendation.recommendation.seriesDoses[x]		0..0		Recommended number of doses for immunity
ImmunizationRecommendation.recommendation.supportingImmunization		0..0		Past immunizations supporting recommendation
ImmunizationRecommendation.recommendation.supportingPatientInformation		0..0		Patient observations supporting recommendation
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.vaccineCode	Base	preferred	AIR Vaccine Product	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastStatus	Base	preferred	AIR Forecast Status	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastReason	Base	preferred	AIR Indication Code	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code	Base	preferred	AIR Planned Event Date Type Code	📦1.29.0-SNAPSHOT	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
ImmunizationRecommendation.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
ImmunizationRecommendation.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
ImmunizationRecommendation.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
ImmunizationRecommendation.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
ImmunizationRecommendation.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ImmunizationRecommendation.contained		0..*	Resource	Contained, inline Resources
ImmunizationRecommendation.extension		0..*	Extension	Additional content defined by implementations
ImmunizationRecommendation.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
ImmunizationRecommendation.patient	Σ This element is included in summaries.	1..1	Reference(AIR Patient Profile)	Who this profile is for
ImmunizationRecommendation.date	Σ This element is included in summaries.	1..1	dateTime	Date recommendation(s) created
ImmunizationRecommendation.recommendation	Σ This element is included in summaries. C	1..*	BackboneElement	Vaccine administration recommendations Constraints: imr-1
ImmunizationRecommendation.recommendation.id		1..1	string	Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ImmunizationRecommendation.recommendation.Slices for extension.extension:id		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
ImmunizationRecommendation.recommendation.Slices for extension.extension:disease-covered		1..*	CodeableConcept	AIR Disease Covered URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered Binding: AIR Diseases Covered (required)
ImmunizationRecommendation.recommendation.Slices for extension.extension:antigen-group		1..1	(Complex)	AIR Antigen Group Vaccination Schedule URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs
ImmunizationRecommendation.recommendation.Slices for extension.extension:air-scheduled-event		1..1	(Complex)	AIR Scheduled Event URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
ImmunizationRecommendation.recommendation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
ImmunizationRecommendation.recommendation.vaccineCode	Σ This element is included in summaries.	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: AIR Vaccine Product (preferred)
ImmunizationRecommendation.recommendation.forecastStatus	?! This element is a modifier element. Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine recommendation status Binding: AIR Forecast Status (preferred)
ImmunizationRecommendation.recommendation.forecastReason	Σ This element is included in summaries.	0..*	CodeableConcept	Vaccine recommendation indication and alternative indications Binding: AIR Indication Code (preferred)
ImmunizationRecommendation.recommendation.dateCriterion		0..*	BackboneElement	Dates governing proposed immunization
ImmunizationRecommendation.recommendation.dateCriterion.id		0..1	string	Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.dateCriterion.extension		0..*	Extension	Additional content defined by implementations
ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
ImmunizationRecommendation.recommendation.dateCriterion.code		1..1	CodeableConcept	Type of date Binding: AIR Planned Event Date Type Code (preferred)
ImmunizationRecommendation.recommendation.dateCriterion.value		1..1	dateTime	Recommended date
ImmunizationRecommendation.recommendation.description		0..1	string	Protocol details
ImmunizationRecommendation.recommendation.series		0..1	string	Name of vaccination series
ImmunizationRecommendation.recommendation.doseNumber[x]	Σ This element is included in summaries.	0..1	positiveInt	Recommended dose number within series
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode	Base	preferred	AIR Vaccine Product	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastStatus	Base	preferred	AIR Forecast Status	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastReason	Base	preferred	AIR Indication Code	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code	Base	preferred	AIR Planned Event Date Type Code	📦1.29.0-SNAPSHOT	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
ImmunizationRecommendation.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
ImmunizationRecommendation.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
ImmunizationRecommendation.patient	Σ This element is included in summaries.	1..1	Reference(AIR Patient Profile)	Who this profile is for
ImmunizationRecommendation.date	Σ This element is included in summaries.	1..1	dateTime	Date recommendation(s) created
ImmunizationRecommendation.recommendation	Σ This element is included in summaries. C	1..*	BackboneElement	Vaccine administration recommendations Constraints: imr-1
ImmunizationRecommendation.recommendation.id		1..1	string	Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ImmunizationRecommendation.recommendation.Slices for extension.extension:id		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
ImmunizationRecommendation.recommendation.Slices for extension.extension:disease-covered		1..*	CodeableConcept	AIR Disease Covered URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered Binding: AIR Diseases Covered (required)
ImmunizationRecommendation.recommendation.Slices for extension.extension:antigen-group		1..1	(Complex)	AIR Antigen Group Vaccination Schedule URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs
ImmunizationRecommendation.recommendation.Slices for extension.extension:air-scheduled-event		1..1	(Complex)	AIR Scheduled Event URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
ImmunizationRecommendation.recommendation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
ImmunizationRecommendation.recommendation.vaccineCode	Σ This element is included in summaries.	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: AIR Vaccine Product (preferred)
ImmunizationRecommendation.recommendation.forecastStatus	?! This element is a modifier element. Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine recommendation status Binding: AIR Forecast Status (preferred)
ImmunizationRecommendation.recommendation.forecastReason	Σ This element is included in summaries.	0..*	CodeableConcept	Vaccine recommendation indication and alternative indications Binding: AIR Indication Code (preferred)
ImmunizationRecommendation.recommendation.doseNumber[x]	Σ This element is included in summaries.	0..1	positiveInt	Recommended dose number within series
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.vaccineCode	Base	preferred	AIR Vaccine Product	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastStatus	Base	preferred	AIR Forecast Status	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastReason	Base	preferred	AIR Indication Code	📦1.29.0-SNAPSHOT	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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 ImmunizationRecommendation

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
ImmunizationRecommendation.identifier		0..0		Business identifier
ImmunizationRecommendation.patient		1..1	Reference(AIR Patient Profile)	Who this profile is for
ImmunizationRecommendation.authority		0..0		Who is responsible for protocol
ImmunizationRecommendation.recommendation
ImmunizationRecommendation.recommendation.id		1..1	string	Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ImmunizationRecommendation.recommendation.Slices for extension.extension:id		1..1	string	AIR Recommendation Id URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
ImmunizationRecommendation.recommendation.Slices for extension.extension:disease-covered		1..*	CodeableConcept	AIR Disease Covered URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered Binding: AIR Diseases Covered (required)
ImmunizationRecommendation.recommendation.Slices for extension.extension:antigen-group		1..1	(Complex)	AIR Antigen Group Vaccination Schedule URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs
ImmunizationRecommendation.recommendation.Slices for extension.extension:air-scheduled-event		1..1	(Complex)	AIR Scheduled Event URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
ImmunizationRecommendation.recommendation.vaccineCode		0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: AIR Vaccine Product (preferred)
ImmunizationRecommendation.recommendation.targetDisease		0..0		Disease to be immunized against
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode		0..0		Vaccine which is contraindicated to fulfill the recommendation
ImmunizationRecommendation.recommendation.forecastStatus		1..1	CodeableConcept	Vaccine recommendation status Binding: AIR Forecast Status (preferred)
ImmunizationRecommendation.recommendation.forecastReason		0..*	CodeableConcept	Vaccine recommendation indication and alternative indications Binding: AIR Indication Code (preferred)
ImmunizationRecommendation.recommendation.dateCriterion
ImmunizationRecommendation.recommendation.dateCriterion.code		1..1	CodeableConcept	Type of date Binding: AIR Planned Event Date Type Code (preferred)
ImmunizationRecommendation.recommendation.doseNumber[x]		0..1	positiveInt	Recommended dose number within series
ImmunizationRecommendation.recommendation.seriesDoses[x]		0..0		Recommended number of doses for immunity
ImmunizationRecommendation.recommendation.supportingImmunization		0..0		Past immunizations supporting recommendation
ImmunizationRecommendation.recommendation.supportingPatientInformation		0..0		Patient observations supporting recommendation
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​recommendation.vaccineCode	Base	preferred	AIR Vaccine Product	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastStatus	Base	preferred	AIR Forecast Status	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastReason	Base	preferred	AIR Indication Code	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code	Base	preferred	AIR Planned Event Date Type Code	📦1.29.0-SNAPSHOT	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
ImmunizationRecommendation.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
ImmunizationRecommendation.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
ImmunizationRecommendation.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
ImmunizationRecommendation.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
ImmunizationRecommendation.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ImmunizationRecommendation.contained		0..*	Resource	Contained, inline Resources
ImmunizationRecommendation.extension		0..*	Extension	Additional content defined by implementations
ImmunizationRecommendation.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
ImmunizationRecommendation.patient	Σ This element is included in summaries.	1..1	Reference(AIR Patient Profile)	Who this profile is for
ImmunizationRecommendation.date	Σ This element is included in summaries.	1..1	dateTime	Date recommendation(s) created
ImmunizationRecommendation.recommendation	Σ This element is included in summaries. C	1..*	BackboneElement	Vaccine administration recommendations Constraints: imr-1
ImmunizationRecommendation.recommendation.id		1..1	string	Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.Slices for extension		4..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ImmunizationRecommendation.recommendation.Slices for extension.extension:id		1..1	string	AIR Consumer State URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
ImmunizationRecommendation.recommendation.Slices for extension.extension:disease-covered		1..*	CodeableConcept	AIR Disease Covered URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered Binding: AIR Diseases Covered (required)
ImmunizationRecommendation.recommendation.Slices for extension.extension:antigen-group		1..1	(Complex)	AIR Antigen Group Vaccination Schedule URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs
ImmunizationRecommendation.recommendation.Slices for extension.extension:air-scheduled-event		1..1	(Complex)	AIR Scheduled Event URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event
ImmunizationRecommendation.recommendation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
ImmunizationRecommendation.recommendation.vaccineCode	Σ This element is included in summaries.	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to Binding: AIR Vaccine Product (preferred)
ImmunizationRecommendation.recommendation.forecastStatus	?! This element is a modifier element. Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine recommendation status Binding: AIR Forecast Status (preferred)
ImmunizationRecommendation.recommendation.forecastReason	Σ This element is included in summaries.	0..*	CodeableConcept	Vaccine recommendation indication and alternative indications Binding: AIR Indication Code (preferred)
ImmunizationRecommendation.recommendation.dateCriterion		0..*	BackboneElement	Dates governing proposed immunization
ImmunizationRecommendation.recommendation.dateCriterion.id		0..1	string	Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.dateCriterion.extension		0..*	Extension	Additional content defined by implementations
ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
ImmunizationRecommendation.recommendation.dateCriterion.code		1..1	CodeableConcept	Type of date Binding: AIR Planned Event Date Type Code (preferred)
ImmunizationRecommendation.recommendation.dateCriterion.value		1..1	dateTime	Recommended date
ImmunizationRecommendation.recommendation.description		0..1	string	Protocol details
ImmunizationRecommendation.recommendation.series		0..1	string	Name of vaccination series
ImmunizationRecommendation.recommendation.doseNumber[x]	Σ This element is included in summaries.	0..1	positiveInt	Recommended dose number within series
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
ImmunizationRecommendation.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode	Base	preferred	AIR Vaccine Product	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastStatus	Base	preferred	AIR Forecast Status	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.forecastReason	Base	preferred	AIR Indication Code	📦1.29.0-SNAPSHOT	This IG
ImmunizationRecommendation.​recommendation.dateCriterion.​code	Base	preferred	AIR Planned Event Date Type Code	📦1.29.0-SNAPSHOT	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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 ImmunizationRecommendation

Summary

Mandatory: 5 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

• AIR Patient Profile (https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient)

Extensions

This structure refers to these extensions:

• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs
• https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event