Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.27.0 - release New Zealand

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

Example Immunization: immunisation-update-response-message-match-quality

version: 2; Last updated: 2026-03-31 01:32:08+0000

Profile: AIR Immunization

AIR Related Person: RelatedPerson Air Test Compliance

AIR Age Given Extension

  • years: 0
  • months: 1
  • days: 14
  • daysSinceBirth: 45
  • precision: DAY

status: Completed

statusReason: Vaccination given

vaccineCode: RV1

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

occurrence: 2024-03-02 00:00:00+0000

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

lotNumber: RV1-001

expirationDate: 2026-01-31

route: Oral

Performers

-FunctionActor
*Vaccinatorhttps://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/92ZZRR

reasonCode: 6 weeks

ProtocolApplieds

-TargetDiseaseDoseNumber[x]
*Rotavirus1

Generated Narrative: RelatedPerson #45c49168-bef8-4c22-8f37-fc13ec494594

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

relationship: mother

name: Air Test Compliance

telecom: ph: 047771234(Home), ph: 0217771234(Work), air@compliance.govt.nz

address: 3E 163 Thorndon Quay Thorndon Wellington 6011 (home) (NZ Suburb: Thorndon)