AIR Data Quality Violation Detail - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2) v2.2.0-SNAPSHOT

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2)
2.2.0-SNAPSHOT - ci-build New Zealand

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

Extension: AIR Data Quality Violation Detail

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violation				Version: 2.2.0-SNAPSHOT
Active as of 2026-10-12				Computable Name: DQViolation

This describes one particular AIR data quality rule violation for an Immunization. Each rule violation includes a code, a type, a message, the FHIRPath expression to the element where the error occurred, and the weighting associated with the rule. Refer to Data Quality Rules and AIR Data Quality Violation Code value set for codes and messages that could be returned.

Context of Use

This extension may be used on the following element(s)

Element ID: Element

Usage info

Usages:

This Extension is not used by any profiles in this Specification

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	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	AIR Data Quality Violation Detail
Extension.extension	5..*	Extension	Extension
Extension.Slices for extension			Content/Rules for all slices
Extension.Slices for extension.extension:violationCode	1..1	Extension	Extension
Extension.Slices for extension.extension:violationCode.extension	0..0		Extension
Extension.Slices for extension.extension:violationCode.url	1..1	uri	"violationCode"
Extension.Slices for extension.extension:violationCode.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationType	1..1	Extension	Extension
Extension.Slices for extension.extension:violationType.extension	0..0		Extension
Extension.Slices for extension.extension:violationType.url	1..1	uri	"violationType"
Extension.Slices for extension.extension:violationType.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationMessage	1..1	Extension	Extension
Extension.Slices for extension.extension:violationMessage.extension	0..0		Extension
Extension.Slices for extension.extension:violationMessage.url	1..1	uri	"violationMessage"
Extension.Slices for extension.extension:violationMessage.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationElement	1..1	Extension	Extension
Extension.Slices for extension.extension:violationElement.extension	0..0		Extension
Extension.Slices for extension.extension:violationElement.url	1..1	uri	"violationElement"
Extension.Slices for extension.extension:violationElement.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationWeighting	1..1	Extension	Extension
Extension.Slices for extension.extension:violationWeighting.extension	0..0		Extension
Extension.Slices for extension.extension:violationWeighting.url	1..1	uri	"violationWeighting"
Extension.Slices for extension.extension:violationWeighting.value[x]	0..1	integer	Value of extension
Extension.url	1..1	uri	"https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violation"
Extension.value[x]	0..0		Value of extension
Documentation for this format

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	AIR Data Quality Violation Detail
Extension.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension	5..*	Extension	Extension 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:violationCode	1..1	Extension	Extension
Extension.Slices for extension.extension:violationCode.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationCode.extension	0..0		Extension 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:violationCode.url	1..1	uri	"violationCode"
Extension.Slices for extension.extension:violationCode.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationType	1..1	Extension	Extension
Extension.Slices for extension.extension:violationType.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationType.extension	0..0		Extension 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:violationType.url	1..1	uri	"violationType"
Extension.Slices for extension.extension:violationType.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationMessage	1..1	Extension	Extension
Extension.Slices for extension.extension:violationMessage.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationMessage.extension	0..0		Extension 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:violationMessage.url	1..1	uri	"violationMessage"
Extension.Slices for extension.extension:violationMessage.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationElement	1..1	Extension	Extension
Extension.Slices for extension.extension:violationElement.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationElement.extension	0..0		Extension 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:violationElement.url	1..1	uri	"violationElement"
Extension.Slices for extension.extension:violationElement.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationWeighting	1..1	Extension	Extension
Extension.Slices for extension.extension:violationWeighting.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationWeighting.extension	0..0		Extension 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:violationWeighting.url	1..1	uri	"violationWeighting"
Extension.Slices for extension.extension:violationWeighting.value[x]	0..1	integer	Value of extension
Extension.url	1..1	uri	"https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violation"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This describes one particular AIR data quality rule violation for an Immunization. Each rule violation includes a code, a type, a message, the FHIRPath expression to the element where the error occurred, and the weighting associated with the rule. Refer to Data Quality Rules and AIR Data Quality Violation Code value set for codes and messages that could be returned.

