Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2)
2.0.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2) - Local Development build (v2.0.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

History

Publication (Version) History

This table provides a list of versions of the Aotearoa Immunisation Register (AIR) FHIR Implementation Guide that are available. Only the latest version for each API version is available.
DateAPI VersionImplementation Guide VersionDescriptionLinks
2026‑07‑152 2.0.0

Latest version of the AIR API, to be used for any new integrations.

Clients access the version 2 API by sending requests to the v2 URL given in the Open API Specification.

The following changes were introduced in API version 2:

  1. Dose number in Immunization and ImmunizationRecommendation is now doseNumberString, previously doseNumberPositiveInt.
  2. The latest existing record is returned if an exact duplicate is submitted via the Create API.
    1. Given a POST to /Immunization (Create operation), when AIR detects an exact duplicate of the record submitted, then no change is made and AIR returns HTTP status code 201. The Immunization resource in the response contains the AIR Identifier (Immunization.id) of the most recent existing record and contains a meta tag that indicates what has occurred.
    2. Previously, the status in the response was entered-in-error with HTTP status code 200.
api‑v2 Home
download api‑v2 FHIR IG
openapi spec
2026‑07‑1511.28.0

Latest version of the original AIR API.

Clients access the v1 API by sending requests to the v1 URL given in the Open API Specification.

 api‑v1 Home
download api‑v1 FHIR IG
openapi spec

Implementation Guide version history

To view previous versions of the Implementation Guide or its artifacts, please review the version history.

Previous versions