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

## Extension: Air Immunisation Notification Action

Official URL: http://hl7.org.nz/fhir/StructureDefinition/air-immunisation-notification-action | Version: 1.28.0-SNAPSHOT
Draft as of 2026-08-04 | Computable Name: AirImmunisationNotificationAction

Indicates which parties should be notified of the event

Context of Use

This extension may be used on the following element(s)

- Element ID: `MessageHeader`

Usage info

Usages:

- Use this Extension: AIR Message Header
- Examples for this Extension: Bundle/82020190

You can also check for usages in the FHIR IG Statistics

### Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

- Differential Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Air Immunisation Notification Action
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/air-immunisation-notification-action"
value[x] |  | 0..1 | Coding | Value of extension Binding: https://standards.digital.health.nz/ns/air-immunisation-notification-action-code (required)
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Air Immunisation Notification Action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/air-immunisation-notification-action"
value[x] |  | 0..1 | Coding | Value of extension Binding: https://standards.digital.health.nz/ns/air-immunisation-notification-action-code (required)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Coding: Indicates which parties should be notified of the event

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Air Immunisation Notification Action
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/air-immunisation-notification-action"
value[x] |  | 0..1 | Coding | Value of extension Binding: https://standards.digital.health.nz/ns/air-immunisation-notification-action-code (required)
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Air Immunisation Notification Action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/air-immunisation-notification-action"
value[x] |  | 0..1 | Coding | Value of extension Binding: https://standards.digital.health.nz/ns/air-immunisation-notification-action-code (required)
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Coding: Indicates which parties should be notified of the event

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Extension.value[x] | Base | required | https://standards.digital.health.nz/ns/air-immunisation-notification-action-code | Not State | Unknown

#### Constraints

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()`