Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2)
2.2.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2) - Local Development build (v2.2.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: TEST AIR Immunization Recommendation Profile

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/test-air-immunization-recommendation Version: 2.2.0-SNAPSHOT
Active as of 2026-10-12 Computable Name: TESTAIRImmunizationRecommendation

This profile is for testing the design of the ImmunizationRecommendation profile that will be used to convey information about planned events.

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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(NZ Patient) Who this profile is for
ImmunizationRecommendation.date This element is included in summaries. 1..1 dateTime Date recommendation(s) created
ImmunizationRecommendation.authority 0..1 Reference(Organization resource for use in NZ) Who is responsible for protocol
ImmunizationRecommendation.recommendation This element is included in summaries. C 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
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.forecastStatus This element is a modifier element. This element is included in summaries. 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
ImmunizationRecommendation.patient 1..1 Reference(NZ Patient) Who this profile is for
ImmunizationRecommendation.authority 0..1 Reference(Organization resource for use in NZ) Who is responsible for protocol

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
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 BindingsPurpose
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.identifier This element is included in summaries. 0..* Identifier Business identifier
ImmunizationRecommendation.patient This element is included in summaries. 1..1 Reference(NZ Patient) Who this profile is for
ImmunizationRecommendation.date This element is included in summaries. 1..1 dateTime Date recommendation(s) created
ImmunizationRecommendation.authority 0..1 Reference(Organization resource for use in NZ) Who is responsible for protocol
ImmunizationRecommendation.recommendation This element is included in summaries. C 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
ImmunizationRecommendation.recommendation.id 0..1 string Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.extension 0..* Extension Additional content defined by implementations
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: VaccineAdministeredValueSet (example): The type of vaccine administered.
ImmunizationRecommendation.recommendation.targetDisease This element is included in summaries. 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode This element is included in summaries. 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
ImmunizationRecommendation.recommendation.forecastStatus This element is a modifier element. This element is included in summaries. 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
ImmunizationRecommendation.recommendation.forecastReason This element is included in summaries. 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
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: 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.).
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 Recommended dose number within series
ImmunizationRecommendation.recommendation.doseNumber[x].doseNumberPositiveInt positiveInt
ImmunizationRecommendation.recommendation.doseNumber[x].doseNumberString string
ImmunizationRecommendation.recommendation.seriesDoses[x] 0..1 Recommended number of doses for immunity
ImmunizationRecommendation.recommendation.seriesDoses[x].seriesDosesPositiveInt positiveInt
ImmunizationRecommendation.recommendation.seriesDoses[x].seriesDosesString string
ImmunizationRecommendation.recommendation.supportingImmunization 0..* Reference(Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation
ImmunizationRecommendation.recommendation.supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco 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 example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Recommendation Target Disease Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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(NZ Patient) Who this profile is for
ImmunizationRecommendation.date This element is included in summaries. 1..1 dateTime Date recommendation(s) created
ImmunizationRecommendation.authority 0..1 Reference(Organization resource for use in NZ) Who is responsible for protocol
ImmunizationRecommendation.recommendation This element is included in summaries. C 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
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.forecastStatus This element is a modifier element. This element is included in summaries. 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
ImmunizationRecommendation.patient 1..1 Reference(NZ Patient) Who this profile is for
ImmunizationRecommendation.authority 0..1 Reference(Organization resource for use in NZ) Who is responsible for protocol

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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 BindingsPurpose
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.identifier This element is included in summaries. 0..* Identifier Business identifier
ImmunizationRecommendation.patient This element is included in summaries. 1..1 Reference(NZ Patient) Who this profile is for
ImmunizationRecommendation.date This element is included in summaries. 1..1 dateTime Date recommendation(s) created
ImmunizationRecommendation.authority 0..1 Reference(Organization resource for use in NZ) Who is responsible for protocol
ImmunizationRecommendation.recommendation This element is included in summaries. C 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
ImmunizationRecommendation.recommendation.id 0..1 string Unique id for inter-element referencing
ImmunizationRecommendation.recommendation.extension 0..* Extension Additional content defined by implementations
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: VaccineAdministeredValueSet (example): The type of vaccine administered.
ImmunizationRecommendation.recommendation.targetDisease This element is included in summaries. 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode This element is included in summaries. 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
ImmunizationRecommendation.recommendation.forecastStatus This element is a modifier element. This element is included in summaries. 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
ImmunizationRecommendation.recommendation.forecastReason This element is included in summaries. 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
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: 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.).
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 Recommended dose number within series
ImmunizationRecommendation.recommendation.doseNumber[x].doseNumberPositiveInt positiveInt
ImmunizationRecommendation.recommendation.doseNumber[x].doseNumberString string
ImmunizationRecommendation.recommendation.seriesDoses[x] 0..1 Recommended number of doses for immunity
ImmunizationRecommendation.recommendation.seriesDoses[x].seriesDosesPositiveInt positiveInt
ImmunizationRecommendation.recommendation.seriesDoses[x].seriesDosesString string
ImmunizationRecommendation.recommendation.supportingImmunization 0..* Reference(Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation
ImmunizationRecommendation.recommendation.supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco 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 example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Recommendation Target Disease Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

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()

 

Other representations of profile: CSV, Excel, Schematron