# AIR Consumer NIR Opt Off - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.28.0-SNAPSHOT

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **AIR Consumer NIR Opt Off**

## Extension: AIR Consumer NIR Opt Off 

| | |
| :--- | :--- |
| *Official URL*:https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off | *Version*:1.28.0-SNAPSHOT |
| Active as of 2026-08-04 | *Computable Name*:AIRConsumerNIROptOff |

This extension is used in AIR to indicate the Air Patient (AKA Consumer) as having opted off NIR before they were migrated into AIR. Presence of this extension on the AIR Patient indicates that the consumer **has** opted off NIR and the extension includes the date that the consumer requested this to occur.

**Context of Use**

**Usage info**

**Usages:**

* Use this Extension: [AIR Patient Profile](StructureDefinition-air-patient.md)

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

#### Constraints



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "air-consumer-nir-opt-off",
  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off",
  "version" : "1.28.0-SNAPSHOT",
  "name" : "AIRConsumerNIROptOff",
  "title" : "AIR Consumer NIR Opt Off",
  "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" : "This extension is used in AIR to indicate the Air Patient (AKA Consumer) as having opted off NIR before they were migrated into AIR. \nPresence of this extension on the AIR Patient indicates that the consumer _has_ opted off NIR and the extension includes the date that the consumer requested this to occur.",
  "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" : "Immunization"
  }],
  "type" : "Extension",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Extension",
      "path" : "Extension",
      "short" : "AIR Consumer NIR Opt Off",
      "definition" : "This extension is used in AIR to indicate the Air Patient (AKA Consumer) as having opted off NIR before they were migrated into AIR. \nPresence of this extension on the AIR Patient indicates that the consumer _has_ opted off NIR and the extension includes the date that the consumer requested this to occur."
    },
    {
      "id" : "Extension.extension",
      "path" : "Extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.url",
      "path" : "Extension.url",
      "fixedUri" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-nir-opt-off"
    },
    {
      "id" : "Extension.value[x]",
      "path" : "Extension.value[x]",
      "min" : 1,
      "type" : [{
        "code" : "date"
      }]
    }]
  }
}

```
