Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.1.0 - release New Zealand

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

## : Update AIR patient state - JSON Representation

Active as of 2026-07-21

Raw json | Download

    {
      "resourceType" : "OperationDefinition",
      "id" : "Update-patient-state",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Update-patient-state</b></p><a name=\"Update-patient-state\"> </a><a name=\"hcUpdate-patient-state\"> </a><p>URL: [base]/Patient/[id]/$update-state</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>NHI</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>The logical id to identify patient/consumer.</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>The consumer version previously read.</p>\n</div></td></tr><tr><td>IN</td><td>state</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>The consumer state.</p>\n</div></td></tr><tr><td>IN</td><td>subStatus</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>The consumer subStatus.</p>\n</div></td></tr><tr><td>OUT</td><td>version</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>The consumer version following the update.</p>\n</div></td></tr><tr><td>OUT</td><td>state</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>The consumer state.</p>\n</div></td></tr><tr><td>OUT</td><td>subStatus</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></td><td/><td><div><p>The consumer subStatus.</p>\n</div></td></tr></table></div>"
      },
      "url" : "https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state",
      "version" : "2.1.0",
      "name" : "update-patient-state",
      "title" : "Update AIR patient state",
      "status" : "active",
      "kind" : "operation",
      "experimental" : false,
      "date" : "2026-07-21T20:59:11+00:00",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://tewhatuora.govt.nz"
            }
          ]
        }
      ],
      "description" : "Update the current state of an ImmSOT Consumer.\n\n        Updates the Consumer state and/or sub status only. Input is the Consumer version previously read (used for operation optimistic locking) and the desired Consumer state.\n\n        At least one of **state** and **subStatus** must be specified. If **state** or **subStatus** is not specified, then these attributes will not be updated. Setting subStatus to null will clear the current sub status.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "affectsState" : false,
      "code" : "update-state",
      "resource" : [
        "Patient"
      ],
      "system" : false,
      "type" : false,
      "instance" : true,
      "parameter" : [
        {
          "name" : "NHI",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The logical id to identify patient/consumer.",
          "type" : "Patient"
        },
        {
          "name" : "version",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "The consumer version previously read.",
          "type" : "Patient"
        },
        {
          "name" : "state",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The consumer state.",
          "type" : "Patient"
        },
        {
          "name" : "subStatus",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "The consumer subStatus.",
          "type" : "Patient"
        },
        {
          "name" : "version",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The consumer version following the update.",
          "type" : "Patient"
        },
        {
          "name" : "state",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "The consumer state.",
          "type" : "Patient"
        },
        {
          "name" : "subStatus",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "The consumer subStatus.",
          "type" : "Patient"
        }
      ]
    }