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

## Extension: AIR Scheduled Event

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event | Version: 1.27.0
Active as of 2026-08-05 | Computable Name: AIRScheduledEvent

The extension to the AIR ImmunizationRecommendation profile is used to convey information about scheduled events, including the event type, the schedule type, the series type, and the antigen group.

Context of Use

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

- Element ID: `ImmunizationRecommendation.recommendation`

Usage info

Usages:

- Use this Extension: AIR Immunization Recommendation
- Examples for this Extension: Bundle/AIRBundleCarePlanExample and ImmunizationRecommendation/ir1

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 Scheduled Event
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:type |  | 1..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "type"
value[x] |  | 0..1 | Coding | Value of extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"
value[x] |  | 0..0 |  | Value of extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | AIR Scheduled Event
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:type |  | 1..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "type"
value[x] |  | 0..1 | Coding | Value of extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The extension to the AIR ImmunizationRecommendation profile is used to convey information about scheduled events, including the event type, the schedule type, the series type, and the antigen group.

- type: Coding: An Extension

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | AIR Scheduled Event
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:type |  | 1..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "type"
value[x] |  | 0..1 | Coding | Value of extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"
value[x] |  | 0..0 |  | Value of extension
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | AIR Scheduled Event
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:type |  | 1..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "type"
value[x] |  | 0..1 | Coding | Value of extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The extension to the AIR ImmunizationRecommendation profile is used to convey information about scheduled events, including the event type, the schedule type, the series type, and the antigen group.

- type: Coding: An Extension

Other representations of profile: CSV, Excel, Schematron

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