Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build
New Zealand
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build
New Zealand
Aotearoa Immunisation Register (AIR) FHIR Implementation Guide - Local Development build (v2.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
{
"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"
}
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Immunization immunisation-update-response-message-meta-tag</b></p><a name=\"immunisation-update-response-message-meta-tag\"> </a><a name=\"hcimmunisation-update-response-message-meta-tag\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">version: 2; Last updated: 2026-03-31 01:32:08+0000</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-air-immunization.html\">AIR Immunization</a></p><p style=\"margin-bottom: 0px\">Tag: <a href=\"CodeSystem-air-processing-terms.html\">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')</a></p></div><blockquote><p><b>AIR Age Given Extension</b></p><ul><li>years: 0</li><li>months: 1</li><li>days: 14</li><li>daysSinceBirth: 45</li><li>precision: DAY</li></ul></blockquote><p><b>status</b>: Completed</p><p><b>statusReason</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-status-reason-terms GIVEN}\">Vaccination given</span></p><p><b>vaccineCode</b>: <span title=\"Codes:{http://hl7.org/fhir/sid/cvx 119}\">RV1</span></p><p><b>patient</b>: <a href=\"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\">https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZGY9681</a></p><p><b>occurrence</b>: 2024-03-02 00:00:00+0000</p><p><b>location</b>: <a href=\"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\">https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E</a></p><p><b>lotNumber</b>: RV1-001</p><p><b>expirationDate</b>: 2026-01-31</p><p><b>route</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-terms-code PO}\">Oral</span></p><h3>Performers</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Function</b></td><td><b>Actor</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{https://standards.digital.health.nz/ns/air-terms-code VC}\">Vaccinator</span></td><td><a href=\"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\">https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/92ZZRR</a></td></tr></table><p><b>reasonCode</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-terms-code 6W}\">6 weeks</span></p><h3>ProtocolApplieds</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>TargetDisease</b></td><td><b>DoseNumber[x]</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://snomed.info/sct 18624000}\">Rotavirus</span></td><td>1</td></tr></table></div>"
},
"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
}
]
}