Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1)
1.28.0-SNAPSHOT - ci-build New Zealand

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

## : AIRBundleCarePlanExample - JSON Representation

Raw json | Download

    {
      "resourceType" : "Bundle",
      "id" : "AIRBundleCarePlanExample",
      "type" : "searchset",
      "link" : [
        {
          "relation" : "self",
          "url" : "https://localhost:8443/fhir/R4/CarePlan/$view?_include=*&nhi=ZET7992"
        }
      ],
      "entry" : [
        {
          "fullUrl" : "https://localhost:8443/fhir/R4/CarePlan/AGVS-Delay-3-6M-P-PCV13-1.0",
          "resource" : {
            "resourceType" : "CarePlan",
            "id" : "AGVS-Delay-3-6M-P-PCV13-1.0",
            "text" : {
              "status" : "extensions",
              "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"CarePlan_AGVS-Delay-3-6M-P-PCV13-1.0\"> </a><p class=\"res-header-id\"><b>Generated Narrative: CarePlan AGVS-Delay-3-6M-P-PCV13-1.0</b></p><a name=\"AGVS-Delay-3-6M-P-PCV13-1.0\"> </a><a name=\"hcAGVS-Delay-3-6M-P-PCV13-1.0\"> </a><p><b>instantiatesCanonical</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=https://localhost:8443/fhir/R4/AIRAGVSPlanDefinition/Delay-3-6M-P-PCV13-1.0\">https://localhost:8443/fhir/R4/AIRAGVSPlanDefinition/Delay-3-6M-P-PCV13-1.0</a></p><p><b>status</b>: Active</p><p><b>intent</b>: Plan</p><p><b>title</b>: PCV13 Immunisation Schedule for NHI ZET7992</p><p><b>description</b>: PCV13</p><p><b>subject</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/ZET7992\">https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZET7992</a></p><p><b>period</b>: 2023-11-11 13:00:00+1300 --&gt; (ongoing)</p><p><b>created</b>: 2023-12-30 13:00:00+1300</p><blockquote><p><b>activity</b></p><p><b>Planned Activity Reference Extension</b>: <a href=\"Bundle-AIRBundleCarePlanExample.html#ImmunizationRecommendation_AGVS-Delay-3-6M-P-PCV13-1.0-Dose2\">ImmunizationRecommendation: date = 2025-08-05 17:00:56+1200</a></p></blockquote><blockquote><p><b>activity</b></p><p><b>Performed Activity Extension</b>: </p></blockquote><p><b style=\"color: maroon\">Exception Generating Narrative: Cannot invoke &quot;org.hl7.fhir.r5.renderers.utils.ResourceWrapper.fhirType()&quot; because &quot;resource&quot; is null </b></p></div>"
            },
            "instantiatesCanonical" : [
              "https://localhost:8443/fhir/R4/AIRAGVSPlanDefinition/Delay-3-6M-P-PCV13-1.0"
            ],
            "status" : "active",
            "intent" : "plan",
            "title" : "PCV13 Immunisation Schedule for NHI ZET7992",
            "description" : "PCV13",
            "subject" : {
              "reference" : "https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZET7992",
              "identifier" : {
                "system" : "https://standards.digital.health.nz/ns/nhi-id",
                "value" : "ZET7992"
              }
            },
            "period" : {
              "start" : "2023-11-11T13:00:00+13:00"
            },
            "created" : "2023-12-30T13:00:00+13:00",
            "activity" : [
              {
                "extension" : [
                  {
                    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-activity-reference",
                    "valueReference" : {
                      "reference" : "ImmunizationRecommendation/AGVS-Delay-3-6M-P-PCV13-1.0-Dose2"
                    }
                  }
                ]
              },
              {
                "extension" : [
                  {
                    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-performed-activity",
                    "valueReference" : {
                      "reference" : "Immunization/63e060f0-a878-4a8c-a432-6712d15b1266"
                    }
                  }
                ]
              }
            ]
          }
        },
        {
          "fullUrl" : "https://localhost:8443/fhir/R4/ImmunizationRecommendation/AGVS-Delay-3-6M-P-PCV13-1.0-Dose1",
          "resource" : {
            "resourceType" : "ImmunizationRecommendation",
            "id" : "AGVS-Delay-3-6M-P-PCV13-1.0-Dose1",
            "meta" : {
              "profile" : [
                🔗 "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation"
              ]
            },
            "text" : {
              "status" : "extensions",
              "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"ImmunizationRecommendation_AGVS-Delay-3-6M-P-PCV13-1.0-Dose1\"> </a><p class=\"res-header-id\"><b>Generated Narrative: ImmunizationRecommendation AGVS-Delay-3-6M-P-PCV13-1.0-Dose1</b></p><a name=\"AGVS-Delay-3-6M-P-PCV13-1.0-Dose1\"> </a><a name=\"hcAGVS-Delay-3-6M-P-PCV13-1.0-Dose1\"> </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-immunization-recommendation.html\">AIR Immunization Recommendation</a></p></div><p><b>patient</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=http://fhir.org.nz/ig/base/Patient/ZET7992\">Patient/ZET7992</a></p><p><b>date</b>: 2025-08-05 17:00:56+1200</p><blockquote><p><b>recommendation</b></p><blockquote><p><b>id</b></p>8d133802-f22f-49f8-9a38-565c494a7630</blockquote><blockquote><p><b>AIR Scheduled Event</b></p><ul><li>type: <a href=\"CodeSystem-air-planned-event-type-terms.html#air-planned-event-type-terms-CPE\">AIR Planned Event Type: CPE</a> (Consumer Planned Event)</li></ul></blockquote><blockquote><p><b>AIR Antigen Group Vaccination Schedule</b></p><ul><li>schedule-type: <a href=\"CodeSystem-air-agvs-type.html#air-agvs-type-DELAYED\">AIR AGVS: DELAYED</a> (Delayed)</li><li>series-type: <a href=\"CodeSystem-air-agvs-series-type.html#air-agvs-series-type-PRIMARY\">AIR AGVS Series Type: PRIMARY</a> (Primary)</li><li>antigen-group: <a href=\"http://snomed.info/id/1119254000\">SNOMED CT: 1119254000</a> (PCV13)</li><li>version: 1.0</li></ul></blockquote><p><b>vaccineCode</b>: <span title=\"Codes:{http://hl7.org/fhir/sid/cvx 133}\">PCV13</span></p><p><b>forecastStatus</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-forecast-status GIVEN}\">Given</span></p><p><b>forecastReason</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-terms-code Stn}\">Funded, if not otherwise specified</span></p><h3>DateCriterions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://snomed.info/sct 789539003}\">Date immunization due</span></td><td>2024-01-27</td></tr></table><p><b>series</b>: Delay 3-6M_P_PCV13_1.0</p><p><b>doseNumber</b>: 1</p></blockquote></div>"
            },
            "patient" : {
              "reference" : "Patient/ZET7992",
              "identifier" : {
                "system" : "https://standards.digital.health.nz/ns/nhi-id",
                "value" : "ZET7992"
              }
            },
            "date" : "2025-08-05T17:00:56+12:00",
            "recommendation" : [
              {
                "id" : "8d133802-f22f-49f8-9a38-565c494a7630",
                "extension" : [
                  {
                    "extension" : [
                      {
                        "url" : "type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-scheduled-event-type-terms",
                          "code" : "CPE"
                        }
                      }
                    ],
                    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"
                  },
                  {
                    "extension" : [
                      {
                        "url" : "schedule-type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-agvs-type",
                          "code" : "DELAYED"
                        }
                      },
                      {
                        "url" : "series-type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-agvs-series-type",
                          "code" : "PRIMARY"
                        }
                      },
                      {
                        "url" : "antigen-group",
                        "valueCoding" : {
                          "system" : "http://snomed.info/sct",
                          "code" : "1119254000",
                          "display" : "PCV13"
                        }
                      },
                      {
                        "url" : "version",
                        "valueString" : "1.0"
                      }
                    ],
                    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs"
                  }
                ],
                "vaccineCode" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/sid/cvx",
                        "code" : "133",
                        "display" : "PCV13"
                      }
                    ]
                  }
                ],
                "forecastStatus" : {
                  "coding" : [
                    {
                      "system" : "https://standards.digital.health.nz/ns/air-forecast-status",
                      "code" : "GIVEN"
                    }
                  ]
                },
                "forecastReason" : [
                  {
                    "coding" : [
                      {
                        "system" : "https://standards.digital.health.nz/ns/air-terms-code",
                        "code" : "Stn",
                        "display" : "Funded, if not otherwise specified"
                      }
                    ]
                  }
                ],
                "dateCriterion" : [
                  {
                    "code" : {
                      "coding" : [
                        {
                          "system" : "http://snomed.info/sct",
                          "code" : "789539003",
                          "display" : "Date immunization due"
                        }
                      ]
                    },
                    "value" : "2024-01-27"
                  }
                ],
                "series" : "Delay 3-6M_P_PCV13_1.0",
                "doseNumberPositiveInt" : 1
              }
            ]
          }
        },
        {
          "fullUrl" : "https://localhost:8443/fhir/R4/ImmunizationRecommendation/AGVS-Delay-3-6M-P-PCV13-1.0-Dose2",
          "resource" : {
            "resourceType" : "ImmunizationRecommendation",
            "id" : "AGVS-Delay-3-6M-P-PCV13-1.0-Dose2",
            "meta" : {
              "profile" : [
                🔗 "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation"
              ]
            },
            "text" : {
              "status" : "extensions",
              "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"ImmunizationRecommendation_AGVS-Delay-3-6M-P-PCV13-1.0-Dose2\"> </a><p class=\"res-header-id\"><b>Generated Narrative: ImmunizationRecommendation AGVS-Delay-3-6M-P-PCV13-1.0-Dose2</b></p><a name=\"AGVS-Delay-3-6M-P-PCV13-1.0-Dose2\"> </a><a name=\"hcAGVS-Delay-3-6M-P-PCV13-1.0-Dose2\"> </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-immunization-recommendation.html\">AIR Immunization Recommendation</a></p></div><p><b>patient</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=http://fhir.org.nz/ig/base/Patient/ZET7992\">Patient/ZET7992</a></p><p><b>date</b>: 2025-08-05 17:00:56+1200</p><blockquote><p><b>recommendation</b></p><blockquote><p><b>id</b></p>21cdd4fc-8fad-417f-aa36-e2916a77ce4c</blockquote><blockquote><p><b>AIR Scheduled Event</b></p><ul><li>type: <a href=\"CodeSystem-air-planned-event-type-terms.html#air-planned-event-type-terms-CPE\">AIR Planned Event Type: CPE</a> (Consumer Planned Event)</li></ul></blockquote><blockquote><p><b>AIR Antigen Group Vaccination Schedule</b></p><ul><li>schedule-type: <a href=\"CodeSystem-air-agvs-type.html#air-agvs-type-DELAYED\">AIR AGVS: DELAYED</a> (Delayed)</li><li>series-type: <a href=\"CodeSystem-air-agvs-series-type.html#air-agvs-series-type-PRIMARY\">AIR AGVS Series Type: PRIMARY</a> (Primary)</li><li>antigen-group: <a href=\"http://snomed.info/id/1119254000\">SNOMED CT: 1119254000</a> (PCV13)</li><li>version: 1.0</li></ul></blockquote><p><b>vaccineCode</b>: <span title=\"Codes:{http://hl7.org/fhir/sid/cvx 133}\">PCV13</span></p><p><b>forecastStatus</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-forecast-status OVERDUE}\">Overdue</span></p><p><b>forecastReason</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-terms-code Stn}\">Funded, if not otherwise specified</span></p><h3>DateCriterions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://snomed.info/sct 789539003}\">Date immunization due</span></td><td>2024-03-23</td></tr></table><p><b>series</b>: Delay 3-6M_P_PCV13_1.0</p><p><b>doseNumber</b>: 2</p></blockquote><blockquote><p><b>recommendation</b></p><blockquote><p><b>id</b></p>bf16e22b-a03a-4b3f-8d29-7d0c9b747f9f</blockquote><blockquote><p><b>AIR Scheduled Event</b></p><ul><li>type: <a href=\"CodeSystem-air-planned-event-type-terms.html#air-planned-event-type-terms-EE\">AIR Planned Event Type: EE</a> (Expected Event)</li></ul></blockquote><blockquote><p><b>AIR Antigen Group Vaccination Schedule</b></p><ul><li>schedule-type: <a href=\"CodeSystem-air-agvs-type.html#air-agvs-type-DELAYED\">AIR AGVS: DELAYED</a> (Delayed)</li><li>series-type: <a href=\"CodeSystem-air-agvs-series-type.html#air-agvs-series-type-PRIMARY\">AIR AGVS Series Type: PRIMARY</a> (Primary)</li><li>antigen-group: <a href=\"http://snomed.info/id/1119254000\">SNOMED CT: 1119254000</a> (PCV13)</li><li>version: 1.0</li></ul></blockquote><p><b>vaccineCode</b>: <span title=\"Codes:{http://hl7.org/fhir/sid/cvx 133}\">PCV13</span></p><p><b>forecastStatus</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-forecast-status ACTIVE}\">Active</span></p><p><b>forecastReason</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-terms-code Stn}\">Funded, if not otherwise specified</span></p><h3>DateCriterions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value</b></td></tr><tr><td style=\"display: none\">*</td><td><span title=\"Codes:{http://snomed.info/sct 789539003}\">Date immunization due</span></td><td>2024-03-25</td></tr></table><p><b>series</b>: Delay 3-6M_P_PCV13_1.0</p><p><b>doseNumber</b>: 2</p></blockquote></div>"
            },
            "patient" : {
              "reference" : "Patient/ZET7992",
              "identifier" : {
                "system" : "https://standards.digital.health.nz/ns/nhi-id",
                "value" : "ZET7992"
              }
            },
            "date" : "2025-08-05T17:00:56+12:00",
            "recommendation" : [
              {
                "id" : "21cdd4fc-8fad-417f-aa36-e2916a77ce4c",
                "extension" : [
                  {
                    "extension" : [
                      {
                        "url" : "type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-scheduled-event-type-terms",
                          "code" : "CPE"
                        }
                      }
                    ],
                    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"
                  },
                  {
                    "extension" : [
                      {
                        "url" : "schedule-type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-agvs-type",
                          "code" : "DELAYED"
                        }
                      },
                      {
                        "url" : "series-type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-agvs-series-type",
                          "code" : "PRIMARY"
                        }
                      },
                      {
                        "url" : "antigen-group",
                        "valueCoding" : {
                          "system" : "http://snomed.info/sct",
                          "code" : "1119254000",
                          "display" : "PCV13"
                        }
                      },
                      {
                        "url" : "version",
                        "valueString" : "1.0"
                      }
                    ],
                    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs"
                  }
                ],
                "vaccineCode" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/sid/cvx",
                        "code" : "133",
                        "display" : "PCV13"
                      }
                    ]
                  }
                ],
                "forecastStatus" : {
                  "coding" : [
                    {
                      "system" : "https://standards.digital.health.nz/ns/air-forecast-status",
                      "code" : "OVERDUE"
                    }
                  ]
                },
                "forecastReason" : [
                  {
                    "coding" : [
                      {
                        "system" : "https://standards.digital.health.nz/ns/air-terms-code",
                        "code" : "Stn",
                        "display" : "Funded, if not otherwise specified"
                      }
                    ]
                  }
                ],
                "dateCriterion" : [
                  {
                    "code" : {
                      "coding" : [
                        {
                          "system" : "http://snomed.info/sct",
                          "code" : "789539003",
                          "display" : "Date immunization due"
                        }
                      ]
                    },
                    "value" : "2024-03-23"
                  }
                ],
                "series" : "Delay 3-6M_P_PCV13_1.0",
                "doseNumberPositiveInt" : 2
              },
              {
                "id" : "bf16e22b-a03a-4b3f-8d29-7d0c9b747f9f",
                "extension" : [
                  {
                    "extension" : [
                      {
                        "url" : "type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-scheduled-event-type-terms",
                          "code" : "EE"
                        }
                      }
                    ],
                    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-scheduled-event"
                  },
                  {
                    "extension" : [
                      {
                        "url" : "schedule-type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-agvs-type",
                          "code" : "DELAYED"
                        }
                      },
                      {
                        "url" : "series-type",
                        "valueCoding" : {
                          "system" : "https://standards.digital.health.nz/ns/air-agvs-series-type",
                          "code" : "PRIMARY"
                        }
                      },
                      {
                        "url" : "antigen-group",
                        "valueCoding" : {
                          "system" : "http://snomed.info/sct",
                          "code" : "1119254000",
                          "display" : "PCV13"
                        }
                      },
                      {
                        "url" : "version",
                        "valueString" : "1.0"
                      }
                    ],
                    "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs"
                  }
                ],
                "vaccineCode" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://hl7.org/fhir/sid/cvx",
                        "code" : "133",
                        "display" : "PCV13"
                      }
                    ]
                  }
                ],
                "forecastStatus" : {
                  "coding" : [
                    {
                      "system" : "https://standards.digital.health.nz/ns/air-forecast-status",
                      "code" : "ACTIVE"
                    }
                  ]
                },
                "forecastReason" : [
                  {
                    "coding" : [
                      {
                        "system" : "https://standards.digital.health.nz/ns/air-terms-code",
                        "code" : "Stn",
                        "display" : "Funded, if not otherwise specified"
                      }
                    ]
                  }
                ],
                "dateCriterion" : [
                  {
                    "code" : {
                      "coding" : [
                        {
                          "system" : "http://snomed.info/sct",
                          "code" : "789539003",
                          "display" : "Date immunization due"
                        }
                      ]
                    },
                    "value" : "2024-03-25"
                  }
                ],
                "series" : "Delay 3-6M_P_PCV13_1.0",
                "doseNumberPositiveInt" : 2
              }
            ]
          }
        },
        {
          "fullUrl" : "https://localhost:8443/fhir/R4/Immunization/63e060f0-a878-4a8c-a432-6712d15b1266",
          "resource" : {
            "resourceType" : "Immunization",
            "id" : "63e060f0-a878-4a8c-a432-6712d15b1266",
            "meta" : {
              "extension" : [
                {
                  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system",
                  "valueString" : "PipelinePostman"
                },
                {
                  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-by",
                  "valueString" : "PipelinePostmanUser"
                },
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/firstCreated",
                  "valueInstant" : "2025-08-04T15:12:41.892+12:00"
                },
                {
                  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by",
                  "valueString" : "PipelinePostmanUser"
                },
                {
                  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system",
                  "valueString" : "PipelinePostman"
                },
                {
                  "extension" : [
                    {
                      "url" : "dqScore",
                      "valueInteger" : 100
                    },
                    {
                      "url" : "dqLastUpdated",
                      "valueDateTime" : "2025-08-04T15:12:42.729+12:00"
                    },
                    {
                      "url" : "dqStatus",
                      "valueString" : "P"
                    }
                  ],
                  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-data-quality-assessment"
                },
                {
                  "extension" : [
                    {
                      "extension" : [
                        {
                          "url" : "plannedEventId",
                          "valueString" : "8d133802-f22f-49f8-9a38-565c494a7630"
                        },
                        {
                          "url" : "matchedDate",
                          "valueDateTime" : "2025-08-04T15:12:43.304+12:00"
                        },
                        {
                          "url" : "matchedBy",
                          "valueString" : "PipelinePostmanUser"
                        },
                        {
                          "url" : "matchedReason",
                          "valueCoding" : {
                            "code" : "303",
                            "display" : "Automatically matched by dose and alternative indication"
                          }
                        }
                      ],
                      "url" : "match"
                    }
                  ],
                  "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match"
                }
              ],
              "versionId" : "1",
              "lastUpdated" : "2025-08-04T15:12:41.892+12:00",
              "profile" : [
                🔗 "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization"
              ]
            },
            "text" : {
              "status" : "extensions",
              "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><a name=\"Immunization_63e060f0-a878-4a8c-a432-6712d15b1266\"> </a><p class=\"res-header-id\"><b>Generated Narrative: Immunization 63e060f0-a878-4a8c-a432-6712d15b1266</b></p><a name=\"63e060f0-a878-4a8c-a432-6712d15b1266\"> </a><a name=\"hc63e060f0-a878-4a8c-a432-6712d15b1266\"> </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: 2025-08-04 15:12:41+1200</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 Related Person</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=http://fhir.org.nz/ig/base/09c86dd5-64e9-414e-b97e-f6c2c1a4e65f\">09c86dd5-64e9-414e-b97e-f6c2c1a4e65f</a></p><p><b>AIR Serology Report Extension</b>: <a href=\"https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&amp;canonical=http://fhir.org.nz/ig/base/045e4457-4b8d-4ae7-bbef-655f48576558\">045e4457-4b8d-4ae7-bbef-655f48576558</a></p><blockquote><p><b>AIR Age Given Extension</b></p><ul><li>years: 0</li><li>months: 3</li><li>days: 30</li><li>daysSinceBirth: 121</li><li>precision: DAY</li></ul></blockquote><p><b>Immunization Facility Mobile Site</b>: FZZ835-E_MOB0001</p><p><b>AIR Administered Product Extension</b>: <span title=\"Codes:{http://nzmt.org.nz 10443641000116108}\">M-M-R-II</span></p><p><b>status</b>: Completed</p><p><b>statusReason</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-status-reason-terms GIVEN}\">Vaccination given</span></p><p><b>vaccineCode</b>: <span title=\"Codes:{http://hl7.org/fhir/sid/cvx 133}\">PCV</span></p><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/ZET7992\">https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZET7992</a></p><p><b>occurrence</b>: 2024-01-30</p><p><b>location</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/Location/FZZ835-E\">https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ835-E</a></p><p><b>lotNumber</b>: 555123</p><p><b>expirationDate</b>: 2027-01-31</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</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.digital.health.nz/fhir/hpi/v1/Practitioner/477616\">https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/477616</a></td></tr></table><p><b>reasonCode</b>: <span title=\"Codes:{https://standards.digital.health.nz/ns/air-terms-code 5}\">Primary course</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 16814004}\">Pneumococcal</span></td><td>1</td></tr></table><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: RelatedPerson #09c86dd5-64e9-414e-b97e-f6c2c1a4e65f</b></p><a name=\"63e060f0-a878-4a8c-a432-6712d15b1266/09c86dd5-64e9-414e-b97e-f6c2c1a4e65f\"> </a><a name=\"hc63e060f0-a878-4a8c-a432-6712d15b1266/09c86dd5-64e9-414e-b97e-f6c2c1a4e65f\"> </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/ZET7992\">https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZET7992</a></p><p><b>relationship</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode FTH}\">father</span></p><p><b>name</b>: John Jon Doe </p><p><b>telecom</b>: ph: 041234567(Home), ph: 091234567(Work), <a href=\"mailto:jodoe@moh.govt.nz\">jodoe@moh.govt.nz</a></p><p><b>address</b>: 123 Main St Neverland Wellington 6001 (home) (NZ Suburb: Johnsonville)</p></blockquote><hr/><blockquote><p class=\"res-header-id\"><b>Generated Narrative: Observation #045e4457-4b8d-4ae7-bbef-655f48576558</b></p><a name=\"63e060f0-a878-4a8c-a432-6712d15b1266/045e4457-4b8d-4ae7-bbef-655f48576558\"> </a><a name=\"hc63e060f0-a878-4a8c-a432-6712d15b1266/045e4457-4b8d-4ae7-bbef-655f48576558\"> </a><p><b>status</b>: Preliminary</p><p><b>code</b>: <span title=\"Codes:{http://snomed.info/sct 278969009}\">Hepatitis B status</span></p><p><b>effective</b>: 2023-01-01 14:12:34+1300</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" : "09c86dd5-64e9-414e-b97e-f6c2c1a4e65f",
                "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/ZET7992",
                  "identifier" : {
                    "system" : "https://standards.digital.health.nz/ns/nhi-id",
                    "value" : "ZET7992"
                  }
                },
                "relationship" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                        "code" : "FTH"
                      }
                    ]
                  }
                ],
                "name" : [
                  {
                    "family" : "Doe",
                    "given" : [
                      "John Jon"
                    ]
                  }
                ],
                "telecom" : [
                  {
                    "system" : "phone",
                    "value" : "041234567",
                    "use" : "home"
                  },
                  {
                    "system" : "phone",
                    "value" : "091234567",
                    "use" : "work"
                  },
                  {
                    "system" : "email",
                    "value" : "jodoe@moh.govt.nz",
                    "use" : "home"
                  }
                ],
                "address" : [
                  {
                    "extension" : [
                      {
                        "url" : "http://hl7.org.nz/fhir/StructureDefinition/suburb",
                        "valueString" : "Johnsonville"
                      }
                    ],
                    "use" : "home",
                    "type" : "physical",
                    "line" : [
                      "123 Main St",
                      "Neverland"
                    ],
                    "city" : "Wellington",
                    "postalCode" : "6001"
                  }
                ]
              },
              {
                "resourceType" : "Observation",
                "id" : "045e4457-4b8d-4ae7-bbef-655f48576558",
                "status" : "preliminary",
                "code" : {
                  "coding" : [
                    {
                      "system" : "http://snomed.info/sct",
                      "code" : "278969009",
                      "display" : "Hepatitis B status"
                    }
                  ]
                },
                "effectiveDateTime" : "2023-01-01T14:12:34.000+13:00",
                "interpretation" : [
                  {
                    "coding" : [
                      {
                        "system" : "https://standards.digital.health.nz/ns/air-serology-protection-terms",
                        "code" : "IND",
                        "display" : "Indeterminate"
                      }
                    ]
                  }
                ]
              }
            ],
            "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-related-person-extension",
                "valueReference" : {
                  "reference" : "09c86dd5-64e9-414e-b97e-f6c2c1a4e65f"
                }
              },
              {
                "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-extension",
                "valueReference" : {
                  "reference" : "045e4457-4b8d-4ae7-bbef-655f48576558"
                }
              },
              {
                "extension" : [
                  {
                    "url" : "years",
                    "valueInteger" : 0
                  },
                  {
                    "url" : "months",
                    "valueInteger" : 3
                  },
                  {
                    "url" : "days",
                    "valueInteger" : 30
                  },
                  {
                    "url" : "daysSinceBirth",
                    "valueInteger" : 121
                  },
                  {
                    "url" : "precision",
                    "valueString" : "DAY"
                  }
                ],
                "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"
              },
              {
                "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-mobile-site",
                "valueString" : "FZZ835-E_MOB0001"
              },
              {
                "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product",
                "valueCodeableConcept" : {
                  "coding" : [
                    {
                      "system" : "http://nzmt.org.nz",
                      "code" : "10443641000116108",
                      "display" : "M-M-R-II"
                    }
                  ],
                  "text" : "M-M-R-II"
                }
              }
            ],
            "status" : "completed",
            "statusReason" : {
              "coding" : [
                {
                  "system" : "https://standards.digital.health.nz/ns/air-status-reason-terms",
                  "code" : "GIVEN",
                  "display" : "Vaccination given"
                }
              ]
            },
            "vaccineCode" : {
              "coding" : [
                {
                  "system" : "http://hl7.org/fhir/sid/cvx",
                  "code" : "133",
                  "display" : "PCV13"
                }
              ],
              "text" : "PCV"
            },
            "patient" : {
              "reference" : "https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZET7992",
              "identifier" : {
                "system" : "https://standards.digital.health.nz/ns/nhi-id",
                "value" : "ZET7992"
              }
            },
            "occurrenceDateTime" : "2024-01-30",
            "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" : "555123",
            "expirationDate" : "2027-01-31",
            "site" : {
              "coding" : [
                {
                  "system" : "http://snomed.info/sct",
                  "version" : "1.1",
                  "code" : "16217701000119102",
                  "display" : "Structure of left deltoid muscle"
                }
              ]
            },
            "route" : {
              "coding" : [
                {
                  "system" : "http://snomed.info/sct",
                  "version" : "1.2",
                  "code" : "78421000",
                  "display" : "Intramuscular"
                }
              ]
            },
            "performer" : [
              {
                "function" : {
                  "coding" : [
                    {
                      "system" : "https://standards.digital.health.nz/ns/air-terms-code",
                      "version" : "1.0.0",
                      "code" : "VC",
                      "display" : "Vaccinator"
                    }
                  ]
                },
                "actor" : {
                  "reference" : "https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/477616",
                  "identifier" : {
                    "system" : "https://standards.digital.health.nz/ns/nursing-council-id",
                    "value" : "477616"
                  }
                }
              }
            ],
            "reasonCode" : [
              {
                "coding" : [
                  {
                    "system" : "https://standards.digital.health.nz/ns/air-terms-code",
                    "code" : "5",
                    "display" : "Primary course"
                  }
                ]
              }
            ],
            "protocolApplied" : [
              {
                "targetDisease" : [
                  {
                    "coding" : [
                      {
                        "system" : "http://snomed.info/sct",
                        "code" : "16814004",
                        "display" : "Pneumococcal"
                      }
                    ]
                  }
                ],
                "doseNumberPositiveInt" : 1
              }
            ]
          }
        }
      ]
    }