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

## Example Bundle: AIRBundleCarePlanExample

Bundle AIRBundleCarePlanExample of type searchset

Entry 1 - fullUrl = https://localhost:8443/fhir/R4/CarePlan/AGVS-Delay-3-6M-P-PCV13-1.0

Resource CarePlan:

> instantiatesCanonical: https://localhost:8443/fhir/R4/AIRAGVSPlanDefinition/Delay-3-6M-P-PCV13-1.0

> status: Active

> intent: Plan

> title: PCV13 Immunisation Schedule for NHI ZET7992

> description: PCV13

> subject: https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZET7992

> period: 2023-11-11 13:00:00+1300 --> (ongoing)

> created: 2023-12-30 13:00:00+1300

> > activity

> > Planned Activity Reference Extension: ImmunizationRecommendation: date = 2025-08-05 17:00:56+1200

> > activity

> > Performed Activity Extension:

> Exception Generating Narrative: Cannot invoke "org.hl7.fhir.r5.renderers.utils.ResourceWrapper.fhirType()" because "resource" is null

Entry 2 - fullUrl = https://localhost:8443/fhir/R4/ImmunizationRecommendation/AGVS-Delay-3-6M-P-PCV13-1.0-Dose1

Resource ImmunizationRecommendation:

> Profile: AIR Immunization Recommendation

> patient: Patient/ZET7992

> date: 2025-08-05 17:00:56+1200

> > recommendation

> > > id

> > > 8d133802-f22f-49f8-9a38-565c494a7630

> > > AIR Scheduled Event

> > > - type: AIR Planned Event Type: CPE (Consumer Planned Event)

> > > AIR Antigen Group Vaccination Schedule

> > > - schedule-type: AIR AGVS: DELAYED (Delayed)
> > > - series-type: AIR AGVS Series Type: PRIMARY (Primary)
> > > - antigen-group: SNOMED CT: 1119254000 (PCV13)
> > > - version: 1.0

> > vaccineCode: PCV13

> > forecastStatus: Given

> > forecastReason: Funded, if not otherwise specified

> > ### DateCriterions

> > - | Code | Value
> > * | Date immunization due | 2024-01-27

> > series: Delay 3-6M_P_PCV13_1.0

Entry 3 - fullUrl = https://localhost:8443/fhir/R4/ImmunizationRecommendation/AGVS-Delay-3-6M-P-PCV13-1.0-Dose2

Resource ImmunizationRecommendation:

> Profile: AIR Immunization Recommendation

> patient: Patient/ZET7992

> date: 2025-08-05 17:00:56+1200

> > recommendation

> > > id

> > > 21cdd4fc-8fad-417f-aa36-e2916a77ce4c

> > > AIR Scheduled Event

> > > - type: AIR Planned Event Type: CPE (Consumer Planned Event)

> > > AIR Antigen Group Vaccination Schedule

> > > - schedule-type: AIR AGVS: DELAYED (Delayed)
> > > - series-type: AIR AGVS Series Type: PRIMARY (Primary)
> > > - antigen-group: SNOMED CT: 1119254000 (PCV13)
> > > - version: 1.0

> > vaccineCode: PCV13

> > forecastStatus: Overdue

> > forecastReason: Funded, if not otherwise specified

> > ### DateCriterions

> > - | Code | Value
> > * | Date immunization due | 2024-03-23

> > series: Delay 3-6M_P_PCV13_1.0

> > recommendation

> > > id

> > > bf16e22b-a03a-4b3f-8d29-7d0c9b747f9f

> > > AIR Scheduled Event

> > > - type: AIR Planned Event Type: EE (Expected Event)

> > > AIR Antigen Group Vaccination Schedule

> > > - schedule-type: AIR AGVS: DELAYED (Delayed)
> > > - series-type: AIR AGVS Series Type: PRIMARY (Primary)
> > > - antigen-group: SNOMED CT: 1119254000 (PCV13)
> > > - version: 1.0

> > vaccineCode: PCV13

> > forecastStatus: Active

> > forecastReason: Funded, if not otherwise specified

> > ### DateCriterions

> > - | Code | Value
> > * | Date immunization due | 2024-03-25

> > series: Delay 3-6M_P_PCV13_1.0

Entry 4 - fullUrl = https://localhost:8443/fhir/R4/Immunization/63e060f0-a878-4a8c-a432-6712d15b1266

Resource Immunization:

> version: 1; Last updated: 2025-08-04 15:12:41+1200

> Profile: AIR Immunization

> > Immunization Diluent

> > - diluentLotNumber: 33332222
> > - diluentExpiryDate: 2026-01-01

> AIR Related Person: 09c86dd5-64e9-414e-b97e-f6c2c1a4e65f

> AIR Serology Report Extension: 045e4457-4b8d-4ae7-bbef-655f48576558

> > AIR Age Given Extension

> > - years: 0
> > - months: 3
> > - days: 30
> > - daysSinceBirth: 121
> > - precision: DAY

> Immunization Facility Mobile Site: FZZ835-E_MOB0001

> AIR Administered Product Extension: M-M-R-II

> status: Completed

> statusReason: Vaccination given

> vaccineCode: PCV

> lotNumber: 555123

> expirationDate: 2027-01-31

> patient: https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZET7992

> occurrence: 2024-01-30

> location: https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E

> site: Structure of left deltoid muscle

> route: Intramuscular

> ### Performers

> - | Function | Actor
> * | Vaccinator | https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/477616

> ### ProtocolApplieds

> - | TargetDisease
> * | Pneumococcal

> > Profile: AIR Related Person Profile

> > patient: https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZET7992

> > relationship: father

> > name: John Jon Doe

> > telecom: ph: 041234567(Home), ph: 091234567(Work), jodoe@moh.govt.nz

> > address: 123 Main St Neverland Wellington 6001 (home) (NZ Suburb: Johnsonville)

> > status: Preliminary

> > code: Hepatitis B status

> > effective: 2023-01-01 14:12:34+1300

> > interpretation: Indeterminate