NZ Shared Digital Health Record API
1.1.6 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

Extension: Planned Event Match Quality

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality Version: 1.1.6
Active as of 2026-07-14 Computable Name: AIRPlannedEventMatchQuality

The match quality 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: doco
Extension Extension Planned Event Match Quality
Extension.extension 3..
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:plannedEventId 1..1
Extension.Slices for extension.extension:plannedEventId.extension ..0
Extension.Slices for extension.extension:plannedEventId.url "plannedEventId"
Extension.Slices for extension.extension:plannedEventId.value[x] string
Extension.Slices for extension.extension:createdDate 1..1
Extension.Slices for extension.extension:createdDate.extension ..0
Extension.Slices for extension.extension:createdDate.url "createdDate"
Extension.Slices for extension.extension:createdDate.value[x] dateTime
Extension.Slices for extension.extension:createdReason 1..1
Extension.Slices for extension.extension:createdReason.extension ..0
Extension.Slices for extension.extension:createdReason.url "createdReason"
Extension.Slices for extension.extension:createdReason.value[x] Coding
Extension.Slices for extension.extension:resolvedDate 0..1
Extension.Slices for extension.extension:resolvedDate.extension ..0
Extension.Slices for extension.extension:resolvedDate.url "resolvedDate"
Extension.Slices for extension.extension:resolvedDate.value[x] dateTime
Extension.Slices for extension.extension:resolvedReason 0..1
Extension.Slices for extension.extension:resolvedReason.extension ..0
Extension.Slices for extension.extension:resolvedReason.url "resolvedReason"
Extension.Slices for extension.extension:resolvedReason.value[x] Coding
Extension.Slices for extension.extension:resolvedBy 0..1
Extension.Slices for extension.extension:resolvedBy.extension ..0
Extension.Slices for extension.extension:resolvedBy.url "resolvedBy"
Extension.Slices for extension.extension:resolvedBy.value[x] string
Extension.url "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Planned Event Match Quality
Constraints: ext-1
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 3..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:plannedEventId 1..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:plannedEventId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:plannedEventId.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:plannedEventId.url 1..1 uri "plannedEventId"
Extension.Slices for extension.extension:plannedEventId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:createdDate 1..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:createdDate.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:createdDate.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:createdDate.url 1..1 uri "createdDate"
Extension.Slices for extension.extension:createdDate.value[x] 0..1 dateTime Value of extension
Extension.Slices for extension.extension:createdReason 1..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:createdReason.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:createdReason.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:createdReason.url 1..1 uri "createdReason"
Extension.Slices for extension.extension:createdReason.value[x] 0..1 Coding Value of extension
Extension.Slices for extension.extension:resolvedDate 0..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:resolvedDate.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:resolvedDate.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:resolvedDate.url 1..1 uri "resolvedDate"
Extension.Slices for extension.extension:resolvedDate.value[x] 0..1 dateTime Value of extension
Extension.Slices for extension.extension:resolvedReason 0..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:resolvedReason.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:resolvedReason.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:resolvedReason.url 1..1 uri "resolvedReason"
Extension.Slices for extension.extension:resolvedReason.value[x] 0..1 Coding Value of extension
Extension.Slices for extension.extension:resolvedBy 0..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:resolvedBy.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:resolvedBy.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:resolvedBy.url 1..1 uri "resolvedBy"
Extension.Slices for extension.extension:resolvedBy.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The match quality 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.
  • createdDate: 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.
  • createdReason: 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.
  • resolvedDate: 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.
  • resolvedReason: 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.
  • resolvedBy: 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: doco
Extension Extension Planned Event Match Quality
Extension.extension 3..
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:plannedEventId 1..1
Extension.Slices for extension.extension:plannedEventId.extension ..0
Extension.Slices for extension.extension:plannedEventId.url "plannedEventId"
Extension.Slices for extension.extension:plannedEventId.value[x] string
Extension.Slices for extension.extension:createdDate 1..1
Extension.Slices for extension.extension:createdDate.extension ..0
Extension.Slices for extension.extension:createdDate.url "createdDate"
Extension.Slices for extension.extension:createdDate.value[x] dateTime
Extension.Slices for extension.extension:createdReason 1..1
Extension.Slices for extension.extension:createdReason.extension ..0
Extension.Slices for extension.extension:createdReason.url "createdReason"
Extension.Slices for extension.extension:createdReason.value[x] Coding
Extension.Slices for extension.extension:resolvedDate 0..1
Extension.Slices for extension.extension:resolvedDate.extension ..0
Extension.Slices for extension.extension:resolvedDate.url "resolvedDate"
Extension.Slices for extension.extension:resolvedDate.value[x] dateTime
Extension.Slices for extension.extension:resolvedReason 0..1
Extension.Slices for extension.extension:resolvedReason.extension ..0
Extension.Slices for extension.extension:resolvedReason.url "resolvedReason"
Extension.Slices for extension.extension:resolvedReason.value[x] Coding
Extension.Slices for extension.extension:resolvedBy 0..1
Extension.Slices for extension.extension:resolvedBy.extension ..0
Extension.Slices for extension.extension:resolvedBy.url "resolvedBy"
Extension.Slices for extension.extension:resolvedBy.value[x] string
Extension.url "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality"
Extension.value[x] ..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Planned Event Match Quality
Constraints: ext-1
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 3..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:plannedEventId 1..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:plannedEventId.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:plannedEventId.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:plannedEventId.url 1..1 uri "plannedEventId"
Extension.Slices for extension.extension:plannedEventId.value[x] 0..1 string Value of extension
Extension.Slices for extension.extension:createdDate 1..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:createdDate.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:createdDate.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:createdDate.url 1..1 uri "createdDate"
Extension.Slices for extension.extension:createdDate.value[x] 0..1 dateTime Value of extension
Extension.Slices for extension.extension:createdReason 1..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:createdReason.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:createdReason.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:createdReason.url 1..1 uri "createdReason"
Extension.Slices for extension.extension:createdReason.value[x] 0..1 Coding Value of extension
Extension.Slices for extension.extension:resolvedDate 0..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:resolvedDate.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:resolvedDate.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:resolvedDate.url 1..1 uri "resolvedDate"
Extension.Slices for extension.extension:resolvedDate.value[x] 0..1 dateTime Value of extension
Extension.Slices for extension.extension:resolvedReason 0..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:resolvedReason.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:resolvedReason.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:resolvedReason.url 1..1 uri "resolvedReason"
Extension.Slices for extension.extension:resolvedReason.value[x] 0..1 Coding Value of extension
Extension.Slices for extension.extension:resolvedBy 0..1 Extension Additional content defined by implementations
Extension.Slices for extension.extension:resolvedBy.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:resolvedBy.extension 0..0 Additional content defined by implementations
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:resolvedBy.url 1..1 uri "resolvedBy"
Extension.Slices for extension.extension:resolvedBy.value[x] 0..1 string Value of extension
Extension.url 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The match quality 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.
  • createdDate: 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.
  • createdReason: 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.
  • resolvedDate: 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.
  • resolvedReason: 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.
  • resolvedBy: 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:createdDate, Extension.extension:createdReason, Extension.extension:resolvedDate, Extension.extension:resolvedReason, Extension.extension:resolvedBy Must have either extensions or value[x], not both extension.exists() != value.exists()