Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.27.0 - release New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.27.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## : immunisation-update-request-message-1 - TTL Representation

Raw ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
    @prefix sct: <http://snomed.info/id/> .
    @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

    # - resource -------------------------------------------------------------------

    <http://hl7.org/fhir/Bundle/72178030> a fhir:Bundle ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:Resource.id [ fhir:value "72178030"] ;
      fhir:Resource.meta [
         fhir:Meta.tag [
           fhir:index 0 ;
           fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v3-ProcessingID" ] ;
           fhir:Coding.code [ fhir:value "P" ]
         ]
      ] ;
      fhir:Bundle.type [ fhir:value "message"] ;
      fhir:Bundle.timestamp [ fhir:value "2023-05-14T11:15:33+10:00"^^xsd:dateTime] ;
      fhir:Bundle.entry [
         fhir:index 0 ;
         fhir:Bundle.entry.fullUrl [ fhir:value "https://air.api-dev.digital.health.nz/fhir/R48182fbd6-c7a5-43a4-bbfc-b1443e493ca39" ] ;
         fhir:Bundle.entry.resource <https://air.api-dev.digital.health.nz/fhir/R48182fbd6-c7a5-43a4-bbfc-b1443e493ca39>
      ], [
         fhir:index 1 ;
         fhir:Bundle.entry.fullUrl [ fhir:value "https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633" ] ;
         fhir:Bundle.entry.resource <https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633>
      ], [
         fhir:index 2 ;
         fhir:Bundle.entry.fullUrl [ fhir:value "https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE" ] ;
         fhir:Bundle.entry.resource <https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE>
      ], [
         fhir:index 3 ;
         fhir:Bundle.entry.fullUrl [ fhir:value "https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP" ] ;
         fhir:Bundle.entry.resource <https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP>
      ] .

    <https://air.api-dev.digital.health.nz/fhir/R48182fbd6-c7a5-43a4-bbfc-b1443e493ca39> a fhir:MessageHeader ;
      fhir:Resource.id [ fhir:value "9876543"] ;
      fhir:DomainResource.text [
         fhir:Narrative.status [ fhir:value "generated" ] ;
         fhir:Narrative.div "<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&amp;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&amp;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>"
      ] ;
      fhir:MessageHeader.eventCoding [
         fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/air-event-type" ] ;
         fhir:Coding.code [ fhir:value "IMMUNISATION_UPDATE" ]
      ] ;
      fhir:MessageHeader.destination [
         fhir:index 0 ;
         fhir:MessageHeader.destination.name [ fhir:value "pmsfacid" ] ;
         fhir:MessageHeader.destination.endpoint [ fhir:value "edi123" ]
      ] ;
      fhir:MessageHeader.source [
         fhir:MessageHeader.source.name [ fhir:value "Mohfacid" ] ;
         fhir:MessageHeader.source.software [ fhir:value "HSAP11111" ] ;
         fhir:MessageHeader.source.endpoint [ fhir:value "Mohedi" ]
      ] ;
      fhir:MessageHeader.focus [
         fhir:index 0 ;
         fhir:link <https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633> ;
         fhir:Reference.reference [ fhir:value "https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633" ]
      ], [
         fhir:index 1 ;
         fhir:link <https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE> ;
         fhir:Reference.reference [ fhir:value "https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE" ]
      ], [
         fhir:index 2 ;
         fhir:link <https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP> ;
         fhir:Reference.reference [ fhir:value "https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP" ]
      ] .

    <https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633> a fhir:Patient ;
      fhir:Resource.id [ fhir:value "ZKC4633"] ;
      fhir:DomainResource.text [
         fhir:Narrative.status [ fhir:value "extensions" ] ;
         fhir:Narrative.div "<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.#xA;#xA;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&amp;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>"
      ] ;
      fhir:DomainResource.extension [
         fhir:index 0 ;
         fhir:Extension.url [ fhir:value "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity" ] ;
         fhir:Extension.valueCodeableConcept [
           fhir:CodeableConcept.coding [
             fhir:index 0 ;
             fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/ethnic-group-level-4-code" ] ;
             fhir:Coding.version [ fhir:value "2.0" ] ;
             fhir:Coding.code [ fhir:value "21111" ] ;
             fhir:Coding.display [ fhir:value "Māori" ]
           ]
         ]
      ] ;
      fhir:Patient.identifier [
         fhir:index 0 ;
         fhir:Identifier.use [ fhir:value "official" ] ;
         fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/nhi-id" ] ;
         fhir:Identifier.value [ fhir:value "ZKC4633" ]
      ] ;
      fhir:Patient.name [
         fhir:index 0 ;
         fhir:Element.id [ fhir:value "10" ] ;
         fhir:HumanName.family [ fhir:value "Aufderhar" ] ;
         fhir:HumanName.given [
           fhir:value "Baby of Jane" ;
           fhir:index 0
         ]
      ] ;
      fhir:Patient.gender [ fhir:value "female"] ;
      fhir:Patient.birthDate [ fhir:value "2023-05-25"^^xsd:date] ;
      fhir:Patient.address [
         fhir:index 0 ;
         fhir:Element.extension [
           fhir:index 0 ;
           fhir:Extension.url [ fhir:value "http://hl7.org.nz/fhir/StructureDefinition/suburb" ] ;
           fhir:Extension.valueString [ fhir:value "Waipu river" ]
         ] ;
         fhir:Address.line [
           fhir:value "23 Thule St" ;
           fhir:index 0
         ] ;
         fhir:Address.city [ fhir:value "Waipu" ]
      ] .

    <https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE> a fhir:Immunization ;
      fhir:Resource.id [ fhir:value "b868b73d-ef57-4480-85de-ac012a1ee1a9"] ;
      fhir:Resource.meta [
         fhir:Meta.versionId [ fhir:value "null" ] ;
         fhir:Meta.lastUpdated [ fhir:value "2023-03-01T16:45:46.781+13:00"^^xsd:dateTime ] ;
         fhir:Meta.profile [
           fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/orch-immunization" ;
           fhir:index 0 ;
           fhir:link <https://standards.digital.health.nz/fhir/air/StructureDefinition/orch-immunization>
         ]
      ] ;
      fhir:DomainResource.text [
         fhir:Narrative.status [ fhir:value "extensions" ] ;
         fhir:Narrative.div "<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&amp;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&amp;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>"
      ] ;
      fhir:DomainResource.extension [
         fhir:index 0 ;
         fhir:Element.extension [
           fhir:index 0 ;
           fhir:Extension.url [ fhir:value "diluentLotNumber" ] ;
           fhir:Extension.valueString [ fhir:value "33332222" ]
         ], [
           fhir:index 1 ;
           fhir:Extension.url [ fhir:value "diluentExpiryDate" ] ;
           fhir:Extension.valueDate [ fhir:value "2026-01-01"^^xsd:date ]
         ] ;
         fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent" ]
      ], [
         fhir:index 1 ;
         fhir:Element.extension [
           fhir:index 0 ;
           fhir:Extension.url [ fhir:value "years" ] ;
           fhir:Extension.valueInteger [ fhir:value "0"^^xsd:integer ]
         ], [
           fhir:index 1 ;
           fhir:Extension.url [ fhir:value "months" ] ;
           fhir:Extension.valueInteger [ fhir:value "11"^^xsd:integer ]
         ], [
           fhir:index 2 ;
           fhir:Extension.url [ fhir:value "days" ] ;
           fhir:Extension.valueInteger [ fhir:value "20"^^xsd:integer ]
         ], [
           fhir:index 3 ;
           fhir:Extension.url [ fhir:value "daysSinceBirth" ] ;
           fhir:Extension.valueInteger [ fhir:value "355"^^xsd:integer ]
         ], [
           fhir:index 4 ;
           fhir:Extension.url [ fhir:value "precision" ] ;
           fhir:Extension.valueString [ fhir:value "Day" ]
         ] ;
         fhir:Extension.url [ fhir:value "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given" ]
      ] ;
      fhir:Immunization.status [ fhir:value "completed"] ;
      fhir:Immunization.statusReason [
         fhir:CodeableConcept.coding [
           fhir:index 0 ;
           a sct:127785005 ;
           fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
           fhir:Coding.code [ fhir:value "127785005" ] ;
           fhir:Coding.display [ fhir:value "Active or passive immunisation" ]
         ]
      ] ;
      fhir:Immunization.vaccineCode [
         fhir:CodeableConcept.coding [
           fhir:index 0 ;
           fhir:Coding.system [ fhir:value "http://hl7.org/fhir/sid/cvx" ] ;
           fhir:Coding.code [ fhir:value "03" ] ;
           fhir:Coding.display [ fhir:value "MMR" ]
         ]
      ] ;
      fhir:Immunization.patient [
         fhir:link <https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZAA0792> ;
         fhir:Reference.reference [ fhir:value "https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZAA0792" ]
      ] ;
      fhir:Immunization.occurrenceDateTime [ fhir:value "2016-09-01T16:45:46+13:00"^^xsd:dateTime] ;
      fhir:Immunization.location [
         fhir:link <https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K> ;
         fhir:Reference.reference [ fhir:value "https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K" ]
      ] ;
      fhir:Immunization.site [
         fhir:CodeableConcept.coding [
           fhir:index 0 ;
           a sct:16217701000119102 ;
           fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
           fhir:Coding.code [ fhir:value "16217701000119102" ] ;
           fhir:Coding.display [ fhir:value "Structure of left deltoid muscle" ]
         ]
      ] ;
      fhir:Immunization.route [
         fhir:CodeableConcept.coding [
           fhir:index 0 ;
           a sct:78421000 ;
           fhir:Coding.system [ fhir:value "http://snomed.info/sct" ] ;
           fhir:Coding.code [ fhir:value "78421000" ] ;
           fhir:Coding.display [ fhir:value "Intramuscular route" ]
         ]
      ] ;
      fhir:Immunization.performer [
         fhir:index 0 ;
         fhir:Immunization.performer.function [
           fhir:CodeableConcept.coding [
             fhir:index 0 ;
             fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/air-terms-code" ] ;
             fhir:Coding.code [ fhir:value "VC" ]
           ]
         ] ;
         fhir:Immunization.performer.actor [
           fhir:link <https://api.hip-uat.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP> ;
           fhir:Reference.reference [ fhir:value "https://api.hip-uat.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP" ]
         ]
      ] ;
      fhir:Immunization.reasonCode [
         fhir:index 0 ;
         fhir:CodeableConcept.coding [
           fhir:index 0 ;
           fhir:Coding.system [ fhir:value "https://standards.digital.health.nz/ns/air-terms-code" ] ;
           fhir:Coding.code [ fhir:value "12M" ] ;
           fhir:Coding.display [ fhir:value "12 months" ]
         ]
      ] ;
      fhir:Immunization.protocolApplied [
         fhir:index 0 ;
         fhir:Immunization.protocolApplied.doseNumberPositiveInt [ fhir:value "1"^^xsd:positiveInteger ]
      ] .

    <https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP> a fhir:Practitioner ;
      fhir:DomainResource.text [
         fhir:Narrative.status [ fhir:value "generated" ] ;
         fhir:Narrative.div "<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>"
      ] ;
      fhir:Practitioner.identifier [
         fhir:index 0 ;
         fhir:Identifier.use [ fhir:value "official" ] ;
         fhir:Identifier.system [ fhir:value "https://standards.digital.health.nz/ns/hpi-person-id" ] ;
         fhir:Identifier.value [ fhir:value "90ZZLP" ] ;
         fhir:Identifier.assigner [
           fhir:link <http://hl7.org/fhir/Organization/G00001-G> ;
           fhir:Reference.reference [ fhir:value "Organization/G00001-G" ]
         ]
      ] ;
      fhir:Practitioner.name [
         fhir:index 0 ;
         fhir:HumanName.use [ fhir:value "official" ] ;
         fhir:HumanName.family [ fhir:value "O'Reilly" ] ;
         fhir:HumanName.given [
           fhir:value "Walter" ;
           fhir:index 0
         ], [
           fhir:value "Eugene" ;
           fhir:index 1
         ] ;
         fhir:HumanName.prefix [
           fhir:value "cpl" ;
           fhir:index 0
         ]
      ] .

    <http://hl7.org/fhir/Organization/G00001-G> a fhir:Organization .

    # - ontology header ------------------------------------------------------------

    <http://hl7.org/fhir/Bundle/72178030.ttl> a owl:Ontology ;
      owl:imports fhir:fhir.ttl ;
      owl:versionIRI <http://build.fhir.org/Bundle/72178030.ttl> .