Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.27.0 - release
New Zealand
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
| Official URL: https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-upsert | Version: 1.27.0 | |||
| Active as of 2026-08-05 | Computable Name: UpsertImmunisationEvent | |||
Upsert an immunisation event based on a matching algorithm.
URL: [base]/Immunization/$upsert
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | immunization | 1..1 | Immunization | The Immunization resource to be either updated (if an algorithmic match is found) or inserted (if no match is found) into ImmSOT. | ||
| OUT | return | 0..1 | Immunization | The updated or created immunisation event (as an Immunization resource). | ||
| OUT | failure | 0..1 | OperationOutcome | Error response |