Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build
New Zealand
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build
New Zealand
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v2.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state | Version: 2.7.0 | |||
| Active as of 2026-07-20 | 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
| 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. |