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: AIR Data Quality Violation Detail

Official URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violation Version: 2.7.0
Active as of 2026-07-20 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)

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.

This structure is derived from Extension

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

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

doco 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

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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension AIR Data Quality Violation Detail
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 5..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:violationCode 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 "violationCode"
..... value[x] 0..1 string Value of extension
.... extension:violationType 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 "violationType"
..... value[x] 0..1 string Value of extension
.... extension:violationMessage 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 "violationMessage"
..... value[x] 0..1 string Value of extension
.... extension:violationElement 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 "violationElement"
..... value[x] 0..1 string Value of extension
.... extension:violationWeighting 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 "violationWeighting"
..... value[x] 0..1 integer Value of extension
... url 1..1 uri "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-dq-violation"

doco 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()