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 Forecast Status - JSON Representation

Active as of 2026-08-05

Raw json | Download

    {
      "resourceType" : "CodeSystem",
      "id" : "air-forecast-status",
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem air-forecast-status</b></p><a name=\"air-forecast-status\"> </a><a name=\"hcair-forecast-status\"> </a><p>This case-insensitive code system <code>https://standards.digital.health.nz/ns/air-forecast-status</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td></tr><tr><td style=\"white-space:nowrap\">ACTIVE<a name=\"air-forecast-status-ACTIVE\"> </a></td><td>Active</td></tr><tr><td style=\"white-space:nowrap\">AGED_OUT<a name=\"air-forecast-status-AGED_OUT\"> </a></td><td>Aged Out</td></tr><tr><td style=\"white-space:nowrap\">CANCELLED<a name=\"air-forecast-status-CANCELLED\"> </a></td><td>Cancelled</td></tr><tr><td style=\"white-space:nowrap\">CLOSED<a name=\"air-forecast-status-CLOSED\"> </a></td><td>Closed</td></tr><tr><td style=\"white-space:nowrap\">CONTRAINDICATED<a name=\"air-forecast-status-CONTRAINDICATED\"> </a></td><td>Contraindicated</td></tr><tr><td style=\"white-space:nowrap\">DECLINED<a name=\"air-forecast-status-DECLINED\"> </a></td><td>Declined</td></tr><tr><td style=\"white-space:nowrap\">DUE<a name=\"air-forecast-status-DUE\"> </a></td><td>Due</td></tr><tr><td style=\"white-space:nowrap\">ERROR<a name=\"air-forecast-status-ERROR\"> </a></td><td>Error</td></tr><tr><td style=\"white-space:nowrap\">EXPIRED<a name=\"air-forecast-status-EXPIRED\"> </a></td><td>Expired</td></tr><tr><td style=\"white-space:nowrap\">GIVEN<a name=\"air-forecast-status-GIVEN\"> </a></td><td>Given</td></tr><tr><td style=\"white-space:nowrap\">LATE<a name=\"air-forecast-status-LATE\"> </a></td><td>Late</td></tr><tr><td style=\"white-space:nowrap\">MISSED<a name=\"air-forecast-status-MISSED\"> </a></td><td>Missed</td></tr><tr><td style=\"white-space:nowrap\">NON-SCHEDULE<a name=\"air-forecast-status-NON-SCHEDULE\"> </a></td><td>Non Scheduled</td></tr><tr><td style=\"white-space:nowrap\">NOT_REQUIRED<a name=\"air-forecast-status-NOT_REQUIRED\"> </a></td><td>Not Required</td></tr><tr><td style=\"white-space:nowrap\">OVERDUE<a name=\"air-forecast-status-OVERDUE\"> </a></td><td>Overdue</td></tr><tr><td style=\"white-space:nowrap\">PENDING<a name=\"air-forecast-status-PENDING\"> </a></td><td>Pending</td></tr><tr><td style=\"white-space:nowrap\">PLANNED<a name=\"air-forecast-status-PLANNED\"> </a></td><td>Planned</td></tr><tr><td style=\"white-space:nowrap\">REPLACED<a name=\"air-forecast-status-REPLACED\"> </a></td><td>Replaced</td></tr><tr><td style=\"white-space:nowrap\">SUPERSEDED<a name=\"air-forecast-status-SUPERSEDED\"> </a></td><td>Superseded</td></tr></table></div>"
      },
      "url" : "https://standards.digital.health.nz/ns/air-forecast-status",
      "version" : "1.27.0",
      "name" : "AIRForecastStatus",
      "title" : "AIR Forecast Status",
      "status" : "active",
      "experimental" : false,
      "date" : "2026-08-05T01:54:22+00:00",
      "publisher" : "Te Whatu Ora",
      "contact" : [
        {
          "name" : "Te Whatu Ora",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://tewhatuora.govt.nz"
            }
          ]
        }
      ],
      "description" : "This code system includes the codes used in AIR to communicate a planned event status that are not already included in http://terminology.hl7.org/CodeSystem/immunization-recommendation-status.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US",
              "display" : "New Zealand"
            }
          ]
        }
      ],
      "caseSensitive" : false,
      "content" : "complete",
      "count" : 19,
      "concept" : [
        {
          "code" : "ACTIVE",
          "display" : "Active"
        },
        {
          "code" : "AGED_OUT",
          "display" : "Aged Out"
        },
        {
          "code" : "CANCELLED",
          "display" : "Cancelled"
        },
        {
          "code" : "CLOSED",
          "display" : "Closed"
        },
        {
          "code" : "CONTRAINDICATED",
          "display" : "Contraindicated"
        },
        {
          "code" : "DECLINED",
          "display" : "Declined"
        },
        {
          "code" : "DUE",
          "display" : "Due"
        },
        {
          "code" : "ERROR",
          "display" : "Error"
        },
        {
          "code" : "EXPIRED",
          "display" : "Expired"
        },
        {
          "code" : "GIVEN",
          "display" : "Given"
        },
        {
          "code" : "LATE",
          "display" : "Late"
        },
        {
          "code" : "MISSED",
          "display" : "Missed"
        },
        {
          "code" : "NON-SCHEDULE",
          "display" : "Non Scheduled"
        },
        {
          "code" : "NOT_REQUIRED",
          "display" : "Not Required"
        },
        {
          "code" : "OVERDUE",
          "display" : "Overdue"
        },
        {
          "code" : "PENDING",
          "display" : "Pending"
        },
        {
          "code" : "PLANNED",
          "display" : "Planned"
        },
        {
          "code" : "REPLACED",
          "display" : "Replaced"
        },
        {
          "code" : "SUPERSEDED",
          "display" : "Superseded"
        }
      ]
    }