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

## : AIR Consumer State - XML Representation

Active as of 2026-08-05

Raw xml | Download

    <CodeSystem xmlns="http://hl7.org/fhir">
      <id value="air-consumer-state"/>
      <text>
        <status value="generated"/>
        <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>
      </text>
      <url value="https://standards.digital.health.nz/ns/air-consumer-state"/>
      <version value="1.27.0"/>
      <name value="AirConsumerState"/>
      <title value="AIR Consumer State"/>
      <status value="active"/>
      <experimental value="false"/>
      <date value="2026-08-05T01:54:22+00:00"/>
      <publisher value="Te Whatu Ora"/>
      <contact>
        <name value="Te Whatu Ora"/>
        <telecom>
          <system value="url"/>
          <value value="https://tewhatuora.govt.nz"/>
        </telecom>
      </contact>
      <description
                   value="This is a code system for representing the current state of an AIR Patient (AKA Consumer)."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
          <display value="New Zealand"/>
        </coding>
      </jurisdiction>
      <caseSensitive value="false"/>
      <content value="complete"/>
      <count value="6"/>
      <concept>
        <code value="ACTIVE"/>
        <display value="Active"/>
        <definition value="Consumer is active."/>
      </concept>
      <concept>
        <code value="DECEASED"/>
        <display value="Deceased"/>
        <definition
                    value="Consumer is deceased and a deceased date has been confirmed with NHI."/>
      </concept>
      <concept>
        <code value="OVERSEAS"/>
        <display value="Overseas"/>
        <definition value="Consumer has been flagged as being overseas."/>
      </concept>
      <concept>
        <code value="UNCONFIRMED_DECEASED"/>
        <display value="Unconfirmed deceased"/>
        <definition
                    value="Consumer has been flagged as deceased but this has not yet been confirmed with NHI."/>
      </concept>
      <concept>
        <code value="DEACTIVATED"/>
        <display value="Deactivated"/>
        <definition value="Consumer has been deactivated."/>
      </concept>
      <concept>
        <code value="UNCONFIRMED_OVERSEAS"/>
        <display value="Unconfirmed overseas"/>
        <definition
                    value="Consumer has been flagged as being possibly overseas but this has not yet been confirmed with NHI."/>
      </concept>
    </CodeSystem>