# Immunization Schedule Plan Definition - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide v1.31.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Immunization Schedule Plan Definition**

## Resource Profile: Immunization Schedule Plan Definition 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs-plan-definition | *Version*:1.31.0 |
| Active as of 2026-07-23 | *Computable Name*:AIRAGVSPlanDefinition |

 
Defines an immunization schedule with a series of doses, including custom extensions. 

**Usages:**

* Refer to this Profile: [AIR CarePlan Profile](StructureDefinition-air-careplan.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/AIR-ig|current/StructureDefinition/StructureDefinition-air-agvs-plan-definition.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-agvs-plan-definition.csv), [Excel](StructureDefinition-air-agvs-plan-definition.xlsx), [Schematron](StructureDefinition-air-agvs-plan-definition.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "air-agvs-plan-definition",
  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs-plan-definition",
  "version" : "1.31.0",
  "name" : "AIRAGVSPlanDefinition",
  "title" : "Immunization Schedule Plan Definition",
  "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" : "Defines an immunization schedule with a series of doses, including custom extensions.",
  "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" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  },
  {
    "identity" : "objimpl",
    "uri" : "http://hl7.org/fhir/object-implementation",
    "name" : "Object Implementation Information"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "PlanDefinition",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "PlanDefinition",
      "path" : "PlanDefinition"
    },
    {
      "id" : "PlanDefinition.id",
      "path" : "PlanDefinition.id",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "PlanDefinition.extension",
      "path" : "PlanDefinition.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      },
      "min" : 3
    },
    {
      "id" : "PlanDefinition.extension:schedule-type-extension",
      "path" : "PlanDefinition.extension",
      "sliceName" : "schedule-type-extension",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-schedule-type-extension"]
      }]
    },
    {
      "id" : "PlanDefinition.extension:series-type-extension",
      "path" : "PlanDefinition.extension",
      "sliceName" : "series-type-extension",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-series-type-extension"]
      }]
    },
    {
      "id" : "PlanDefinition.extension:trigger-extension",
      "path" : "PlanDefinition.extension",
      "sliceName" : "trigger-extension",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-trigger-extension"]
      }]
    },
    {
      "id" : "PlanDefinition.extension:antigen-group-extension",
      "path" : "PlanDefinition.extension",
      "sliceName" : "antigen-group-extension",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-antigen-group-extension"]
      }]
    },
    {
      "id" : "PlanDefinition.version",
      "path" : "PlanDefinition.version",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "PlanDefinition.name",
      "path" : "PlanDefinition.name",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "PlanDefinition.status",
      "path" : "PlanDefinition.status",
      "mustSupport" : true
    },
    {
      "id" : "PlanDefinition.effectivePeriod.start",
      "path" : "PlanDefinition.effectivePeriod.start",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "PlanDefinition.effectivePeriod.end",
      "path" : "PlanDefinition.effectivePeriod.end",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "PlanDefinition.action",
      "path" : "PlanDefinition.action",
      "min" : 1
    },
    {
      "id" : "PlanDefinition.action.definition[x]",
      "path" : "PlanDefinition.action.definition[x]",
      "slicing" : {
        "discriminator" : [{
          "type" : "type",
          "path" : "$this"
        }],
        "ordered" : false,
        "rules" : "open"
      },
      "min" : 1
    },
    {
      "id" : "PlanDefinition.action.definition[x]:definitionCanonical",
      "path" : "PlanDefinition.action.definition[x]",
      "sliceName" : "definitionCanonical",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "canonical",
        "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dose-definition"]
      }]
    }]
  }
}

```
