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

## : Update AIR patient state - XML Representation

Active as of 2026-08-05

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="Update-patient-state"/>
      <text>
        <status value="generated"/>
        <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>
    </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>
    </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>
    </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>
    </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>
    </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>
    </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>
    </div></td></tr></table></div>
      </text>
      <url
           value="https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state"/>
      <version value="1.27.0"/>
      <name value="update-patient-state"/>
      <title value="Update AIR patient state"/>
      <status value="active"/>
      <kind value="operation"/>
      <experimental value="false"/>
      <date value="2026-08-05T01:54:22+00:00"/>
      <publisher value="Te Whatu Ora"/>
      <contact>
        <name value="Te Whatu Ora"/>
        <telecom>
          <system value="url"/>
          <value value="https://tewhatuora.govt.nz"/>
        </telecom>
      </contact>
      <description
                   value="Update the current state of an ImmSOT Consumer.

            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.

            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 value="urn:iso:std:iso:3166"/>
          <code value="US"/>
          <display value="New Zealand"/>
        </coding>
      </jurisdiction>
      <affectsState value="false"/>
      <code value="update-state"/>
      <resource value="Patient"/>
      <system value="false"/>
      <type value="false"/>
      <instance value="true"/>
      <parameter>
        <name value="NHI"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The logical id to identify patient/consumer."/>
        <type value="Patient"/>
      </parameter>
      <parameter>
        <name value="version"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The consumer version previously read."/>
        <type value="Patient"/>
      </parameter>
      <parameter>
        <name value="state"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="The consumer state."/>
        <type value="Patient"/>
      </parameter>
      <parameter>
        <name value="subStatus"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="The consumer subStatus."/>
        <type value="Patient"/>
      </parameter>
      <parameter>
        <name value="version"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation value="The consumer version following the update."/>
        <type value="Patient"/>
      </parameter>
      <parameter>
        <name value="state"/>
        <use value="out"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="The consumer state."/>
        <type value="Patient"/>
      </parameter>
      <parameter>
        <name value="subStatus"/>
        <use value="out"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="The consumer subStatus."/>
        <type value="Patient"/>
      </parameter>
    </OperationDefinition>