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

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **AIR Immunization Recommendation**

## Resource Profile: AIR Immunization Recommendation 

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

 
AIR uses this immunizationRecommendation profile to communicate the details of scheduled events. The specification for this profile is available at https://mohits.atlassian.net/wiki/spaces/NIS/pages/3507781730/AIRImmunizationRecommendation+FHIR+API+into+ImmSOT. 

 
To communicate. the details of a planned immunisation event. Planned events may be generated algorithmically based on a patient's characteristics and a published schedule or created by a health provider. 

### Introduction

The Aotearoa Immunisation Register (AIR) holds a collection of "Scheduled Events", where each Scheduled Event represents a dose of vaccine to be administered to a person in the future. As an example, when a newborn is enrolled into AIR, a Scheduled Event is created for each jab listed on the National Immunisation Schedule (see this chart https://www.health.govt.nz/our-work/immunisation-handbook-2020/national-immunisation-schedule).

This AIRImmunizationRecommendation profile is the primary vehicle used by the AIR FHIR API to transmit information about Scheduled Events.

For more information about Scheduled Events in AIR, see this page: [Scheduled Events](/input/pagecontent/scheduled-events.md)

**Usages:**

* Refer to this Profile: [Planned Activity Reference Extension](StructureDefinition-air-planned-activity-reference-extension.md)
* Examples for this Profile: [ImmunizationRecommendation/ir1](ImmunizationRecommendation-ir1.md)

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



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "air-immunization-recommendation",
  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation",
  "version" : "1.28.0-SNAPSHOT",
  "name" : "AIRImmunizationRecommendation",
  "title" : "AIR Immunization Recommendation",
  "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" : "AIR uses this immunizationRecommendation profile to communicate the details of scheduled events. The specification for this profile is available at https://mohits.atlassian.net/wiki/spaces/NIS/pages/3507781730/AIRImmunizationRecommendation+FHIR+API+into+ImmSOT.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "New Zealand"
    }]
  }],
  "purpose" : "To communicate. the details of a planned immunisation event. Planned events may be generated algorithmically based on a patient's characteristics and a published schedule or created by a health provider.",
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "workflow",
    "uri" : "http://hl7.org/fhir/workflow",
    "name" : "Workflow Pattern"
  },
  {
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "ImmunizationRecommendation",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "ImmunizationRecommendation",
      "path" : "ImmunizationRecommendation"
    },
    {
      "id" : "ImmunizationRecommendation.identifier",
      "path" : "ImmunizationRecommendation.identifier",
      "max" : "0"
    },
    {
      "id" : "ImmunizationRecommendation.patient",
      "path" : "ImmunizationRecommendation.patient",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient"]
      }]
    },
    {
      "id" : "ImmunizationRecommendation.authority",
      "path" : "ImmunizationRecommendation.authority",
      "max" : "0"
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.id",
      "path" : "ImmunizationRecommendation.recommendation.id",
      "min" : 1
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.extension",
      "path" : "ImmunizationRecommendation.recommendation.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      },
      "min" : 4
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.extension:id",
      "path" : "ImmunizationRecommendation.recommendation.extension",
      "sliceName" : "id",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state"]
      }]
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.extension:disease-covered",
      "path" : "ImmunizationRecommendation.recommendation.extension",
      "sliceName" : "disease-covered",
      "min" : 1,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered"]
      }]
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.extension:antigen-group",
      "path" : "ImmunizationRecommendation.recommendation.extension",
      "sliceName" : "antigen-group",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs"]
      }]
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.extension:air-scheduled-event",
      "path" : "ImmunizationRecommendation.recommendation.extension",
      "sliceName" : "air-scheduled-event",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"]
      }]
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.vaccineCode",
      "path" : "ImmunizationRecommendation.recommendation.vaccineCode",
      "binding" : {
        "strength" : "preferred",
        "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-vaccine-product-code"
      }
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.targetDisease",
      "path" : "ImmunizationRecommendation.recommendation.targetDisease",
      "max" : "0"
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
      "path" : "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
      "max" : "0"
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.forecastStatus",
      "path" : "ImmunizationRecommendation.recommendation.forecastStatus",
      "binding" : {
        "strength" : "preferred",
        "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-forecast-status-code"
      }
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.dateCriterion.code",
      "path" : "ImmunizationRecommendation.recommendation.dateCriterion.code",
      "binding" : {
        "strength" : "preferred",
        "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-planned-event-date-type-code"
      }
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.doseNumber[x]",
      "path" : "ImmunizationRecommendation.recommendation.doseNumber[x]",
      "type" : [{
        "code" : "positiveInt"
      }]
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.seriesDoses[x]",
      "path" : "ImmunizationRecommendation.recommendation.seriesDoses[x]",
      "max" : "0"
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.supportingImmunization",
      "path" : "ImmunizationRecommendation.recommendation.supportingImmunization",
      "max" : "0"
    },
    {
      "id" : "ImmunizationRecommendation.recommendation.supportingPatientInformation",
      "path" : "ImmunizationRecommendation.recommendation.supportingPatientInformation",
      "max" : "0"
    }]
  }
}

```
