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 Related Person

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-extension | Version: 1.28.0-SNAPSHOT
Active as of 2026-08-04 | Computable Name: AIRRelatedPersonExt

This extension is to be used for communicating related person info in an AIR Immunisation Event. It holds the information transmitted in the HL7v2 NK1 segment.

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/AIRBundleCarePlanExample and Immunization/immunisation-update-response-message-match-quality

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 Related Person
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-extension"
value[x] |  | 0..1 | Reference(AIR Related Person Profile) | Value of extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | AIR Related Person
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-related-person-extension"
value[x] |  | 0..1 | Reference(AIR Related Person Profile) | Value of extension
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Reference: This extension is to be used for communicating related person info in an AIR Immunisation Event. It holds the information transmitted in the HL7v2 NK1 segment.

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | AIR Related Person
extension |  | 0..0 |  | Extension
url |  | 1..1 | uri | "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-extension"
value[x] |  | 0..1 | Reference(AIR Related Person Profile) | Value of extension
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | AIR Related Person
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-related-person-extension"
value[x] |  | 0..1 | Reference(AIR Related Person Profile) | Value of extension
Documentation for this format

This structure is derived from Extension

Summary

Simple Extension with the type Reference: This extension is to be used for communicating related person info in an AIR Immunisation Event. It holds the information transmitted in the HL7v2 NK1 segment.

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