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

## OperationDefinition: Update AIR patient state

Official URL: https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state | Version: 1.27.0
Active as of 2026-08-05 | Computable Name: update-patient-state

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.

URL: [base]/Patient/[id]/$update-state

### Parameters

Use | Name | Scope | Cardinality | Type | Binding | Documentation
IN | NHI |  | 1..1 | Patient |  | The logical id to identify patient/consumer.
IN | version |  | 1..1 | Patient |  | The consumer version previously read.
IN | state |  | 0..1 | Patient |  | The consumer state.
IN | subStatus |  | 0..1 | Patient |  | The consumer subStatus.
OUT | version |  | 1..1 | Patient |  | The consumer version following the update.
OUT | state |  | 0..1 | Patient |  | The consumer state.
OUT | subStatus |  | 0..1 | Patient |  | The consumer subStatus.