Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build
New Zealand
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build
New Zealand
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v2.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state | Version: 2.7.0 | |||
| Active as of 2026-07-20 | Computable Name: AIRConsumerState | |||
This extension is used in AIR to communicate the current state of an AIR Patient (AKA Consumer).
Context of Use
This extension may be used on the following element(s)
Immunization
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | AIR Consumer State | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state" | |
  value[x] |
0..1 | CodeableConcept | Value of extension Binding: AIR Consumer State Code (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Consumer State | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: AIR Consumer State Code (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Consumer State | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: AIR Consumer State Code (required) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Consumer State | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: AIR Consumer State Code (required) | |
| Documentation for this format | ||||
This structure is derived from Extension
Other representations of profile: CSV, Excel, Schematron
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | required | AIR Consumer State Code | 📦2.7.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|