# AIR Patient Profile - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.27.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **AIR Patient Profile**

## Resource Profile: AIR Patient Profile 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient | *Version*:1.27.0 |
| Active as of 2026-08-05 | *Computable Name*:AIRPatient |

 
This profile derived from NZPatient implements the requirements of the Aotearoa Immunisation Register (AIR) Immunisation Source of Truth (ImmSoT). 

**Usages:**

* Refer to this Profile: [AIR CarePlan Profile](StructureDefinition-air-careplan.md) and [AIR Immunization Recommendation](StructureDefinition-air-immunization-recommendation.md)
* CapabilityStatements using this Profile: [AIR FHIR Server Capability Statement](CapabilityStatement-AIRCapabilityStatement.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/AIR-ig|current/StructureDefinition/StructureDefinition-air-patient.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-patient.csv), [Excel](StructureDefinition-air-patient.xlsx), [Schematron](StructureDefinition-air-patient.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "air-patient",
  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient",
  "version" : "1.27.0",
  "name" : "AIRPatient",
  "title" : "AIR Patient Profile",
  "status" : "active",
  "date" : "2026-08-05T01:54:22+00:00",
  "publisher" : "Te Whatu Ora",
  "contact" : [{
    "name" : "Te Whatu Ora",
    "telecom" : [{
      "system" : "url",
      "value" : "https://tewhatuora.govt.nz"
    }]
  }],
  "description" : "This profile derived from NZPatient implements the requirements of the Aotearoa Immunisation Register (AIR) Immunisation Source of Truth (ImmSoT).",
  "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"
  },
  {
    "identity" : "cda",
    "uri" : "http://hl7.org/v3/cda",
    "name" : "CDA (R2)"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  },
  {
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "loinc",
    "uri" : "http://loinc.org",
    "name" : "LOINC code for the element"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Patient",
  "baseDefinition" : "http://hl7.org.nz/fhir/StructureDefinition/NzPatient",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Patient",
      "path" : "Patient"
    },
    {
      "id" : "Patient.meta.extension:ModifiedSourceSystem",
      "path" : "Patient.meta.extension",
      "sliceName" : "ModifiedSourceSystem",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system"]
      }]
    },
    {
      "id" : "Patient.meta.extension:ModifiedBy",
      "path" : "Patient.meta.extension",
      "sliceName" : "ModifiedBy",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by"]
      }]
    },
    {
      "id" : "Patient.extension",
      "path" : "Patient.extension",
      "min" : 1
    },
    {
      "id" : "Patient.extension:NIROptOff",
      "path" : "Patient.extension",
      "sliceName" : "NIROptOff",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off"]
      }]
    },
    {
      "id" : "Patient.extension:ConsumerState",
      "path" : "Patient.extension",
      "sliceName" : "ConsumerState",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state"]
      }]
    },
    {
      "id" : "Patient.extension:ConsumerSubStatus",
      "path" : "Patient.extension",
      "sliceName" : "ConsumerSubStatus",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-sub-status"]
      }]
    }]
  }
}

```
