# Upsert Immunisation Event - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.28.0-SNAPSHOT

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Upsert Immunisation Event**

## OperationDefinition: Upsert Immunisation Event 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-upsert | *Version*:1.28.0-SNAPSHOT |
| Active as of 2026-08-04 | *Computable Name*:UpsertImmunisationEvent |

 
Upsert an immunisation event based on a matching algorithm. 



## Resource Content

```json
{
  "resourceType" : "OperationDefinition",
  "id" : "Immunization-upsert",
  "url" : "https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-upsert",
  "version" : "1.28.0-SNAPSHOT",
  "name" : "UpsertImmunisationEvent",
  "title" : "Upsert Immunisation Event",
  "status" : "active",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2026-08-04T03:40:16+00:00",
  "publisher" : "Te Whatu Ora",
  "contact" : [{
    "name" : "Te Whatu Ora",
    "telecom" : [{
      "system" : "url",
      "value" : "https://tewhatuora.govt.nz"
    }]
  }],
  "description" : "Upsert an immunisation event based on a matching algorithm.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "New Zealand"
    }]
  }],
  "affectsState" : true,
  "code" : "upsert",
  "resource" : ["Immunization"],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [{
    "name" : "immunization",
    "use" : "in",
    "min" : 1,
    "max" : "1",
    "documentation" : "The Immunization resource to be either updated (if an algorithmic match is found) or inserted (if no match is found) into ImmSOT.",
    "type" : "Immunization"
  },
  {
    "name" : "return",
    "use" : "out",
    "min" : 0,
    "max" : "1",
    "documentation" : "The updated or created immunisation event (as an Immunization resource).",
    "type" : "Immunization"
  },
  {
    "name" : "failure",
    "use" : "out",
    "min" : 0,
    "max" : "1",
    "documentation" : "Error response",
    "type" : "OperationOutcome"
  }]
}

```
