# AIR Orchestration Service Immunisation Bundle Example - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.27.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **AIR Orchestration Service Immunisation Bundle Example**

## Example Bundle: AIR Orchestration Service Immunisation Bundle Example



## Resource Content

```json
{
  "resourceType" : "Bundle",
  "id" : "AIRBundleOrchestrationExample",
  "type" : "searchset",
  "link" : [{
    "relation" : "self",
    "url" : "https://air.api-dev.digital.health.nz/fhir/R4/Immunization?_include=*&patient=ZAA0792"
  }],
  "entry" : [{
    "fullUrl" : "https://air.api-dev.digital.health.nz/fhir/R4/Immunization/a757a62c-ef57-4480-85de-ac012a1ee1a9",
    "resource" : {
      "resourceType" : "Immunization",
      "id" : "a757a62c-ef57-4480-85de-ac012a1ee1a9",
      "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" : "1",
        "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_a757a62c-ef57-4480-85de-ac012a1ee1a9\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Immunization a757a62c-ef57-4480-85de-ac012a1ee1a9</b></p><a name=\"a757a62c-ef57-4480-85de-ac012a1ee1a9\"> </a><a name=\"hca757a62c-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: 1; 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><p><b>mobileSiteId</b>: FZZ958-K_MOB0001</p><p><b>AIR Administered Product Extension</b>: <span title=\"Codes:{http://nzmt.org.nz 44016911000116108}\">M-M-R-II</span></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 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-12-02 13:21: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>lotNumber</b>: 1234567</p><p><b>expirationDate</b>: 2025-07-21</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=\"Bundle-AIRBundleOrchestrationExample.html#https-//api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP\">Practitioner: identifier = https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#90ZZLP (use: official, )</a></td></tr></table><p><b>reasonCode</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-terms-code 15M}\">15 months</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}\">Measles</span></td><td>2</td></tr></table><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: RelatedPerson #imm-related-person-1</b></p><a name=\"a757a62c-ef57-4480-85de-ac012a1ee1a9/imm-related-person-1\"> </a><a name=\"hca757a62c-ef57-4480-85de-ac012a1ee1a9/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&amp;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=\"a757a62c-ef57-4480-85de-ac012a1ee1a9/imm-serology-report-1\"> </a><a name=\"hca757a62c-ef57-4480-85de-ac012a1ee1a9/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}\">Hepatitis B status</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" : "mobileSiteId",
        "valueString" : "FZZ958-K_MOB0001"
      },
      {
        "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"
          }]
        }
      },
      {
        "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",
          "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",
        "identifier" : {
          "system" : "https://standards.digital.health.nz/ns/nhi-id",
          "value" : "ZAA0792"
        }
      },
      "occurrenceDateTime" : "2016-12-02T13:21:46+13:00",
      "location" : {
        "reference" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K",
        "identifier" : {
          "system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
          "value" : "FZZ958-K"
        }
      },
      "lotNumber" : "1234567",
      "expirationDate" : "2025-07-21",
      "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",
            "display" : "Vaccinator"
          }]
        },
        "actor" : {
          "reference" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP",
          "identifier" : {
            "system" : "https://standards.digital.health.nz/ns/hpi-person-id",
            "value" : "90ZZLP"
          }
        }
      }],
      "reasonCode" : [{
        "coding" : [{
          "system" : "https://standards.digital.health.nz/ns/air-terms-code",
          "code" : "15M",
          "display" : "15 months"
        }]
      }],
      "protocolApplied" : [{
        "targetDisease" : [{
          "coding" : [{
            "system" : "http://snomed.info/sct",
            "code" : "14189004"
          }]
        }],
        "doseNumberPositiveInt" : 2
      }]
    },
    "search" : {
      "mode" : "match"
    }
  },
  {
    "fullUrl" : "https://air.api-dev.digital.health.nz/fhir/R4/Immunization/b868b73d-ef57-4480-85de-ac012a1ee1a9",
    "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><p><b>mobileSiteId</b>: FZZ958-K_MOB0001</p><p><b>AIR Administered Product Extension</b>: <span title=\"Codes:{http://nzmt.org.nz 44016911000116108}\">M-M-R-II</span></p><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>lotNumber</b>: ABCDEFG</p><p><b>expirationDate</b>: 2024-08-11</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=\"Bundle-AIRBundleOrchestrationExample.html#https-//api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP\">Practitioner: identifier = https://standards.digital.health.nz/ns/hpi-person-id#HPIProvider#90ZZLP (use: official, )</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>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}\">Measles</span></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"
      },
      {
        "url" : "mobileSiteId",
        "valueString" : "FZZ958-K_MOB0001"
      },
      {
        "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"
          }]
        }
      },
      {
        "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",
        "identifier" : {
          "system" : "https://standards.digital.health.nz/ns/nhi-id",
          "value" : "ZAA0792"
        }
      },
      "occurrenceDateTime" : "2016-09-01T16:45:46+13:00",
      "location" : {
        "reference" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K",
        "identifier" : {
          "system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
          "value" : "FZZ958-K"
        }
      },
      "lotNumber" : "ABCDEFG",
      "expirationDate" : "2024-08-11",
      "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.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP",
          "identifier" : {
            "system" : "https://standards.digital.health.nz/ns/hpi-person-id",
            "value" : "90ZZLP"
          }
        }
      }],
      "reasonCode" : [{
        "coding" : [{
          "system" : "https://standards.digital.health.nz/ns/air-terms-code",
          "code" : "12M",
          "display" : "12 months"
        }]
      }],
      "protocolApplied" : [{
        "targetDisease" : [{
          "coding" : [{
            "system" : "http://snomed.info/sct",
            "code" : "14189004"
          }]
        }],
        "doseNumberPositiveInt" : 1
      }]
    },
    "search" : {
      "mode" : "match"
    }
  },
  {
    "fullUrl" : "https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZAA0792",
    "resource" : {
      "resourceType" : "Patient",
      "id" : "ZAA0792",
      "meta" : {
        "versionId" : "3368251",
        "profile" : ["http://hl7.org.nz/fhir/StructureDefinition/NhiPatient"]
      },
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Patient_ZAA0792\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Patient ZAA0792</b></p><a name=\"ZAA0792\"> </a><a name=\"hcZAA0792\"> </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: 3368251</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=http://hl7.org.nz/fhir/StructureDefinition/NhiPatient\">http://hl7.org.nz/fhir/StructureDefinition/NhiPatient</a></p></div><p style=\"border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;\">BABY OF TESTING NEWMUM  Female, DoB: 2015-09-09 ( https://standards.digital.health.nz/ns/nhi-id#NHI#ZAA0792 (use: official, ))</p><hr/><table class=\"grid\"><tr><td style=\"background-color: #f3f5da\" title=\"Other Id (see the one above)\">Other Id:</td><td colspan=\"3\">NHI/ZAA0806 (use: old, )</td></tr><tr><td style=\"background-color: #f3f5da\" title=\"Ways to contact the Patient\">Contact Detail</td><td colspan=\"3\"><ul><li>Rue Mtsangani Bandrele 0606 (home) (NZ Suburb: Moutsamoudou)</li><li>147 Quay Street Auckland 1010 NZ (home) (NZ Suburb: Auckland Central)</li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"NZ Residency status\">null:</td><td colspan=\"3\"><ul><li>source: <span title=\"Codes:{https://standards.digital.health.nz/ns/information-source-code HL7}\">HL7 applied</span></li><li>status: <span title=\"Codes:{https://standards.digital.health.nz/ns/nz-residency-code yes}\">Permanent Resident</span></li></ul></td></tr><tr><td style=\"background-color: #f3f5da\" title=\"New Zealand citizenship\">NZ Citizenship:</td><td colspan=\"3\"><ul><li>status: <span title=\"Codes:{https://standards.digital.health.nz/ns/nz-citizenship-status-code unknown}\">The citizenship status is unknown</span></li></ul></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 11111}\">New Zealand European</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" : "11111",
            "display" : "New Zealand European"
          }],
          "text" : "New Zealand European"
        }
      },
      {
        "extension" : [{
          "url" : "status",
          "valueCodeableConcept" : {
            "coding" : [{
              "system" : "https://standards.digital.health.nz/ns/nz-citizenship-status-code",
              "version" : "1.0.0",
              "code" : "unknown",
              "display" : "The citizenship status is unknown"
            }],
            "text" : "The citizenship status is unknown"
          }
        }],
        "url" : "http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship"
      },
      {
        "extension" : [{
          "url" : "source",
          "valueCodeableConcept" : {
            "coding" : [{
              "system" : "https://standards.digital.health.nz/ns/information-source-code",
              "version" : "1.0.0",
              "code" : "HL7",
              "display" : "HL7 applied"
            }],
            "text" : "HL7 applied"
          }
        },
        {
          "url" : "status",
          "valueCodeableConcept" : {
            "coding" : [{
              "system" : "https://standards.digital.health.nz/ns/nz-residency-code",
              "version" : "1.0.0",
              "code" : "yes",
              "display" : "Permanent Resident"
            }],
            "text" : "Permanent Resident"
          }
        }],
        "url" : "http://hl7.org.nz/fhir/StructureDefinition/nz-residency"
      }],
      "identifier" : [{
        "use" : "official",
        "system" : "https://standards.digital.health.nz/ns/nhi-id",
        "value" : "ZAA0792",
        "assigner" : {
          "reference" : "Organization/G00001-G"
        }
      },
      {
        "use" : "old",
        "system" : "https://standards.digital.health.nz/ns/nhi-id",
        "value" : "ZAA0806",
        "assigner" : {
          "reference" : "Organization/G00001-G"
        }
      }],
      "name" : [{
        "id" : "5",
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/iso21090-preferred",
          "valueBoolean" : true
        }],
        "family" : "NEWMUM",
        "given" : ["BABY OF TESTING"]
      }],
      "gender" : "female",
      "birthDate" : "2015-09-09",
      "_birthDate" : {
        "extension" : [{
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/information-source",
          "valueCodeableConcept" : {
            "coding" : [{
              "system" : "https://standards.digital.health.nz/ns/information-source-code",
              "version" : "1.0.0",
              "code" : "HL7",
              "display" : "HL7 applied"
            }],
            "text" : "HL7 applied"
          }
        }]
      },
      "address" : [{
        "id" : "17",
        "extension" : [{
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/not-validated-address-reason",
          "valueCodeableConcept" : {
            "coding" : [{
              "system" : "https://standards.digital.health.nz/ns/address-not-validated-reason-code",
              "version" : "1.1",
              "code" : "OSEA",
              "display" : "Overseas Address"
            }],
            "text" : "Overseas Address"
          }
        },
        {
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/suburb",
          "valueString" : "Moutsamoudou"
        }],
        "use" : "home",
        "type" : "physical",
        "line" : ["Rue Mtsangani"],
        "city" : "Bandrele",
        "postalCode" : "0606"
      },
      {
        "id" : "18",
        "extension" : [{
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/nz-address-id",
          "valueString" : "3571798"
        },
        {
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/domicile-code",
          "valueCodeableConcept" : {
            "coding" : [{
              "system" : "https://standards.digital.health.nz/ns/domicile-code",
              "code" : "0504",
              "display" : "Auckland Harbourside"
            }],
            "text" : "Auckland Harbourside"
          }
        },
        {
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/suburb",
          "valueString" : "Auckland Central"
        }],
        "use" : "home",
        "type" : "postal",
        "line" : ["147 Quay Street"],
        "city" : "Auckland",
        "postalCode" : "1010",
        "country" : "NZ"
      }]
    },
    "search" : {
      "mode" : "include"
    }
  },
  {
    "fullUrl" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/90ZZLP",
    "resource" : {
      "resourceType" : "Practitioner",
      "id" : "90ZZLP",
      "meta" : {
        "versionId" : "9971",
        "lastUpdated" : "2022-04-07T09:12:26.000+12:00",
        "profile" : ["http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner"],
        "security" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/v3-ObservationValue",
          "code" : "REDACTED"
        },
        {
          "system" : "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
          "code" : "R"
        }]
      },
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Practitioner_90ZZLP\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Practitioner 90ZZLP</b></p><a name=\"90ZZLP\"> </a><a name=\"hc90ZZLP\"> </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: 9971; Last updated: 2022-04-07 09:12:26+1200</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner\">http://hl7.org.nz/fhir/StructureDefinition/HPIPractitioner</a></p><p style=\"margin-bottom: 0px\">Security Labels: <a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-ObservationValue.html\">redacted (Details: ObservationValue code REDACTED = 'redacted')</a>, <a href=\"http://terminology.hl7.org/7.3.0/CodeSystem-v3-Confidentiality.html\">restricted (Details: Confidentiality code R = 'restricted')</a></p></div><p><b>identifier</b>: HPIProvider/90ZZLP (use: official, )</p></div>"
      },
      "identifier" : [{
        "use" : "official",
        "system" : "https://standards.digital.health.nz/ns/hpi-person-id",
        "value" : "90ZZLP",
        "assigner" : {
          "reference" : "Organization/G00001-G"
        }
      }]
    },
    "search" : {
      "mode" : "include"
    }
  },
  {
    "fullUrl" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ958-K",
    "resource" : {
      "resourceType" : "Location",
      "id" : "FZZ958-K",
      "meta" : {
        "versionId" : "10803",
        "lastUpdated" : "2022-11-09T12:00:14.000+13:00",
        "profile" : ["http://hl7.org.nz/fhir/StructureDefinition/HPILocation"]
      },
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Location_FZZ958-K\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Location FZZ958-K</b></p><a name=\"FZZ958-K\"> </a><a name=\"hcFZZ958-K\"> </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: 10803; Last updated: 2022-11-09 12:00:14+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=http://hl7.org.nz/fhir/StructureDefinition/HPILocation\">http://hl7.org.nz/fhir/StructureDefinition/HPILocation</a></p></div><p><b>Established</b>: 1980-12-12 --&gt; (ongoing)</p><p><b>identifier</b>: HPIFacility/FZZ958-K (use: official, ), HPIFacility/9987 (use: official, )</p><p><b>status</b>: Active</p><p><b>name</b>: Medical Centre Flat-Unit</p><p><b>alias</b>: Medical Centre Flat-Unit</p><p><b>type</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/location-type-code gpenrol}\">Enrolling GP Practice</span></p><p><b>telecom</b>: ph: 021 555558(Temp), ph: 021 464646(Work)</p><p><b>address</b>: 2C/123 Molesworth Street, Thorndon, Wellington 6011(work) (NZ Suburb: Wellington 6011)</p><p><b>managingOrganization</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=https://api.hip.digital.health.nz/fhir/hpi/v1/Organization/GZZ956-B\">Flat-Unit Address Org</a></p></div>"
      },
      "extension" : [{
        "url" : "http://hl7.org.nz/fhir/StructureDefinition/established",
        "valuePeriod" : {
          "start" : "1980-12-12"
        }
      }],
      "identifier" : [{
        "use" : "official",
        "system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
        "value" : "FZZ958-K",
        "assigner" : {
          "reference" : "Organization/G00001-G"
        }
      },
      {
        "use" : "official",
        "system" : "https://standards.digital.health.nz/ns/nzhis-facility-id",
        "value" : "9987",
        "assigner" : {
          "reference" : "Organization/G00001-G"
        }
      }],
      "status" : "active",
      "name" : "Medical Centre Flat-Unit",
      "alias" : ["Medical Centre Flat-Unit"],
      "_alias" : [{
        "extension" : [{
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/alias-type",
          "valueCodeableConcept" : {
            "coding" : [{
              "system" : "https://standards.digital.health.nz/ns/alias-type-code",
              "version" : "1.0.0",
              "code" : "current",
              "display" : "Current unverified or unofficial name"
            }],
            "text" : "Current unverified or unofficial name"
          }
        }]
      }],
      "type" : [{
        "coding" : [{
          "system" : "https://standards.digital.health.nz/ns/location-type-code",
          "version" : "1.0",
          "code" : "gpenrol",
          "display" : "Enrolling GP Practice"
        }]
      }],
      "telecom" : [{
        "system" : "phone",
        "value" : "021 555558",
        "use" : "temp",
        "rank" : 1,
        "period" : {
          "start" : "1980-12-12"
        }
      },
      {
        "system" : "phone",
        "value" : "021 464646",
        "use" : "work",
        "rank" : 1,
        "period" : {
          "start" : "1980-12-12"
        }
      }],
      "address" : {
        "extension" : [{
          "url" : "http://hl7.org.nz/fhir/StructureDefinition/suburb",
          "valueString" : "Wellington 6011"
        }],
        "use" : "work",
        "type" : "physical",
        "text" : "2C/123 Molesworth Street, Thorndon, Wellington 6011",
        "line" : ["Thorndon", "2C/123 Molesworth Street"]
      },
      "managingOrganization" : {
        "reference" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Organization/GZZ956-B",
        "display" : "Flat-Unit Address Org"
      }
    },
    "search" : {
      "mode" : "include"
    }
  }]
}

```
