R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Immunizationrecommendation-example.json

Public Health and Emergency Response Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Patient

Raw JSON (canonical form)

Example of immunizationrecommendation using a vaccine code

{
  "resourceType": "ImmunizationRecommendation",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Authored by Joginder Madra</div>"
  },
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1235"
    }
  ],
  "patient": {
    "reference": "Patient/example"
  },
  "date": "2015-02-09T11:04:15.817-05:00",
  "authority": {
    "reference": "Organization/hl7"
  },
  "recommendation": [
    {
      "vaccineCode": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "14745005",
              "display": "Hepatitis A vaccine"
            }
          ]
        }
      ],
      "forecastStatus": {
        "text": "Not Complete"
      },
      "dateCriterion": [
        {
          "code": {
            "coding": [
              {
                "system": "http://hl7.org/fhir/immunization-recommendation-date-criterion",
                "code": "earliest",
                "display": "Earliest Date"
              }
            ]
          },
          "value": "2015-12-01T00:00:00-05:00"
        },
        {
          "code": {
            "coding": [
              {
                "system": "http://hl7.org/fhir/immunization-recommendation-date-criterion",
                "code": "recommended",
                "display": "Recommended"
              }
            ]
          },
          "value": "2015-12-01T00:00:00-05:00"
        },
        {
          "code": {
            "coding": [
              {
                "system": "http://hl7.org/fhir/immunization-recommendation-date-criterion",
                "code": "overdue",
                "display": "Past Due Date"
              }
            ]
          },
          "value": "2016-12-28T00:00:00-05:00"
        }
      ],
      "description": "First sequence in protocol",
      "series": "Vaccination Series 1",
      "doseNumber": 1,
      "seriesDoses": 3,
      "supportingImmunization": [
        {
          "reference": "Immunization/example"
        }
      ],
      "supportingPatientInformation": [
        {
          "reference": "Observation/example"
        }
      ]
    }
  ]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.