violationCode: string: An Extension
violationType: string: An Extension
violationMessage: string: An Extension
violationElement: string: An Extension
violationWeighting: integer: An Extension

Differential View

This structure is derived from Extension

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	AIR Data Quality Violation Detail
Extension.extension	5..*	Extension	Extension
Extension.Slices for extension			Content/Rules for all slices
Extension.Slices for extension.extension:violationCode	1..1	Extension	Extension
Extension.Slices for extension.extension:violationCode.extension	0..0		Extension
Extension.Slices for extension.extension:violationCode.url	1..1	uri	"violationCode"
Extension.Slices for extension.extension:violationCode.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationType	1..1	Extension	Extension
Extension.Slices for extension.extension:violationType.extension	0..0		Extension
Extension.Slices for extension.extension:violationType.url	1..1	uri	"violationType"
Extension.Slices for extension.extension:violationType.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationMessage	1..1	Extension	Extension
Extension.Slices for extension.extension:violationMessage.extension	0..0		Extension
Extension.Slices for extension.extension:violationMessage.url	1..1	uri	"violationMessage"
Extension.Slices for extension.extension:violationMessage.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationElement	1..1	Extension	Extension
Extension.Slices for extension.extension:violationElement.extension	0..0		Extension
Extension.Slices for extension.extension:violationElement.url	1..1	uri	"violationElement"
Extension.Slices for extension.extension:violationElement.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationWeighting	1..1	Extension	Extension
Extension.Slices for extension.extension:violationWeighting.extension	0..0		Extension
Extension.Slices for extension.extension:violationWeighting.url	1..1	uri	"violationWeighting"
Extension.Slices for extension.extension:violationWeighting.value[x]	0..1	integer	Value of extension
Extension.url	1..1	uri	"https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violation"
Extension.value[x]	0..0		Value of extension
Documentation for this format

Snapshot View

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	AIR Data Quality Violation Detail
Extension.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension	5..*	Extension	Extension 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:violationCode	1..1	Extension	Extension
Extension.Slices for extension.extension:violationCode.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationCode.extension	0..0		Extension 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:violationCode.url	1..1	uri	"violationCode"
Extension.Slices for extension.extension:violationCode.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationType	1..1	Extension	Extension
Extension.Slices for extension.extension:violationType.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationType.extension	0..0		Extension 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:violationType.url	1..1	uri	"violationType"
Extension.Slices for extension.extension:violationType.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationMessage	1..1	Extension	Extension
Extension.Slices for extension.extension:violationMessage.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationMessage.extension	0..0		Extension 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:violationMessage.url	1..1	uri	"violationMessage"
Extension.Slices for extension.extension:violationMessage.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationElement	1..1	Extension	Extension
Extension.Slices for extension.extension:violationElement.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationElement.extension	0..0		Extension 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:violationElement.url	1..1	uri	"violationElement"
Extension.Slices for extension.extension:violationElement.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:violationWeighting	1..1	Extension	Extension
Extension.Slices for extension.extension:violationWeighting.id	0..1	string	Unique id for inter-element referencing
Extension.Slices for extension.extension:violationWeighting.extension	0..0		Extension 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:violationWeighting.url	1..1	uri	"violationWeighting"
Extension.Slices for extension.extension:violationWeighting.value[x]	0..1	integer	Value of extension
Extension.url	1..1	uri	"https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violation"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This describes one particular AIR data quality rule violation for an Immunization. Each rule violation includes a code, a type, a message, the FHIRPath expression to the element where the error occurred, and the weighting associated with the rule. Refer to Data Quality Rules and AIR Data Quality Violation Code value set for codes and messages that could be returned.

violationCode: string: An Extension
violationType: string: An Extension
violationMessage: string: An Extension
violationElement: string: An Extension
violationWeighting: integer: 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()`

IG © 2022+ Te Whatu Ora. Package AIR-ig#2.2.0-SNAPSHOT based on FHIR 4.0.1. Generated 2026-10-12
Links: Table of Contents | QA Report