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 - JSON Representation

Raw json | Download

    {
      "resourceType" : "Bundle",
      "id" : "72178030",
      "meta" : {
        "tag" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ProcessingID",
            "code" : "P"
          }
        ]
      },
      "type" : "message",
      "timestamp" : "2023-05-14T11:15:33+10:00",
      "entry" : [
        {
          "fullUrl" : "https://air.api-dev.digital.health.nz/fhir/R48182fbd6-c7a5-43a4-bbfc-b1443e493ca39",
          "resource" : {
            "resourceType" : "MessageHeader",
            "id" : "9876543",
            "text" : {
              "status" : "generated",
              "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\u00a0(use:\u00a0official,\u00a0))</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>"
            },
            "eventCoding" : {
              "system" : "https://standards.digital.health.nz/ns/air-event-type",
              "code" : "IMMUNISATION_UPDATE"
            },
            "destination" : [
              {
                "name" : "pmsfacid",
                "endpoint" : "edi123"
              }
            ],
            "source" : {
              "name" : "Mohfacid",
              "software" : "HSAP11111",
              "endpoint" : "Mohedi"
            },
            "focus" : [
              {
                "reference" : "https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633"
              },
              {
                "reference" : "https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE"
              },
              {
                "reference" : "https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP"
              }
            ]
          }
        },
        {
          "fullUrl" : "https://api.hip-uat.digital.health.nz/fhir/nhi/v1/Patient/ZKC4633",
          "resource" : {
            "resourceType" : "Patient",
            "id" : "ZKC4633",
            "text" : {
              "status" : "extensions",
              "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\u00a0(use:\u00a0official,\u00a0))</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.\n\nThe 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>"
            },
            "extension" : [
              {
                "url" : "http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity",
                "valueCodeableConcept" : {
                  "coding" : [
                    {
                      "system" : "https://standards.digital.health.nz/ns/ethnic-group-level-4-code",
                      "version" : "2.0",
                      "code" : "21111",
                      "display" : "Māori"
                    }
                  ]
                }
              }
            ],
            "identifier" : [
              {
                "use" : "official",
                "system" : "https://standards.digital.health.nz/ns/nhi-id",
                "value" : "ZKC4633"
              }
            ],
            "name" : [
              {
                "id" : "10",
                "family" : "Aufderhar",
                "given" : [
                  "Baby of Jane"
                ]
              }
            ],
            "gender" : "female",
            "birthDate" : "2023-05-25",
            "address" : [
              {
                "extension" : [
                  {
                    "url" : "http://hl7.org.nz/fhir/StructureDefinition/suburb",
                    "valueString" : "Waipu river"
                  }
                ],
                "line" : [
                  "23 Thule St"
                ],
                "city" : "Waipu"
              }
            ]
          }
        },
        {
          "fullUrl" : "https://air.api-test.digital.health.nz/fhir/R4/Immunization/IMM-ABCDE",
          "resource" : {
            "resourceType" : "Immunization",
            "id" : "b868b73d-ef57-4480-85de-ac012a1ee1a9",
            "meta" : {
              "versionId" : "null",
              "lastUpdated" : "2023-03-01T16:45:46.781+13:00",
              "profile" : [
                "https://standards.digital.health.nz/fhir/air/StructureDefinition/orch-immunization"
              ]
            },
            "text" : {
              "status" : "extensions",
              "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\u00a0(use:\u00a0official,\u00a0))</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>"
            },
            "extension" : [
              {
                "extension" : [
                  {
                    "url" : "diluentLotNumber",
                    "valueString" : "33332222"
                  },
                  {
                    "url" : "diluentExpiryDate",
                    "valueDate" : "2026-01-01"
                  }
                ],
                "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent"
              },
              {
                "extension" : [
                  {
                    "url" : "years",
                    "valueInteger" : 0
                  },
                  {
                    "url" : "months",
                    "valueInteger" : 11
                  },
                  {
                    "url" : "days",
                    "valueInteger" : 20
                  },
                  {
                    "url" : "daysSinceBirth",
                    "valueInteger" : 355
                  },
                  {
                    "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",
                  "display" : "Active or passive immunisation"
                }
              ]
            },
            "vaccineCode" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/sid/cvx",
                  "code" : "03",
                  "display" : "MMR"
                }
              ]
            },
            "patient" : {
              "reference" : "https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZAA0792"
            },
            "occurrenceDateTime" : "2016-09-01T16:45:46+13:00",
            "location" : {
              "reference" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K"
            },
            "site" : {
              "coding" : [
                {
                  "system" : "http://snomed.info/sct",
                  "code" : "16217701000119102",
                  "display" : "Structure of left deltoid muscle"
                }
              ]
            },
            "route" : {
              "coding" : [
                {
                  "system" : "http://snomed.info/sct",
                  "code" : "78421000",
                  "display" : "Intramuscular route"
                }
              ]
            },
            "performer" : [
              {
                "function" : {
                  "coding" : [
                    {
                      "system" : "https://standards.digital.health.nz/ns/air-terms-code",
                      "code" : "VC"
                    }
                  ]
                },
                "actor" : {
                  "reference" : "https://api.hip-uat.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP"
                }
              }
            ],
            "reasonCode" : [
              {
                "coding" : [
                  {
                    "system" : "https://standards.digital.health.nz/ns/air-terms-code",
                    "code" : "12M",
                    "display" : "12 months"
                  }
                ]
              }
            ],
            "protocolApplied" : [
              {
                "doseNumberPositiveInt" : 1
              }
            ]
          }
        },
        {
          "fullUrl" : "https://api.hip-uat.health.digital//fhir/hpi/v1/Practitioner/90ZZLP",
          "resource" : {
            "resourceType" : "Practitioner",
            "text" : {
              "status" : "generated",
              "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\u00a0(use:\u00a0official,\u00a0)</p><p><b>name</b>: Walter Eugene O'Reilly (Official)</p></div>"
            },
            "identifier" : [
              {
                "use" : "official",
                "system" : "https://standards.digital.health.nz/ns/hpi-person-id",
                "value" : "90ZZLP",
                "assigner" : {
                  "reference" : "Organization/G00001-G"
                }
              }
            ],
            "name" : [
              {
                "use" : "official",
                "family" : "O'Reilly",
                "given" : [
                  "Walter",
                  "Eugene"
                ],
                "prefix" : [
                  "cpl"
                ]
              }
            ]
          }
        }
      ]
    }