NZ Shared Digital Health Record API
1.1.0 - release

NZ Shared Digital Health Record API - Local Development build (v1.1.0) 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.1.0
Active as of 2026-07-14 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)

Usage info

Usages:

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.

This structure is derived from Extension

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

Snapshot View

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 Extension Must have either extensions or value[x], not both extension.exists() != value.exists()