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

## Profiles

Profiles defined in this guide

Id | Url | Description
--- | --- | ---
air-agvs-plan-definition | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs-plan-definition | Defines an immunization schedule with a series of doses, including custom extensions.
air-careplan | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-careplan | 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.
air-dose-definition | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dose-definition | Defines a dose recommendation in an immunization schedule.
air-immunization-recommendation | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation | 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.
air-immunization | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization | This is the AIR Immunization Profile, to be used for immunisation records inbound to ImmSoT. It includes a number of constraints designed to enforce ImmSoT's lean data model approach.
air-location | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location | Ths profile constrains the NZ Location Profile to meet the requirements of AIR as documented at https://mohits.atlassian.net/wiki/spaces/NIS/pages/3445141172/Immunisation+Event+Data+Fields.
air-message-header | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-message-header | This profile derived from MessageHeader implements extensions to message header required for Immunisation event messaging.
air-patient | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient | This profile derived from NZPatient implements the requirements of the Aotearoa Immunisation Register (AIR) Immunisation Source of Truth (ImmSoT).
air-practitioner | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner | This profile derived from NZPractitioner implements the requirements of the Aotearoa Immunisation Register (AIR) Immunisation Source of Truth (ImmSoT).
air-related-person-prf | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-prf | This profile of the FHIR R4 RelatedPerson resource includes only the fields used in AIR. The AIR use of this profile specifically includes the use cases covered by the NK1 segment in NIR HL7v2 messaging.
air-serology-report-profile | https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-profile | This profile on the FHIR r4 Observation resource serves to exchange serology report information in support of the legacy NIR data flow that attaches serology info to an existing immunization record and re-sends it. It is cut down substantially from the base Observation resource.
test-air-immunization-recommendation | https://standards.digital.health.nz/fhir/air/StructureDefinition/test-air-immunization-recommendation | This profile is for testing the design of the ImmunizationRecommendation profile that will be used to convey information about planned events.