Update-patient-state
type: OperationDefinition
node role: treeRoot
resource.id:
  value: Update-patient-state
domain resource.text:
  narrative.status:
    value: generated
  narrative.div: Generated Narrative: OperationDefinition Update-patient-state 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.
operation definition.url:
  value: https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state
operation definition.version:
  value: 2.7.0
operation definition.name:
  value: update-patient-state
operation definition.title:
  value: Update AIR patient state
operation definition.status:
  value: active
operation definition.kind:
  value: operation
operation definition.experimental:
  value: false
operation definition.date:
  value: 2026-07-20T21:32:10+00:00
operation definition.publisher:
  value: Te Whatu Ora
operation definition.contact:
  index: 0
  contact detail.name:
    value: Te Whatu Ora
  contact detail.telecom:
    index: 0
    contact point.system:
      value: url
    contact point.value:
      value: https://tewhatuora.govt.nz
operation definition.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.
operation definition.jurisdiction:
  index: 0
  codeable concept.coding:
    index: 0
    coding.system:
      value: urn:iso:std:iso:3166
    coding.code:
      value: US
    coding.display:
      value: New Zealand
operation definition.affects state:
  value: false
operation definition.code:
  value: update-state
operation definition.resource:
  value: Patient
  index: 0
operation definition.system:
  value: false
operation definition.type:
  value: false
operation definition.instance:
  value: true
operation definition.parameter:
  index: 0
  operation definition.parameter.name:
    value: NHI
  operation definition.parameter.use:
    value: in
  operation definition.parameter.min:
    value: 1
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The logical id to identify patient/consumer.
  operation definition.parameter.type:
    value: Patient
operation definition.parameter:
  index: 1
  operation definition.parameter.name:
    value: version
  operation definition.parameter.use:
    value: in
  operation definition.parameter.min:
    value: 1
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The consumer version previously read.
  operation definition.parameter.type:
    value: Patient
operation definition.parameter:
  index: 2
  operation definition.parameter.name:
    value: state
  operation definition.parameter.use:
    value: in
  operation definition.parameter.min:
    value: 0
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The consumer state.
  operation definition.parameter.type:
    value: Patient
operation definition.parameter:
  index: 3
  operation definition.parameter.name:
    value: subStatus
  operation definition.parameter.use:
    value: in
  operation definition.parameter.min:
    value: 0
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The consumer subStatus.
  operation definition.parameter.type:
    value: Patient
operation definition.parameter:
  index: 4
  operation definition.parameter.name:
    value: version
  operation definition.parameter.use:
    value: out
  operation definition.parameter.min:
    value: 1
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The consumer version following the update.
  operation definition.parameter.type:
    value: Patient
operation definition.parameter:
  index: 5
  operation definition.parameter.name:
    value: state
  operation definition.parameter.use:
    value: out
  operation definition.parameter.min:
    value: 0
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The consumer state.
  operation definition.parameter.type:
    value: Patient
operation definition.parameter:
  index: 6
  operation definition.parameter.name:
    value: subStatus
  operation definition.parameter.use:
    value: out
  operation definition.parameter.min:
    value: 0
  operation definition.parameter.max:
    value: 1
  operation definition.parameter.documentation:
    value: The consumer subStatus.
  operation definition.parameter.type:
    value: Patient