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" : "imm-example-2",
"meta" : {
"extension" : [
{
"url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system",
"valueString" : "SS345"
},
{
"url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by",
"valueString" : "222"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/firstCreated",
"valueDateTime" : "2023-08-21T02:18:30.303+00:00"
}
],
"versionId" : "2",
"lastUpdated" : "2023-08-31T02:18:32.217+00:00",
"profile" : [
🔗 "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Immunization imm-example-2</b></p><a name=\"imm-example-2\"> </a><a name=\"hcimm-example-2\"> </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: 2023-08-31 02:18:32+0000</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-air-immunization.html\">AIR Immunization</a></p></div><blockquote><p><b>Immunization Diluent</b></p><ul><li>diluentLotNumber: 33332222</li><li>diluentExpiryDate: 2026-01-01</li></ul></blockquote><p><b>AIR Administered Product Extension</b>: <span title=\"Codes:{http://nzmt.org.nz 44016911000116108}\">M-M-R-II</span></p><p><b>mobileSiteId</b>: FZZ958-K_MOB0001</p><blockquote><p><b>AIR Age Given Extension</b></p><ul><li>years: 1</li><li>months: 2</li><li>days: 22</li><li>daysSinceBirth: 445</li><li>precision: Day</li></ul></blockquote><p><b>status</b>: Completed</p><p><b>statusReason</b>: <span title=\"Codes:{http://snomed.info/sct 127785005}\">Active or passive immunization</span></p><p><b>vaccineCode</b>: <span title=\"Codes:{http://hl7.org/fhir/sid/cvx 03}\">MMR</span></p><p><b>patient</b>: Identifier: NHI/ZAA0792</p><p><b>occurrence</b>: 2023-03-01 16:45:46+1300</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>: 1234567890</p><p><b>expirationDate</b>: 2024-08-31</p><p><b>site</b>: <span title=\"Codes:{http://snomed.info/sct 368209003}\">Right upper arm</span></p><p><b>route</b>: <span title=\"Codes:{http://snomed.info/sct 54471007}\">Buccal route</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>Identifier: HPIProvider/90ZZLP</td></tr></table><p><b>reasonCode</b>: <span title=\"Codes:{http://snomed.info/sct 161651000210107}\">Publicly funded vaccination given for 65 years of age or older</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 14189004}\">14189004</span></td><td>1</td></tr></table><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: RelatedPerson #imm-related-person-1</b></p><a name=\"imm-example-2/imm-related-person-1\"> </a><a name=\"hcimm-example-2/imm-related-person-1\"> </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\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-air-related-person-prf.html\">AIR Related Person Profile</a></p></div><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/ZZZ9994\">https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ9994</a></p><p><b>relationship</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode MTH}\">mother</span></p><p><b>name</b>: Jane Jess Test-Dill </p><p><b>telecom</b>: ph: 041111111(Home), ph: 091111111(Work), <a href=\"mailto:jadill@test.mail\">jadill@test.mail</a></p><p><b>address</b>: 456 Main St Suite 256 Hamilton 1111 (home) (NZ Suburb: ccc)</p></blockquote><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: Observation #imm-serology-report-1</b></p><a name=\"imm-example-2/imm-serology-report-1\"> </a><a name=\"hcimm-example-2/imm-serology-report-1\"> </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\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-air-serology-report-profile.html\">AIR Serology Report Profile</a></p></div><p><b>status</b>: Final</p><p><b>code</b>: <span title=\"Codes:{http://snomed.info/sct 278969009}\">278969009</span></p><p><b>interpretation</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-serology-protection-terms IND}\">Indeterminate</span></p></blockquote></div>"
},
"contained" : [
{
"resourceType" : "RelatedPerson",
"id" : "imm-related-person-1",
"meta" : {
"profile" : [
🔗 "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-prf"
]
},
"patient" : {
"reference" : "https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ9994",
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZZZ9994"
}
},
"relationship" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code" : "MTH"
}
]
}
],
"name" : [
{
"family" : "Test-Dill",
"given" : [
"Jane Jess"
]
}
],
"telecom" : [
{
"system" : "phone",
"value" : "041111111",
"use" : "home"
},
{
"system" : "phone",
"value" : "091111111",
"use" : "work"
},
{
"system" : "email",
"value" : "jadill@test.mail",
"use" : "home"
}
],
"address" : [
{
"extension" : [
{
"url" : "http://hl7.org.nz/fhir/StructureDefinition/suburb",
"valueString" : "ccc"
}
],
"use" : "home",
"type" : "physical",
"line" : [
"456 Main St",
"Suite 256"
],
"city" : "Hamilton",
"postalCode" : "1111"
}
]
},
{
"resourceType" : "Observation",
"id" : "imm-serology-report-1",
"meta" : {
"profile" : [
🔗 "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-profile"
]
},
"status" : "final",
"code" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "278969009"
}
]
},
"interpretation" : [
{
"coding" : [
{
"system" : "https://standards.digital.health.nz/ns/air-serology-protection-terms",
"code" : "IND"
}
]
}
]
}
],
"extension" : [
{
"extension" : [
{
"url" : "diluentLotNumber",
"valueString" : "33332222"
},
{
"url" : "diluentExpiryDate",
"valueDate" : "2026-01-01"
}
],
"url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent"
},
{
"url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product",
"valueCodeableConcept" : {
"coding" : [
{
"system" : "http://nzmt.org.nz",
"code" : "44016911000116108",
"display" : "M-M-R-II"
}
]
}
},
{
"url" : "mobileSiteId",
"valueString" : "FZZ958-K_MOB0001"
},
{
"extension" : [
{
"url" : "years",
"valueInteger" : 1
},
{
"url" : "months",
"valueInteger" : 2
},
{
"url" : "days",
"valueInteger" : 22
},
{
"url" : "daysSinceBirth",
"valueInteger" : 445
},
{
"url" : "precision",
"valueString" : "Day"
}
],
"url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"
}
],
"status" : "completed",
"statusReason" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "127785005"
}
]
},
"vaccineCode" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/sid/cvx",
"code" : "03",
"display" : "MMR"
}
]
},
"patient" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "ZAA0792"
}
},
"occurrenceDateTime" : "2023-03-01T16:45:46+13: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" : "1234567890",
"expirationDate" : "2024-08-31",
"site" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"version" : "1.0.0",
"code" : "368209003",
"display" : "Right upper arm"
}
]
},
"route" : {
"coding" : [
{
"system" : "http://snomed.info/sct",
"version" : "1.0.0",
"code" : "54471007",
"display" : "Buccal route"
}
]
},
"performer" : [
{
"function" : {
"coding" : [
{
"system" : "https://standards.digital.health.nz/ns/air-terms-code",
"code" : "VC",
"display" : "Vaccinator"
}
]
},
"actor" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "90ZZLP"
}
}
}
],
"reasonCode" : [
{
"coding" : [
{
"system" : "http://snomed.info/sct",
"version" : "1.0.0",
"code" : "161651000210107",
"display" : "Publicly funded vaccination given for 65 years of age or older"
}
]
}
],
"protocolApplied" : [
{
"targetDisease" : [
{
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "14189004"
}
]
}
],
"doseNumberString" : "1"
}
]
}