# Planned Event Example - Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) v1.28.0-SNAPSHOT

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Planned Event Example**

## Example ImmunizationRecommendation: Planned Event Example

Profile: [AIR Immunization Recommendation](StructureDefinition-air-immunization-recommendation.md)

**patient**: [pat](https://simplifier.net/resolve?scope=fhir.org.nz.ig.base@2.0.0&canonical=http://fhir.org.nz/ig/base/pat)

**date**: 2021-01-20

> **recommendation**
> **id**12345-asdf
**AIR Recommendation Id**: 12345**AIR Disease Covered**: Diphtheria**AIR Disease Covered**: Tetanus**AIR Disease Covered**: Pertussis**AIR Disease Covered**: Poliomyelitis**AIR Disease Covered**: Viral Hepatitis type B**AIR Disease Covered**: Haemophilus influenzae infection
> **AIR Antigen Group Vaccination Schedule**
* schedule-type: [AIR AGVS: NIS](CodeSystem-air-agvs-type.md#air-agvs-type-NIS) (National Immunisation Schedule)
* series-type: [AIR AGVS Series Type: PRIMARY](CodeSystem-air-agvs-series-type.md#air-agvs-series-type-PRIMARY) (Primary)
* antigen-group: [SNOMED CT: 871761004](http://snomed.info/id/871761004) (RV1)
* version: 1.0

> **AIR Scheduled Event**
* type: [AIR Planned Event Type: CPE](CodeSystem-air-planned-event-type-terms.md#air-planned-event-type-terms-CPE) (Consumer Planned Event)

**vaccineCode**: DTaP-IPV-HepB/Hib**forecastStatus**: Due

### DateCriterions

| | | |
| :--- | :--- | :--- |
| - | **Code** | **Value** |
| * | DUE | 2021-01-14 |

**series**: DTaP-IPV-HepB/Hib**doseNumber**: 1



## Resource Content

```json
{
  "resourceType" : "ImmunizationRecommendation",
  "id" : "ir1",
  "meta" : {
    "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization-recommendation"]
  },
  "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
  }]
}

```
