# AIR CarePlan Profile - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.28.0-SNAPSHOT

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **AIR CarePlan Profile**

## Resource Profile: AIR CarePlan Profile 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/StructureDefinition/air-careplan | *Version*:1.28.0-SNAPSHOT |
| Active as of 2026-08-04 | *Computable Name*:AIRCarePlan |

 
The FHIR CarePlan resource is used as a structured representation of a consumer’s assigned immunisation schedule, supporting the coordination, tracking, and delivery of vaccinations across various antigen groups. Within the immunisation domain, each CarePlan defines a specific Antigen Group Vaccination (AGV) schedule for an individual and organizes all related vaccination activities into a coherent and accessible format. In this context, the CarePlan serves as a central framework that brings together planned immunisation events and their corresponding recorded vaccine administrations. Planned events are represented using ImmunizationRecommendation resources, indicating doses that are scheduled based on clinical guidelines and timing. When a vaccine dose is administered, the corresponding Immunization resource is linked back to the relevant planned activity in the CarePlan. This approach ensures that each vaccination event is traceable and that care delivery is aligned with national immunisation protocols. Each CarePlan acts as a living record of a consumer's immunisation journey for a particular antigen group, capturing past, present, and future planned doses. The activities within the CarePlan are typically ordered by due date, offering a clear and chronological view of the vaccination schedule. This helps healthcare providers monitor compliance, identify overdue or upcoming vaccinations, and coordinate follow-up actions. Additionally, the CarePlan supports automation and interoperability. When a consumer is onboarded into the immunisation system, relevant AGV schedules are automatically assigned, and CarePlans are created to reflect the full scope of required vaccinations.This profile on the FHIR R4 CarePlan resource adds two extensions from the R5+ CarePlan to more easily represent Immunization and ImmunizationRecommendation links, and to be better aligned with the future direction of FHIR. 

**Usages:**

* CapabilityStatements using this Profile: [AIR FHIR Server Capability Statement](CapabilityStatement-AIRCapabilityStatement.md)
* This Profile is not used by any profiles in this Specification

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

### Formal Views of Profile Content

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

 

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



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "air-careplan",
  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-careplan",
  "version" : "1.28.0-SNAPSHOT",
  "name" : "AIRCarePlan",
  "title" : "AIR CarePlan Profile",
  "status" : "active",
  "date" : "2026-08-04T03:40:16+00:00",
  "publisher" : "Te Whatu Ora",
  "contact" : [{
    "name" : "Te Whatu Ora",
    "telecom" : [{
      "system" : "url",
      "value" : "https://tewhatuora.govt.nz"
    }]
  }],
  "description" : "The FHIR CarePlan resource is used as a structured representation of a consumer’s assigned immunisation schedule, supporting the coordination, tracking, and delivery of vaccinations across various antigen groups. Within the immunisation domain, each CarePlan defines a specific Antigen Group Vaccination (AGV) schedule for an individual and organizes all related vaccination activities into a coherent and accessible format.              In this context, the CarePlan serves as a central framework that brings together planned immunisation events and their corresponding recorded vaccine administrations. Planned events are represented using ImmunizationRecommendation resources, indicating doses that are scheduled based on clinical guidelines and timing. When a vaccine dose is administered, the corresponding Immunization resource is linked back to the relevant planned activity in the CarePlan. This approach ensures that each vaccination event is traceable and that care delivery is aligned with national immunisation protocols.              Each CarePlan acts as a living record of a consumer's immunisation journey for a particular antigen group, capturing past, present, and future planned doses. The activities within the CarePlan are typically ordered by due date, offering a clear and chronological view of the vaccination schedule. This helps healthcare providers monitor compliance, identify overdue or upcoming vaccinations, and coordinate follow-up actions.              Additionally, the CarePlan supports automation and interoperability. When a consumer is onboarded into the immunisation system, relevant AGV schedules are automatically assigned, and CarePlans are created to reflect the full scope of required vaccinations.This profile on the FHIR R4 CarePlan resource adds two extensions from the R5+ CarePlan to more easily represent Immunization and ImmunizationRecommendation links, and to be better aligned with the future direction of FHIR.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "New Zealand"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "workflow",
    "uri" : "http://hl7.org/fhir/workflow",
    "name" : "Workflow Pattern"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  },
  {
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "CarePlan",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/CarePlan",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "CarePlan",
      "path" : "CarePlan"
    },
    {
      "id" : "CarePlan.id",
      "path" : "CarePlan.id",
      "min" : 1
    },
    {
      "id" : "CarePlan.identifier",
      "path" : "CarePlan.identifier",
      "max" : "0"
    },
    {
      "id" : "CarePlan.instantiatesCanonical",
      "path" : "CarePlan.instantiatesCanonical",
      "max" : "1",
      "type" : [{
        "code" : "canonical",
        "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs-plan-definition"]
      }]
    },
    {
      "id" : "CarePlan.status",
      "path" : "CarePlan.status",
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.intent",
      "path" : "CarePlan.intent",
      "mustSupport" : true
    },
    {
      "id" : "CarePlan.category",
      "path" : "CarePlan.category",
      "max" : "0"
    },
    {
      "id" : "CarePlan.subject",
      "path" : "CarePlan.subject",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient"]
      }]
    },
    {
      "id" : "CarePlan.activity",
      "path" : "CarePlan.activity",
      "max" : "1"
    },
    {
      "id" : "CarePlan.activity.extension",
      "path" : "CarePlan.activity.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      }
    },
    {
      "id" : "CarePlan.activity.extension:performedActivity",
      "path" : "CarePlan.activity.extension",
      "sliceName" : "performedActivity",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-performed-activity"]
      }]
    },
    {
      "id" : "CarePlan.activity.extension:plannedActivityReference",
      "path" : "CarePlan.activity.extension",
      "sliceName" : "plannedActivityReference",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference"]
      }]
    },
    {
      "id" : "CarePlan.activity.outcomeCodeableConcept",
      "path" : "CarePlan.activity.outcomeCodeableConcept",
      "max" : "0"
    },
    {
      "id" : "CarePlan.activity.outcomeReference",
      "path" : "CarePlan.activity.outcomeReference",
      "max" : "0"
    },
    {
      "id" : "CarePlan.activity.progress",
      "path" : "CarePlan.activity.progress",
      "max" : "0"
    },
    {
      "id" : "CarePlan.activity.reference",
      "path" : "CarePlan.activity.reference",
      "max" : "0"
    },
    {
      "id" : "CarePlan.activity.detail",
      "path" : "CarePlan.activity.detail",
      "max" : "0"
    }]
  }
}

```
