Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.1.0 - release New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : AIR Consumer State - JSON Representation

Active as of 2026-07-21

Raw json | Download

    {
      "resourceType" : "CodeSystem",
      "id" : "air-consumer-state",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem air-consumer-state</b></p><a name=\"air-consumer-state\"> </a><a name=\"hcair-consumer-state\"> </a><p>This case-insensitive code system <code>https://standards.digital.health.nz/ns/air-consumer-state</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">ACTIVE<a name=\"air-consumer-state-ACTIVE\"> </a></td><td>Active</td><td>Consumer is active.</td></tr><tr><td style=\"white-space:nowrap\">DECEASED<a name=\"air-consumer-state-DECEASED\"> </a></td><td>Deceased</td><td>Consumer is deceased and a deceased date has been confirmed with NHI.</td></tr><tr><td style=\"white-space:nowrap\">OVERSEAS<a name=\"air-consumer-state-OVERSEAS\"> </a></td><td>Overseas</td><td>Consumer has been flagged as being overseas.</td></tr><tr><td style=\"white-space:nowrap\">UNCONFIRMED_DECEASED<a name=\"air-consumer-state-UNCONFIRMED_DECEASED\"> </a></td><td>Unconfirmed deceased</td><td>Consumer has been flagged as deceased but this has not yet been confirmed with NHI.</td></tr><tr><td style=\"white-space:nowrap\">DEACTIVATED<a name=\"air-consumer-state-DEACTIVATED\"> </a></td><td>Deactivated</td><td>Consumer has been deactivated.</td></tr><tr><td style=\"white-space:nowrap\">UNCONFIRMED_OVERSEAS<a name=\"air-consumer-state-UNCONFIRMED_OVERSEAS\"> </a></td><td>Unconfirmed overseas</td><td>Consumer has been flagged as being possibly overseas but this has not yet been confirmed with NHI.</td></tr></table></div>"
      },
      "url" : "https://standards.digital.health.nz/ns/air-consumer-state",
      "version" : "2.1.0",
      "name" : "AirConsumerState",
      "title" : "AIR Consumer State",
      "status" : "active",
      "experimental" : false,
      "date" : "2026-07-21T20:59:11+00:00",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://tewhatuora.govt.nz"
            }
          ]
        }
      ],
      "description" : "This is a code system for representing the current state of an AIR Patient (AKA Consumer).",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "caseSensitive" : false,
      "content" : "complete",
      "count" : 6,
      "concept" : [
        {
          "code" : "ACTIVE",
          "display" : "Active",
          "definition" : "Consumer is active."
        },
        {
          "code" : "DECEASED",
          "display" : "Deceased",
          "definition" : "Consumer is deceased and a deceased date has been confirmed with NHI."
        },
        {
          "code" : "OVERSEAS",
          "display" : "Overseas",
          "definition" : "Consumer has been flagged as being overseas."
        },
        {
          "code" : "UNCONFIRMED_DECEASED",
          "display" : "Unconfirmed deceased",
          "definition" : "Consumer has been flagged as deceased but this has not yet been confirmed with NHI."
        },
        {
          "code" : "DEACTIVATED",
          "display" : "Deactivated",
          "definition" : "Consumer has been deactivated."
        },
        {
          "code" : "UNCONFIRMED_OVERSEAS",
          "display" : "Unconfirmed overseas",
          "definition" : "Consumer has been flagged as being possibly overseas but this has not yet been confirmed with NHI."
        }
      ]
    }