Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v2.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: Planned Event Match

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match Version: 2.7.0
Active as of 2026-07-20 Computable Name: AIRPlannedEventMatch

The match of a planned event to an immunisation event as calculated by AIR rules.

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Planned Event Match
... extension 4..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:plannedEventId 1..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "plannedEventId"
..... value[x] 0..1 string Value of extension
.... extension:matchedDate 1..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "matchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:matchedReason 1..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "matchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:matchedBy 1..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "matchedBy"
..... value[x] 0..1 string Value of extension
.... extension:unmatchedDate 0..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "unmatchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:unmatchedReason 0..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "unmatchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:unmatchedBy 0..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "unmatchedBy"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Planned Event Match
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:plannedEventId 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 "plannedEventId"
..... value[x] 0..1 string Value of extension
.... extension:matchedDate 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 "matchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:matchedReason 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 "matchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:matchedBy 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 "matchedBy"
..... value[x] 0..1 string Value of extension
.... extension:unmatchedDate 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 "unmatchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:unmatchedReason 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 "unmatchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:unmatchedBy 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 "unmatchedBy"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The match of a planned event to an immunisation event as calculated by AIR rules.

  • plannedEventId: string: An Extension
  • matchedDate: dateTime: An Extension
  • matchedReason: Coding: An Extension
  • matchedBy: string: An Extension
  • unmatchedDate: dateTime: An Extension
  • unmatchedReason: Coding: An Extension
  • unmatchedBy: string: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Planned Event Match
... extension 4..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:plannedEventId 1..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "plannedEventId"
..... value[x] 0..1 string Value of extension
.... extension:matchedDate 1..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "matchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:matchedReason 1..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "matchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:matchedBy 1..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "matchedBy"
..... value[x] 0..1 string Value of extension
.... extension:unmatchedDate 0..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "unmatchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:unmatchedReason 0..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "unmatchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:unmatchedBy 0..1 Extension Extension
..... extension 0..0 Extension
..... url 1..1 uri "unmatchedBy"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Planned Event Match
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:plannedEventId 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 "plannedEventId"
..... value[x] 0..1 string Value of extension
.... extension:matchedDate 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 "matchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:matchedReason 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 "matchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:matchedBy 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 "matchedBy"
..... value[x] 0..1 string Value of extension
.... extension:unmatchedDate 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 "unmatchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:unmatchedReason 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 "unmatchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:unmatchedBy 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 "unmatchedBy"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The match of a planned event to an immunisation event as calculated by AIR rules.

  • plannedEventId: string: An Extension
  • matchedDate: dateTime: An Extension
  • matchedReason: Coding: An Extension
  • matchedBy: string: An Extension
  • unmatchedDate: dateTime: An Extension
  • unmatchedReason: Coding: An Extension
  • unmatchedBy: 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()