# immunisation-update-response-message-meta-tag - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide v2.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **immunisation-update-response-message-meta-tag**

## Example Immunization: immunisation-update-response-message-meta-tag

version: 2; Last updated: 2026-03-31 01:32:08+0000

Profile: [AIR Immunization](StructureDefinition-air-immunization.md)

Tag: [Patient identifier not updated - identifier is immutable for this operation (Details: AIR Processing Terms code identifier-not-updated = 'Patient identifier not updated - identifier is immutable for this operation')](CodeSystem-air-processing-terms.md)

> **AIR Age Given Extension**
* years: 0
* months: 1
* days: 14
* daysSinceBirth: 45
* precision: DAY

**status**: Completed

**statusReason**: Vaccination given

**vaccineCode**: RV1

**patient**: [https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681](https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681)

**occurrence**: 2024-03-02 00:00:00+0000

**location**: [https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E](https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E)

**lotNumber**: RV1-001

**expirationDate**: 2026-01-31

**route**: Oral

### Performers

| | | |
| :--- | :--- | :--- |
| - | **Function** | **Actor** |
| * | Vaccinator | [https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/92ZZRR](https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/92ZZRR) |

**reasonCode**: 6 weeks

### ProtocolApplieds

| | | |
| :--- | :--- | :--- |
| - | **TargetDisease** | **DoseNumber[x]** |
| * | Rotavirus | 1 |



## Resource Content

```json
{
  "resourceType" : "Immunization",
  "id" : "immunisation-update-response-message-meta-tag",
  "meta" : {
    "extension" : [{
      "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system",
      "valueString" : "HSAPP0010"
    },
    {
      "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-by",
      "valueString" : "user"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/firstCreated",
      "valueInstant" : "2026-03-31T01:29:49.597+00:00"
    },
    {
      "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by",
      "valueString" : "user"
    },
    {
      "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system",
      "valueString" : "HSAPP0010"
    },
    {
      "extension" : [{
        "url" : "dqScore",
        "valueInteger" : 100
      },
      {
        "url" : "dqLastUpdated",
        "valueDateTime" : "2026-03-31T01:32:08.270+00:00"
      },
      {
        "url" : "dqStatus",
        "valueString" : "P"
      }],
      "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-data-quality-assessment"
    },
    {
      "extension" : [{
        "extension" : [{
          "url" : "plannedEventId",
          "valueString" : "00513eb7-7d2a-495a-b3aa-c361b3f923a2"
        },
        {
          "url" : "matchedDate",
          "valueDateTime" : "2026-03-31T01:32:08.369+00:00"
        },
        {
          "url" : "matchedBy",
          "valueString" : "user"
        },
        {
          "url" : "matchedReason",
          "valueCoding" : {
            "code" : "302",
            "display" : "Automatically matched by dose and indication"
          }
        }],
        "url" : "match"
      }],
      "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match"
    }],
    "versionId" : "2",
    "lastUpdated" : "2026-03-31T01:32:08.126+00:00",
    "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization"],
    "tag" : [{
      "system" : "https://standards.digital.health.nz/ns/air-processing-terms",
      "code" : "identifier-not-updated",
      "display" : "Patient identifier not updated - identifier is immutable for this operation"
    }]
  },
  "extension" : [{
    "extension" : [{
      "url" : "years",
      "valueInteger" : 0
    },
    {
      "url" : "months",
      "valueInteger" : 1
    },
    {
      "url" : "days",
      "valueInteger" : 14
    },
    {
      "url" : "daysSinceBirth",
      "valueInteger" : 45
    },
    {
      "url" : "precision",
      "valueString" : "DAY"
    }],
    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"
  }],
  "status" : "completed",
  "statusReason" : {
    "coding" : [{
      "system" : "https://standards.digital.health.nz/ns/air-status-reason-terms",
      "code" : "GIVEN",
      "display" : "Vaccination given"
    }]
  },
  "vaccineCode" : {
    "coding" : [{
      "system" : "http://hl7.org/fhir/sid/cvx",
      "code" : "119",
      "display" : "RV1"
    }],
    "text" : "RV1"
  },
  "patient" : {
    "reference" : "https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681",
    "identifier" : {
      "system" : "https://standards.digital.health.nz/ns/nhi-id",
      "value" : "ZGY9681"
    }
  },
  "occurrenceDateTime" : "2024-03-02T00:00:00+00:00",
  "location" : {
    "reference" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E",
    "identifier" : {
      "system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
      "value" : "FZZ835-E"
    }
  },
  "lotNumber" : "RV1-001",
  "expirationDate" : "2026-01-31",
  "route" : {
    "coding" : [{
      "system" : "https://standards.digital.health.nz/ns/air-terms-code",
      "code" : "PO",
      "display" : "Oral"
    }]
  },
  "performer" : [{
    "function" : {
      "coding" : [{
        "system" : "https://standards.digital.health.nz/ns/air-terms-code",
        "code" : "VC",
        "display" : "Vaccinator"
      }]
    },
    "actor" : {
      "reference" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/92ZZRR",
      "identifier" : {
        "system" : "https://standards.digital.health.nz/ns/hpi-person-id",
        "value" : "92ZZRR"
      }
    }
  }],
  "reasonCode" : [{
    "coding" : [{
      "system" : "https://standards.digital.health.nz/ns/air-terms-code",
      "code" : "6W",
      "display" : "6 weeks"
    }]
  }],
  "protocolApplied" : [{
    "targetDisease" : [{
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "18624000",
        "display" : "Rotavirus"
      }]
    }],
    "doseNumberPositiveInt" : 1
  }]
}

```
