# Planned Activity Reference Extension - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide v1.31.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Planned Activity Reference Extension**

## Extension: Planned Activity Reference Extension 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference | *Version*:1.31.0 |
| Active as of 2026-07-23 | *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**

**Usage info**

**Usages:**

* Use this Extension: [AIR CarePlan Profile](StructureDefinition-air-careplan.md)
* Examples for this Extension: [Bundle/AIRBundleCarePlanExample](Bundle-AIRBundleCarePlanExample.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/AIR-ig|current/StructureDefinition/StructureDefinition-air-planned-activity-reference-extension.json)

### Formal Views of Extension Content

 [Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-air-planned-activity-reference-extension.csv), [Excel](StructureDefinition-air-planned-activity-reference-extension.xlsx), [Schematron](StructureDefinition-air-planned-activity-reference-extension.sch) 

#### Constraints



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "air-planned-activity-reference-extension",
  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference",
  "version" : "1.31.0",
  "name" : "AIRPlannedActivityReferenceExtension",
  "title" : "Planned Activity Reference Extension",
  "status" : "active",
  "date" : "2026-07-23T00:14:26+00:00",
  "publisher" : "Te Whatu Ora",
  "contact" : [{
    "name" : "Te Whatu Ora",
    "telecom" : [{
      "system" : "url",
      "value" : "https://tewhatuora.govt.nz"
    }]
  }],
  "description" : "This Planned Activity Reference adds an R5 field to the R4 CarePlan so that we can refer to an ImmunizationRecommendation.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "New Zealand"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "complex-type",
  "abstract" : false,
  "context" : [{
    "type" : "element",
    "expression" : "CarePlan.activity.extension"
  }],
  "type" : "Extension",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Extension",
      "path" : "Extension",
      "short" : "Planned Activity Reference Extension",
      "definition" : "This Planned Activity Reference adds an R5 field to the R4 CarePlan so that we can refer to an ImmunizationRecommendation."
    },
    {
      "id" : "Extension.extension",
      "path" : "Extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.url",
      "path" : "Extension.url",
      "fixedUri" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference"
    },
    {
      "id" : "Extension.value[x]",
      "path" : "Extension.value[x]",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation"]
      }]
    }]
  }
}

```
