Immunization

Overview

The Immunization resource includes the view of current and historical administration of vaccinations to a patient in all healthcare settings. This resource contains the functionality to query a patient’s immunization history.

Detailed administration records may be found in MedicationAdministration, while the Immunization resource would represent the known vaccination history regardless of where the administration itself was done.

An immunization reaction may indicate an allergy or intolerance. If so, a separate AllergyIntolerance resource instance should be created as well.

The following fields are returned if valued:

Terminology Bindings

Immunization.vaccineCode
  • Description
    • Identifies the vaccine substance administered.
  • Details: CVX
    System: http://hl7.org/fhir/sid/cvx

Immunization.site
  • Description
    • The site at which the vaccine was administered.
  • Details: SNOMED CT
    System: http://snomed.info/sct

Immunization.route
  • Description
    • The path the administered medication takes to get into the body or into contact with the body.
  • Details: SNOMED CT
    System: http://snomed.info/sct

  • Details: NCI Metathesaurus
    System: http://ncimeta.nci.nih.gov

Immunization.explanation.reasonNotGiven
  • Description
    • The reason why a vaccine was not administered.
  • Details: v3 Code System ActReason
    System: http://hl7.org/fhir/v3/ActReason

Search for Immunizations that meet supplied query parameters:

GET /Immunization?:parameters

Authorization Types

Parameters

Name Required? Type Description
patient Y reference The patient for the vaccination record. Example: 12345
date N date Date range into which the immunization administration date falls. Must be prefixed by ‘ge’ or ‘le’.

Notes: - The date parameter value should be prefixed once by ‘ge’ representing the earliest date, and once by ‘le’ representing the latest date. Examples: date=ge2015-01-01&date=le2016-01-01, date=ge2015-01-01, date=le2016-01-01

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Immunization?patient=4478007

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "820593c3-6f15-417b-83bd-f55fdb1ac720",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Immunization?patient=4478007"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Immunization/M6753285",
      "resource": {
        "resourceType": "Immunization",
        "id": "M6753285",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2016-09-09T09:32:39-05:00"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Immunization</b></p><p><b>Vaccine</b>: tetanus toxoid</p><p><b>Date</b>: 2016-09-09T07:29:00-05:00</p><p><b>Given</b>: Yes</p><p><b>Administered by</b>: Fhir, Mann</p><p><b>Site</b>: Left Gluteus Medius</p><p><b>Route</b>: IM</p></div>"
        },
        "status": "completed",
        "date": "2016-09-09T07:29:00-05:00",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "112",
              "display": "tetanus toxoid, unspecified formulation",
              "userSelected": false
            }
          ],
          "text": "tetanus toxoid"
        },
        "patient": {
          "reference": "Patient/4478007",
          "display": "SMART, FRED RICK"
        },
        "wasNotGiven": false,
        "reported": false,
        "performer": {
          "reference": "Practitioner/4474007",
          "display": "Fhir, Mann"
        },
        "encounter": {
          "reference": "Encounter/4135906"
        },
        "manufacturer": {
          "display": "Johnson and Johnson/Merck Consumer"
        },
        "location": {
          "reference": "Location/35646793",
          "display": "A"
        },
        "lotNumber": "L0909",
        "expirationDate": "2017-09-11",
        "site": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "78333006",
              "display": "structure of gluteus medius muscle (body structure)",
              "userSelected": false
            }
          ],
          "text": "Left Gluteus Medius"
        },
        "route": {
          "text": "IM"
        },
        "doseQuantity": {
          "value": 1,
          "unit": "mL",
          "system": "http://unitsofmeasure.org",
          "code": "mL"
        }
      }
    }
  ]
}

Errors

The common errors may be returned.

Retrieve by id

List an individual Immunization by its id:

GET /Immunization/:id

Authorization Types

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-open.sandboxcerner.com/dstu2/0b8a0111-e8e6-4c26-a91c-5069cbc6b1ca/Immunization/M5251276

Response

Status: 200 OK
{
  "resourceType": "Immunization",
  "id": "M5251276",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2015-09-03T22:37:49-05:00"
  },
  "text": {
    "status": "generated",
    "div": "<div><p><b>Immunization</b></p><p><b>Vaccine</b>: Lyme disease vaccine</p><p><b>Date</b>: 2015-09-03T20:35:00-05:00</p><p><b>Given</b>: Yes</p><p><b>Administered by</b>: Fhir, Enginne</p><p><b>Site</b>: Left Thigh</p><p><b>Route</b>: IM</p></div>"
  },
  "status": "completed",
  "date": "2015-09-03T20:35:00-05:00",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "66",
        "display": "Lyme disease",
        "userSelected": false
      }
    ],
    "text": "Lyme disease vaccine"
  },
  "patient": {
    "reference": "Patient/1316024",
    "display": "PETERS, TIMOTHY"
  },
  "wasNotGiven": false,
  "reported": false,
  "performer": {
    "reference": "Practitioner/2270007",
    "display": "Fhir, Enginne"
  },
  "encounter": {
    "reference": "Encounter/1589927"
  },
  "manufacturer": {
    "display": "3M Pharmaceuticals"
  },
  "location": {
    "reference": "Location/4048296",
    "display": "FPC"
  },
  "lotNumber": "23234",
  "expirationDate": "2015-09-14",
  "site": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "61396006",
        "display": "structure of left thigh (body structure)",
        "userSelected": false
      }
    ],
    "text": "Left Thigh"
  },
  "route": {
    "text": "IM"
  },
  "doseQuantity": {
    "value": 1,
    "unit": "mL",
    "system": "http://unitsofmeasure.org",
    "code": "mL"
  }
}

Errors

The common errors may be returned.