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

## : Bulk Update Immunisation Event - JSON Representation

Active as of 2026-08-05

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "Immunization-bulk-update",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Immunization-bulk-update</b></p><a name=\"Immunization-bulk-update\"> </a><a name=\"hcImmunization-bulk-update\"> </a><p>URL: [base]/Immunization/$bulk-update</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>create</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/immunization.html\">Immunization</a></td><td/><td><div><p>An Immunization resource to be created.</p>\n</div></td></tr><tr><td>IN</td><td>upsert</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/immunization.html\">Immunization</a></td><td/><td><div><p>An Immunization resource to be either updated (if an algorithmic match is found) or inserted (if no match is found) into ImmSOT.</p>\n</div></td></tr><tr><td>OUT</td><td>created</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/immunization.html\">Immunization</a></td><td/><td><div><p>The created immunisation event (as an Immunization resource).</p>\n</div></td></tr><tr><td>OUT</td><td>updated</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/immunization.html\">Immunization</a></td><td/><td><div><p>The updated immunisation event (as an Immunization resource).</p>\n</div></td></tr><tr><td>OUT</td><td>failure</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>Error response</p>\n</div></td></tr></table></div>"
      },
      "url" : "https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-bulk-update",
      "version" : "1.27.0",
      "name" : "BulkUpdateImmunisationEvent",
      "title" : "Bulk Update Immunisation Event",
      "status" : "active",
      "kind" : "operation",
      "experimental" : false,
      "date" : "2026-08-05T01:54:22+00:00",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://tewhatuora.govt.nz"
            }
          ]
        }
      ],
      "description" : "This operation performs a bulk insert and/or update of immunisation events.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "affectsState" : true,
      "code" : "bulk-update",
      "resource" : [
        "Immunization"
      ],
      "system" : false,
      "type" : true,
      "instance" : false,
      "parameter" : [
        {
          "name" : "create",
          "use" : "in",
          "min" : 0,
          "max" : "*",
          "documentation" : "An Immunization resource to be created.",
          "type" : "Immunization"
        },
        {
          "name" : "upsert",
          "use" : "in",
          "min" : 0,
          "max" : "*",
          "documentation" : "An Immunization resource to be either updated (if an algorithmic match is found) or inserted (if no match is found) into ImmSOT.",
          "type" : "Immunization"
        },
        {
          "name" : "created",
          "use" : "out",
          "min" : 0,
          "max" : "*",
          "documentation" : "The created immunisation event (as an Immunization resource).",
          "type" : "Immunization"
        },
        {
          "name" : "updated",
          "use" : "out",
          "min" : 0,
          "max" : "*",
          "documentation" : "The updated immunisation event (as an Immunization resource).",
          "type" : "Immunization"
        },
        {
          "name" : "failure",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "Error response",
          "type" : "OperationOutcome"
        }
      ]
    }