# Planned Event Match Quality - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.28.0-SNAPSHOT

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Planned Event Match Quality**

## Extension: Planned Event Match Quality 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality | *Version*:1.28.0-SNAPSHOT |
| Active as of 2026-08-04 | *Computable Name*:AIRPlannedEventMatchQuality |

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

**Context of Use**

**Usage info**

**Usages:**

* Use this Extension: [AIR Immunization](StructureDefinition-air-immunization.md)
* Examples for this Extension: [Immunization/imm-example-match-quality](Immunization-imm-example-match-quality.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/AIR-ig|current/StructureDefinition/StructureDefinition-air-planned-event-match-quality.json)

### Formal Views of Extension Content

 [Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-air-planned-event-match-quality.csv), [Excel](StructureDefinition-air-planned-event-match-quality.xlsx), [Schematron](StructureDefinition-air-planned-event-match-quality.sch) 

#### Constraints



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "air-planned-event-match-quality",
  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality",
  "version" : "1.28.0-SNAPSHOT",
  "name" : "AIRPlannedEventMatchQuality",
  "title" : "Planned Event Match Quality",
  "status" : "active",
  "date" : "2026-08-04T03:40:16+00:00",
  "publisher" : "Te Whatu Ora",
  "contact" : [{
    "name" : "Te Whatu Ora",
    "telecom" : [{
      "system" : "url",
      "value" : "https://tewhatuora.govt.nz"
    }]
  }],
  "description" : "The match quality of a planned event to an immunisation event as calculated by AIR rules.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "New Zealand"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "complex-type",
  "abstract" : false,
  "context" : [{
    "type" : "element",
    "expression" : "Element"
  }],
  "type" : "Extension",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Extension",
      "path" : "Extension",
      "short" : "Planned Event Match Quality",
      "definition" : "The match quality of a planned event to an immunisation event as calculated by AIR rules."
    },
    {
      "id" : "Extension.extension",
      "path" : "Extension.extension",
      "min" : 3
    },
    {
      "id" : "Extension.extension:plannedEventId",
      "path" : "Extension.extension",
      "sliceName" : "plannedEventId",
      "min" : 1,
      "max" : "1"
    },
    {
      "id" : "Extension.extension:plannedEventId.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:plannedEventId.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "plannedEventId"
    },
    {
      "id" : "Extension.extension:plannedEventId.value[x]",
      "path" : "Extension.extension.value[x]",
      "type" : [{
        "code" : "string"
      }]
    },
    {
      "id" : "Extension.extension:createdDate",
      "path" : "Extension.extension",
      "sliceName" : "createdDate",
      "min" : 1,
      "max" : "1"
    },
    {
      "id" : "Extension.extension:createdDate.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:createdDate.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "createdDate"
    },
    {
      "id" : "Extension.extension:createdDate.value[x]",
      "path" : "Extension.extension.value[x]",
      "type" : [{
        "code" : "dateTime"
      }]
    },
    {
      "id" : "Extension.extension:createdReason",
      "path" : "Extension.extension",
      "sliceName" : "createdReason",
      "min" : 1,
      "max" : "1"
    },
    {
      "id" : "Extension.extension:createdReason.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:createdReason.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "createdReason"
    },
    {
      "id" : "Extension.extension:createdReason.value[x]",
      "path" : "Extension.extension.value[x]",
      "type" : [{
        "code" : "Coding"
      }]
    },
    {
      "id" : "Extension.extension:resolvedDate",
      "path" : "Extension.extension",
      "sliceName" : "resolvedDate",
      "min" : 0,
      "max" : "1"
    },
    {
      "id" : "Extension.extension:resolvedDate.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:resolvedDate.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "resolvedDate"
    },
    {
      "id" : "Extension.extension:resolvedDate.value[x]",
      "path" : "Extension.extension.value[x]",
      "type" : [{
        "code" : "dateTime"
      }]
    },
    {
      "id" : "Extension.extension:resolvedReason",
      "path" : "Extension.extension",
      "sliceName" : "resolvedReason",
      "min" : 0,
      "max" : "1"
    },
    {
      "id" : "Extension.extension:resolvedReason.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:resolvedReason.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "resolvedReason"
    },
    {
      "id" : "Extension.extension:resolvedReason.value[x]",
      "path" : "Extension.extension.value[x]",
      "type" : [{
        "code" : "Coding"
      }]
    },
    {
      "id" : "Extension.extension:resolvedBy",
      "path" : "Extension.extension",
      "sliceName" : "resolvedBy",
      "min" : 0,
      "max" : "1"
    },
    {
      "id" : "Extension.extension:resolvedBy.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:resolvedBy.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "resolvedBy"
    },
    {
      "id" : "Extension.extension:resolvedBy.value[x]",
      "path" : "Extension.extension.value[x]",
      "type" : [{
        "code" : "string"
      }]
    },
    {
      "id" : "Extension.url",
      "path" : "Extension.url",
      "fixedUri" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality"
    },
    {
      "id" : "Extension.value[x]",
      "path" : "Extension.value[x]",
      "max" : "0"
    }]
  }
}

```
