Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.28.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.28.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## ValueSet: AIR Forecast Status

Official URL: https://nzhts.digital.health.nz/fhir/ValueSet/air-forecast-status-code | Version: 1.28.0-SNAPSHOT
Active as of 2026-08-04 | Computable Name: AIRForecastStatusCode

This value set includes the codes used in AIR to communicate the status of a planned event.

References

- AIR Immunization Recommendation

### Logical Definition (CLD)

This value set includes codes based on the following rules:

- Include these codes as defined in `http://terminology.hl7.org/CodeSystem/immunization-recommendation-status` version 📍2.0.0

  Code | Display | Definition
  due | Due | The patient is due (or will be due) for their next vaccination. Details on when the administration should be given can be conveyed by proposed dates in the recommendation.
  overdue | Overdue | The patient is considered overdue for their next vaccination.

- Include all codes defined in `https://standards.digital.health.nz/ns/air-forecast-status` version 📦1.28.0-SNAPSHOT

### Expansion

Expansion performed internally based on:

- codesystem Immunization Recommendation Status Codes v2.0.0 (CodeSystem)
- codesystem AIR Forecast Status v1.28.0-SNAPSHOT (CodeSystem)

This value set contains 21 concepts

System | Code | Display (en) | Definition | JSON | XML
`http://terminology.hl7.org/CodeSystem/immunization-recommendation-status` | due | Due | The patient is due (or will be due) for their next vaccination. Details on when the administration should be given can be conveyed by proposed dates in the recommendation. |  |
`http://terminology.hl7.org/CodeSystem/immunization-recommendation-status` | overdue | Overdue | The patient is considered overdue for their next vaccination. |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | ACTIVE | Active |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | AGED_OUT | Aged Out |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | CANCELLED | Cancelled |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | CLOSED | Closed |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | CONTRAINDICATED | Contraindicated |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | DECLINED | Declined |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | DUE | Due |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | ERROR | Error |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | EXPIRED | Expired |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | GIVEN | Given |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | LATE | Late |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | MISSED | Missed |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | NON-SCHEDULE | Non Scheduled |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | NOT_REQUIRED | Not Required |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | OVERDUE | Overdue |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | PENDING | Pending |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | PLANNED | Planned |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | REPLACED | Replaced |  |  |
`https://standards.digital.health.nz/ns/air-forecast-status` | SUPERSEDED | Superseded |  |  |

Explanation of the columns that may appear on this page:

Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
System | The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code | The code (used as the code in the resource instance)
Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition | An explanation of the meaning of the concept
Comments | Additional notes about how to use the code