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 Age Given Extension

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given | Version: 1.28.0-SNAPSHOT
Active as of 2026-08-04 | Computable Name: AIRAgeGiven

This extension calculates the patient age when a vaccination was administered. Although this could be calculated by the client based on patient date of birth, it is provided as a convenience.

Context of Use

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

- Element ID: `Immunization`

Usage info

Usages:

- Use this Extension: AIR Immunization
- Examples for this Extension: Bundle/72178030, Bundle/82020190, Bundle/AIRBundleCarePlanExample, Bundle/AIRBundleOrchestrationExample... Show 3 more, Immunization/imm-example-2, Immunization/immunisation-update-response-message-match-quality and Immunization/immunisation-update-response-message-meta-tag

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 Age Given Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:years |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "years"
value[x] |  | 0..1 | integer | Value of extension
extension:months |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "months"
value[x] |  | 0..1 | integer | Value of extension
extension:days |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "days"
value[x] |  | 0..1 | integer | Value of extension
extension:daysSinceBirth |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "daysSinceBirth"
value[x] |  | 0..1 | integer | Value of extension
extension:precision |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "precision"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"
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 Age Given Extension
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:years |  | 0..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 | "years"
value[x] |  | 0..1 | integer | Value of extension
extension:months |  | 0..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 | "months"
value[x] |  | 0..1 | integer | Value of extension
extension:days |  | 0..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 | "days"
value[x] |  | 0..1 | integer | Value of extension
extension:daysSinceBirth |  | 0..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 | "daysSinceBirth"
value[x] |  | 0..1 | integer | Value of extension
extension:precision |  | 0..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 | "precision"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension calculates the patient age when a vaccination was administered. Although this could be calculated by the client based on patient date of birth, it is provided as a convenience.

- years: integer: An Extension
- months: integer: An Extension
- days: integer: An Extension
- daysSinceBirth: integer: An Extension
- precision: string: An Extension

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | AIR Age Given Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:years |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "years"
value[x] |  | 0..1 | integer | Value of extension
extension:months |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "months"
value[x] |  | 0..1 | integer | Value of extension
extension:days |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "days"
value[x] |  | 0..1 | integer | Value of extension
extension:daysSinceBirth |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "daysSinceBirth"
value[x] |  | 0..1 | integer | Value of extension
extension:precision |  | 0..1 | Extension | Extension
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "precision"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"
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 Age Given Extension
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:years |  | 0..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 | "years"
value[x] |  | 0..1 | integer | Value of extension
extension:months |  | 0..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 | "months"
value[x] |  | 0..1 | integer | Value of extension
extension:days |  | 0..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 | "days"
value[x] |  | 0..1 | integer | Value of extension
extension:daysSinceBirth |  | 0..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 | "daysSinceBirth"
value[x] |  | 0..1 | integer | Value of extension
extension:precision |  | 0..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 | "precision"
value[x] |  | 0..1 | string | Value of extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension calculates the patient age when a vaccination was administered. Although this could be calculated by the client based on patient date of birth, it is provided as a convenience.

- years: integer: An Extension
- months: integer: An Extension
- days: integer: An Extension
- daysSinceBirth: integer: An Extension
- precision: string: 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()`