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: Planned Event Match

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match Version: 1.1.0
Active as of 2026-07-14 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 Extension Planned Event Match
... extension 4..
... Slices for extension Content/Rules for all slices
.... extension:plannedEventId 1..1
..... extension ..0
..... url "plannedEventId"
..... value[x] string
.... extension:matchedDate 1..1
..... extension ..0
..... url "matchedDate"
..... value[x] dateTime
.... extension:matchedReason 1..1
..... extension ..0
..... url "matchedReason"
..... value[x] Coding
.... extension:matchedBy 1..1
..... extension ..0
..... url "matchedBy"
..... value[x] string
.... extension:unmatchedDate 0..1
..... extension ..0
..... url "unmatchedDate"
..... value[x] dateTime
.... extension:unmatchedReason 0..1
..... extension ..0
..... url "unmatchedReason"
..... value[x] Coding
.... extension:unmatchedBy 0..1
..... extension ..0
..... url "unmatchedBy"
..... value[x] string
... url "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
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 4..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:plannedEventId 1..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "plannedEventId"
..... value[x] 0..1 string Value of extension
.... extension:matchedDate 1..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "matchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:matchedReason 1..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "matchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:matchedBy 1..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "matchedBy"
..... value[x] 0..1 string Value of extension
.... extension:unmatchedDate 0..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "unmatchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:unmatchedReason 0..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "unmatchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:unmatchedBy 0..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
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: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • matchedDate: dateTime: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • matchedReason: Coding: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • matchedBy: string: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • unmatchedDate: dateTime: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • unmatchedReason: Coding: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • unmatchedBy: string: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension Extension Planned Event Match
... extension 4..
... Slices for extension Content/Rules for all slices
.... extension:plannedEventId 1..1
..... extension ..0
..... url "plannedEventId"
..... value[x] string
.... extension:matchedDate 1..1
..... extension ..0
..... url "matchedDate"
..... value[x] dateTime
.... extension:matchedReason 1..1
..... extension ..0
..... url "matchedReason"
..... value[x] Coding
.... extension:matchedBy 1..1
..... extension ..0
..... url "matchedBy"
..... value[x] string
.... extension:unmatchedDate 0..1
..... extension ..0
..... url "unmatchedDate"
..... value[x] dateTime
.... extension:unmatchedReason 0..1
..... extension ..0
..... url "unmatchedReason"
..... value[x] Coding
.... extension:unmatchedBy 0..1
..... extension ..0
..... url "unmatchedBy"
..... value[x] string
... url "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
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 4..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:plannedEventId 1..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "plannedEventId"
..... value[x] 0..1 string Value of extension
.... extension:matchedDate 1..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "matchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:matchedReason 1..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "matchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:matchedBy 1..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "matchedBy"
..... value[x] 0..1 string Value of extension
.... extension:unmatchedDate 0..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "unmatchedDate"
..... value[x] 0..1 dateTime Value of extension
.... extension:unmatchedReason 0..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "unmatchedReason"
..... value[x] 0..1 Coding Value of extension
.... extension:unmatchedBy 0..1 Extension Additional content defined by implementations
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Additional content defined by implementations
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: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • matchedDate: dateTime: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • matchedReason: Coding: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • matchedBy: string: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • unmatchedDate: dateTime: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • unmatchedReason: Coding: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  • unmatchedBy: string: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the 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 Extension, Extension.extension, Extension.extension:plannedEventId, Extension.extension:matchedDate, Extension.extension:matchedReason, Extension.extension:matchedBy, Extension.extension:unmatchedDate, Extension.extension:unmatchedReason, Extension.extension:unmatchedBy Must have either extensions or value[x], not both extension.exists() != value.exists()