# Update AIR patient state - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.28.0-SNAPSHOT

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Update AIR patient state**

## OperationDefinition: Update AIR patient state 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state | *Version*:1.28.0-SNAPSHOT |
| Active as of 2026-08-04 | *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.

```

 



## Resource Content

```json
{
  "resourceType" : "OperationDefinition",
  "id" : "Update-patient-state",
  "url" : "https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state",
  "version" : "1.28.0-SNAPSHOT",
  "name" : "update-patient-state",
  "title" : "Update AIR patient state",
  "status" : "active",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2026-08-04T03:40:16+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"
  }]
}

```
