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-nir-opt-off | Version: 2.7.0 | |||
| Active as of 2026-07-20 | Computable Name: AIRConsumerNIROptOff | |||
This extension is used in AIR to indicate the Air Patient (AKA Consumer) as having opted off NIR before they were migrated into AIR. Presence of this extension on the AIR Patient indicates that the consumer has opted off NIR and the extension includes the date that the consumer requested this to occur.
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 NIR Opt Off | |
  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-nir-opt-off" | |
 value[x] |
1..1 | date | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type date: This extension is used in AIR to indicate the Air Patient (AKA Consumer) as having opted off NIR before they were migrated into AIR. Presence of this extension on the AIR Patient indicates that the consumer has opted off NIR and the extension includes the date that the consumer requested this to occur.
Differential View
This structure is derived from Extension
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | AIR Consumer NIR Opt Off | |
| 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-nir-opt-off" | |
| value[x] |
1..1 | date | Value of extension | |
| Documentation for this format | ||||
This structure is derived from Extension
Summary
Simple Extension with the type date: This extension is used in AIR to indicate the Air Patient (AKA Consumer) as having opted off NIR before they were migrated into AIR. Presence of this extension on the AIR Patient indicates that the consumer has opted off NIR and the extension includes the date that the consumer requested this to occur.
Other representations of profile: CSV, Excel, Schematron
| 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()
|