Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.1.0 - release New Zealand

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

## Extension: Planned Activity Reference Extension

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference | Version: 2.1.0
Active as of 2026-07-21 | Computable Name: AIRPlannedActivityReferenceExtension

This Planned Activity Reference adds an R5 field to the R4 CarePlan so that we can refer to an ImmunizationRecommendation.

Context of Use

This extension may be used on the following element(s)

- Element ID: `CarePlan.activity.extension`

Usage info

Usages:

- Use this Extension: AIR CarePlan Profile
- Examples for this Extension: Bundle/AIRBundleCarePlanExample

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

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

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Planned Activity Reference Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference"
value[x] |  | 0..1 | Reference(AIR Immunization Recommendation) | Value of extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Planned Activity Reference Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference"
value[x] |  | 0..1 | Reference(AIR Immunization Recommendation) | Value of extension
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Reference: This Planned Activity Reference adds an R5 field to the R4 CarePlan so that we can refer to an ImmunizationRecommendation.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Planned Activity Reference Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference"
value[x] |  | 0..1 | Reference(AIR Immunization Recommendation) | Value of extension
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Planned Activity Reference Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference"
value[x] |  | 0..1 | Reference(AIR Immunization Recommendation) | Value of extension
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Reference: This Planned Activity Reference adds an R5 field to the R4 CarePlan so that we can refer to an ImmunizationRecommendation.

Other representations of profile: CSV, Excel, Schematron

#### Constraints

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