Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build New Zealand

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

OperationDefinition: Upsert Immunisation Event

Official URL: https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-upsert Version: 2.7.0
Active as of 2026-07-20 Computable Name: UpsertImmunisationEvent

Upsert an immunisation event based on a matching algorithm.

URL: [base]/Immunization/$upsert

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INimmunization1..1Immunization

The Immunization resource to be either updated (if an algorithmic match is found) or inserted (if no match is found) into ImmSOT.

OUTreturn0..1Immunization

The updated or created immunisation event (as an Immunization resource).

OUTfailure0..1OperationOutcome

Error response