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

## : Planned Event Example - JSON Representation

Raw json | Download

    {
      "resourceType" : "ImmunizationRecommendation",
      "id" : "ir1",
      "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\"><p class=\"res-header-id\"><b>Generated Narrative: ImmunizationRecommendation ir1</b></p><a name=\"ir1\"> </a><a name=\"hcir1\"> </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/pat\">pat</a></p><p><b>date</b>: 2021-01-20</p><blockquote><p><b>recommendation</b></p><blockquote><p><b>id</b></p>12345-asdf</blockquote><p><b>AIR Recommendation Id</b>: 12345</p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 397428000}\">Diphtheria</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 76902006}\">Tetanus</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 27836007}\">Pertussis</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 398102009}\">Poliomyelitis</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 66071002}\">Viral Hepatitis type B</span></p><p><b>AIR Disease Covered</b>: <span title=\"Codes:{http://snomed.info/sct 91428005}\">Haemophilus influenzae infection</span></p><blockquote><p><b>AIR Antigen Group Vaccination Schedule</b></p><ul><li>schedule-type: <a href=\"CodeSystem-air-agvs-type.html#air-agvs-type-NIS\">AIR AGVS: NIS</a> (National Immunisation Schedule)</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/871761004\">SNOMED CT: 871761004</a> (RV1)</li><li>version: 1.0</li></ul></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><p><b>vaccineCode</b>: <span title=\"Codes:{http://nzmt.org.nz 29455411000116105}\">DTaP-IPV-HepB/Hib</span></p><p><b>forecastStatus</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/immunization-recommendation-status due}\">Due</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:\">DUE</span></td><td>2021-01-14</td></tr></table><p><b>series</b>: DTaP-IPV-HepB/Hib</p><p><b>doseNumber</b>: 1</p></blockquote></div>"
      },
      "patient" : {
        "reference" : "pat"
      },
      "date" : "2021-01-20",
      "recommendation" : [
        {
          "id" : "12345-asdf",
          "extension" : [
            {
              "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-consumer-state",
              "valueString" : "12345"
            },
            {
              "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "397428000",
                    "display" : "Diphtheria"
                  }
                ]
              }
            },
            {
              "extension" : [
                {
                  "url" : "schedule-type",
                  "valueCoding" : {
                    "system" : "https://standards.digital.health.nz/ns/air-agvs-type",
                    "code" : "NIS"
                  }
                },
                {
                  "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" : "871761004",
                    "display" : "RV1"
                  }
                },
                {
                  "url" : "version",
                  "valueString" : "1.0"
                }
              ],
              "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-agvs"
            },
            {
              "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"
            },
            {
              "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "76902006",
                    "display" : "Tetanus"
                  }
                ]
              }
            },
            {
              "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "27836007",
                    "display" : "Pertussis"
                  }
                ]
              }
            },
            {
              "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "398102009",
                    "display" : "Poliomyelitis"
                  }
                ]
              }
            },
            {
              "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "66071002",
                    "display" : "Viral Hepatitis type B"
                  }
                ]
              }
            },
            {
              "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-disease-covered",
              "valueCodeableConcept" : {
                "coding" : [
                  {
                    "system" : "http://snomed.info/sct",
                    "code" : "91428005",
                    "display" : "Haemophilus influenzae infection"
                  }
                ]
              }
            }
          ],
          "vaccineCode" : [
            {
              "coding" : [
                {
                  "system" : "http://nzmt.org.nz",
                  "code" : "29455411000116105",
                  "display" : "DTaP-IPV-HepB/Hib"
                }
              ]
            }
          ],
          "forecastStatus" : {
            "coding" : [
              {
                "system" : "http://terminology.hl7.org/CodeSystem/immunization-recommendation-status",
                "code" : "due"
              }
            ]
          },
          "dateCriterion" : [
            {
              "code" : {
                "coding" : [
                  {
                    "code" : "DUE"
                  }
                ]
              },
              "value" : "2021-01-14"
            }
          ],
          "series" : "DTaP-IPV-HepB/Hib",
          "doseNumberPositiveInt" : 1
        }
      ]
    }