# AIR Message Header - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.28.0-SNAPSHOT

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **AIR Message Header**

## Resource Profile: AIR Message Header 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/StructureDefinition/air-message-header | *Version*:1.28.0-SNAPSHOT |
| Draft as of 2026-08-04 | *Computable Name*:AIRMessageHeader |

 
This profile derived from MessageHeader implements extensions to message header required for Immunisation event messaging. 

**Usages:**

* This Profile is not used by any profiles in this Specification

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

### Formal Views of Profile Content

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

 

Other representations of profile: [CSV](StructureDefinition-air-message-header.csv), [Excel](StructureDefinition-air-message-header.xlsx), [Schematron](StructureDefinition-air-message-header.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "air-message-header",
  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-message-header",
  "version" : "1.28.0-SNAPSHOT",
  "name" : "AIRMessageHeader",
  "title" : "AIR Message Header",
  "status" : "draft",
  "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" : "This profile derived from MessageHeader implements extensions to message header required for Immunisation event messaging.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "New Zealand"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "MessageHeader",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/MessageHeader",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "MessageHeader",
      "path" : "MessageHeader"
    },
    {
      "id" : "MessageHeader.extension",
      "path" : "MessageHeader.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      }
    },
    {
      "id" : "MessageHeader.extension:ImmunisationNotificationAction",
      "path" : "MessageHeader.extension",
      "sliceName" : "ImmunisationNotificationAction",
      "short" : "Indicates to which parties the Immunisation Notification message should be sent",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org.nz/fhir/StructureDefinition/air-immunisation-notification-action"]
      }]
    }]
  }
}

```
