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
<Bundle xmlns="http://hl7.org/fhir">
<id value="72178030"/>
<meta>
<tag>
<system value="http://terminology.hl7.org/CodeSystem/v3-ProcessingID"/>
<code value="P"/>
</tag>
</meta>
<type value="message"/>
<timestamp value="2023-05-14T11:15:33+10:00"/>
<entry>
<fullUrl
value="https://air.api-dev.digital.health.nz/fhir/R48182fbd6-c7a5-43a4-bbfc-b1443e493ca39"/>
<resource>
<MessageHeader>
<id value="9876543"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="MessageHeader_9876543"> </a><p class="res-header-id"><b>Generated Narrative: MessageHeader 9876543</b></p><a name="9876543"> </a><a name="hc9876543"> </a><p><b>event</b>: <a href="CodeSystem-air-event-type-1.0.html#air-event-type-1.0-IMMUNISATION_UPDATE">AIR Event Type: IMMUNISATION_UPDATE</a> (Immunisation Update Request)</p><h3>Destinations</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Name</b></td><td><b>Endpoint</b></td></tr><tr><td style="display: none">*</td><td>pmsfacid</td><td><a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=http://fhir.org.nz/ig/base/edi123">edi123</a></td></tr></table><h3>Sources</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Name</b></td><td><b>Software</b></td><td><b>Endpoint</b></td></tr><tr><td style="display: none">*</td><td>Mohfacid</td><td>HSAP11111</td><td><a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=http://fhir.org.nz/ig/base/Mohedi">Mohedi</a></td></tr></table><p><b>focus</b>: </p><ul><li><a href="Bundle-72178030.html#https-//api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633">Baby of Jane Aufderhar Female, DoB: 2023-05-25 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZKC4633 (use: official, ))</a></li><li><a href="Bundle-72178030.html#https-//air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE">Immunization: extension = ,; status = completed; statusReason = Active or passive immunisation; vaccineCode = MMR; occurrence[x] = 2016-09-01 16:45:46+1300; site = Structure of left deltoid muscle; route = Intramuscular route; reasonCode = 12 months</a></li><li><a href="Bundle-72178030.html#https-//api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP">Practitioner Walter Eugene O'Reilly (official)</a></li></ul></div>
</text>
<eventCoding>
<system
value="https://standards.digital.health.nz/ns/air-event-type"/>
<code value="IMMUNISATION_UPDATE"/>
</eventCoding>
<destination>
<name value="pmsfacid"/>
<endpoint value="edi123"/>
</destination>
<source>
<name value="Mohfacid"/>
<software value="HSAP11111"/>
<endpoint value="Mohedi"/>
</source>
<focus>
<reference
value="https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633"/>
</focus>
<focus>
<reference
value="https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE"/>
</focus>
<focus>
<reference
value="https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP"/>
</focus>
</MessageHeader>
</resource>
</entry>
<entry>
<fullUrl
value="https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633"/>
<resource>
<Patient>
<id value="ZKC4633"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Patient_ZKC4633"> </a><p class="res-header-id"><b>Generated Narrative: Patient ZKC4633</b></p><a name="ZKC4633"> </a><a name="hcZKC4633"> </a><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;">Baby of Jane Aufderhar Female, DoB: 2023-05-25 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZKC4633 (use: official, ))</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="Ways to contact the Patient">Contact Detail</td><td colspan="3">23 Thule St Waipu (NZ Suburb: Waipu river)</td></tr><tr><td style="background-color: #f3f5da" title="The ethnic group or groups that a person identifies with or feels they belong to. Ethnicity is a measure of cultural affiliation as opposed to race, ancestry, nationality or citizen. Ethnicity is self-perceived and a person can belong to more than one group.
The Stats New Zealand standard can be found [here](http://aria.stats.govt.nz/aria/#ClassificationView:uri=http://stats.govt.nz/cms/ClassificationVersion/YVqOcFHSlguKkT17)."><a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity">NZ Ethnicity</a></td><td colspan="3"><span title="Codes:{https://standards.digital.health.nz/ns/ethnic-group-level-4-code 21111}">Māori</span></td></tr></table></div>
</text>
<extension
url="http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity">
<valueCodeableConcept>
<coding>
<system
value="https://standards.digital.health.nz/ns/ethnic-group-level-4-code"/>
<version value="2.0"/>
<code value="21111"/>
<display value="Māori"/>
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<use value="official"/>
<system value="https://standards.digital.health.nz/ns/nhi-id"/>
<value value="ZKC4633"/>
</identifier>
<name id="10">
<family value="Aufderhar"/>
<given value="Baby of Jane"/>
</name>
<gender value="female"/>
<birthDate value="2023-05-25"/>
<address>
<extension url="http://hl7.org.nz/fhir/StructureDefinition/suburb">
<valueString value="Waipu river"/>
</extension>
<line value="23 Thule St"/>
<city value="Waipu"/>
</address>
</Patient>
</resource>
</entry>
<entry>
<fullUrl
value="https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE"/>
<resource>
<Immunization>
<id value="b868b73d-ef57-4480-85de-ac012a1ee1a9"/>
<meta>
<versionId value="null"/>
<lastUpdated value="2023-03-01T16:45:46.781+13:00"/>
<profile
value="https://standards.digital.health.nz/fhir/air/StructureDefinition/orch-immunization"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Immunization_b868b73d-ef57-4480-85de-ac012a1ee1a9"> </a><p class="res-header-id"><b>Generated Narrative: Immunization b868b73d-ef57-4480-85de-ac012a1ee1a9</b></p><a name="b868b73d-ef57-4480-85de-ac012a1ee1a9"> </a><a name="hcb868b73d-ef57-4480-85de-ac012a1ee1a9"> </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: null; Last updated: 2023-03-01 16:45:46+1300</p><p style="margin-bottom: 0px">Profile: <a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=https://standards.digital.health.nz/fhir/air/StructureDefinition/orch-immunization">https://standards.digital.health.nz/fhir/air/StructureDefinition/orch-immunization</a></p></div><blockquote><p><b>Immunization Diluent</b></p><ul><li>diluentLotNumber: 33332222</li><li>diluentExpiryDate: 2026-01-01</li></ul></blockquote><blockquote><p><b>AIR Age Given Extension</b></p><ul><li>years: 0</li><li>months: 11</li><li>days: 20</li><li>daysSinceBirth: 355</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 immunisation</span></p><p><b>vaccineCode</b>: <span title="Codes:{http://hl7.org/fhir/sid/cvx 03}">MMR</span></p><p><b>patient</b>: <a href="Bundle-AIRBundleOrchestrationExample.html#https-//api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZAA0792">BABY OF TESTING NEWMUM Female, DoB: 2015-09-09 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZAA0792 (use: official, ))</a></p><p><b>occurrence</b>: 2016-09-01 16:45:46+1300</p><p><b>location</b>: <a href="Bundle-AIRBundleOrchestrationExample.html#https-//api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K">Location Medical Centre Flat-Unit</a></p><p><b>site</b>: <span title="Codes:{http://snomed.info/sct 16217701000119102}">Structure of left deltoid muscle</span></p><p><b>route</b>: <span title="Codes:{http://snomed.info/sct 78421000}">Intramuscular 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><a href="https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=https://api.hip-uat.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP">https://api.hip-uat.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP</a></td></tr></table><p><b>reasonCode</b>: <span title="Codes:{https://standards.digital.health.nz/ns/air-terms-code 12M}">12 months</span></p><h3>ProtocolApplieds</h3><table class="grid"><tr><td style="display: none">-</td><td><b>DoseNumber[x]</b></td></tr><tr><td style="display: none">*</td><td>1</td></tr></table></div>
</text>
<extension
url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent">
<extension url="diluentLotNumber">
<valueString value="33332222"/>
</extension>
<extension url="diluentExpiryDate">
<valueDate value="2026-01-01"/>
</extension>
</extension>
<extension
url="https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given">
<extension url="years">
<valueInteger value="0"/>
</extension>
<extension url="months">
<valueInteger value="11"/>
</extension>
<extension url="days">
<valueInteger value="20"/>
</extension>
<extension url="daysSinceBirth">
<valueInteger value="355"/>
</extension>
<extension url="precision">
<valueString value="Day"/>
</extension>
</extension>
<status value="completed"/>
<statusReason>
<coding>
<system value="http://snomed.info/sct"/>
<code value="127785005"/>
<display value="Active or passive immunisation"/>
</coding>
</statusReason>
<vaccineCode>
<coding>
<system value="http://hl7.org/fhir/sid/cvx"/>
<code value="03"/>
<display value="MMR"/>
</coding>
</vaccineCode>
<patient>
<reference
value="https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZAA0792"/>
</patient>
<occurrenceDateTime value="2016-09-01T16:45:46+13:00"/>
<location>
<reference
value="https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K"/>
</location>
<site>
<coding>
<system value="http://snomed.info/sct"/>
<code value="16217701000119102"/>
<display value="Structure of left deltoid muscle"/>
</coding>
</site>
<route>
<coding>
<system value="http://snomed.info/sct"/>
<code value="78421000"/>
<display value="Intramuscular route"/>
</coding>
</route>
<performer>
<function>
<coding>
<system
value="https://standards.digital.health.nz/ns/air-terms-code"/>
<code value="VC"/>
</coding>
</function>
<actor>
<reference
value="https://api.hip-uat.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP"/>
</actor>
</performer>
<reasonCode>
<coding>
<system
value="https://standards.digital.health.nz/ns/air-terms-code"/>
<code value="12M"/>
<display value="12 months"/>
</coding>
</reasonCode>
<protocolApplied>
<doseNumberString value="1"/>
</protocolApplied>
</Immunization>
</resource>
</entry>
<entry>
<fullUrl
value="https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP"/>
<resource>
<Practitioner>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><a name="Practitioner_null"> </a><p class="res-header-id"><b>Generated Narrative: Practitioner </b></p><p><b>identifier</b>: HPIProvider/90ZZLP (use: official, )</p><p><b>name</b>: Walter Eugene O'Reilly (Official)</p></div>
</text>
<identifier>
<use value="official"/>
<system
value="https://standards.digital.health.nz/ns/hpi-person-id"/>
<value value="90ZZLP"/>
<assigner>
<reference value="Organization/G00001-G"/>
</assigner>
</identifier>
<name>
<use value="official"/>
<family value="O'Reilly"/>
<given value="Walter"/>
<given value="Eugene"/>
<prefix value="cpl"/>
</name>
</Practitioner>
</resource>
</entry>
</Bundle>