Millennium

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.
  • Note
    • The CVX binding will always be returned. A NDC binding will be returned when available.

  • Details: CVX
    System: http://hl7.org/fhir/sid/cvx

  • Details: NDC
    System: http://hl7.org/fhir/sid/ndc

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

Provider | Patient | System

Parameters

Name Required? Type Description
_id This, or patient token The logical resource id associated with the resource.
patient This, or _id 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:

Headers

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

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization?patient=12724066

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "13809232-3eab-4d1a-a1a4-42bc9aa6e381",
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization?patient=12724066"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986",
      "resource": {
        "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986",
        "resource": {
          "resourceType": "Immunization",
          "id": "M197197986",
          "meta": {
            "versionId": "1",
            "lastUpdated": "2019-12-26T13:12:59-06:00"
          },
          "text": {
            "status": "generated",
            "div": "<div><p><b>Immunization</b></p><p><b>Status</b>: Completed</p><p><b>Vaccine</b>: tetanus toxoid</p><p><b>Date</b>: 1982</p><p><b>Patient Name</b>: SMART, NANCY</p><p><b>Given</b>: Yes</p><p><b>Administered by</b>: Graham, Joshua</p><p><b>Reported</b>: Yes</p></div>"
          },
          "status": "completed",
          "date": "1982",
          "vaccineCode": {
            "coding": [
              {
                "system": "http://hl7.org/fhir/sid/cvx",
                "code": "112",
                "display": "tetanus toxoid, unspecified formulation",
                "userSelected": false
              }
            ],
            "text": "tetanus toxoid"
          },
          "patient": {
            "reference": "Patient/12724066",
            "display": "SMART, NANCY"
          },
          "wasNotGiven": false,
          "reported": true,
          "performer": {
            "reference": "Practitioner/12724045",
            "display": "Graham, Joshua"
          },
          "encounter": {
            "reference": "Encounter/97939518"
          },
          "location": {
            "reference": "Location/32545019",
            "display": "A"
          },
          "doseQuantity": {
            "value": 0.0,
            "unit": "unknown unit",
            "system": "http://unitsofmeasure.org",
            "code": "{unknownunit}"
          }
        }
      }
    },
    {
      "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197982",
      "resource": {
        "resourceType": "Immunization",
        "id": "M197197982",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2019-12-26T13:12:59-06:00"
        },
        "text": {
          "status": "generated",
          "div": "<div><p><b>Immunization</b></p><p><b>Status</b>: Completed</p><p><b>Vaccine</b>: influenza virus vaccine, live</p><p><b>Date</b>: 2019</p><p><b>Patient Name</b>: SMART, NANCY</p><p><b>Given</b>: Yes</p><p><b>Administered by</b>: Graham, Joshua</p><p><b>Reported</b>: Yes</p></div>"
        },
        "status": "completed",
        "date": "2019",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "111",
              "display": "influenza, live, intranasal",
              "userSelected": false
            }
          ],
          "text": "influenza virus vaccine, live"
        },
        "patient": {
          "reference": "Patient/12724066",
          "display": "SMART, NANCY"
        },
        "wasNotGiven": false,
        "reported": true,
        "performer": {
          "reference": "Practitioner/12724045",
          "display": "Graham, Joshua"
        },
        "encounter": {
          "reference": "Encounter/97939518"
        },
        "location": {
          "reference": "Location/32545019",
          "display": "A"
        },
        "doseQuantity": {
          "value": 0.0,
          "unit": "unknown unit",
          "system": "http://unitsofmeasure.org",
          "code": "{unknownunit}"
        }
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by id

List an individual Immunization by its id:

GET /Immunization/:id

Authorization Types

Provider | Patient | System

Headers

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

Example

Request

GET https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986

Response

Status: 200 OK
{
  "fullUrl": "https://fhir-open.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986",
  "resource": {
    "resourceType": "Immunization",
    "id": "M197197986",
    "meta": {
      "versionId": "1",
      "lastUpdated": "2019-12-26T13:12:59-06:00"
    },
    "text": {
      "status": "generated",
      "div": "<div><p><b>Immunization</b></p><p><b>Status</b>: Completed</p><p><b>Vaccine</b>: tetanus toxoid</p><p><b>Date</b>: 1982</p><p><b>Patient Name</b>: SMART, NANCY</p><p><b>Given</b>: Yes</p><p><b>Administered by</b>: Graham, Joshua</p><p><b>Reported</b>: Yes</p></div>"
    },
    "status": "completed",
    "date": "1982",
    "vaccineCode": {
      "coding": [
        {
          "system": "http://hl7.org/fhir/sid/cvx",
          "code": "112",
          "display": "tetanus toxoid, unspecified formulation",
          "userSelected": false
        }
      ],
      "text": "tetanus toxoid"
    },
    "patient": {
      "reference": "Patient/12724066",
      "display": "SMART, NANCY"
    },
    "wasNotGiven": false,
    "reported": true,
    "performer": {
      "reference": "Practitioner/12724045",
      "display": "Graham, Joshua"
    },
    "encounter": {
      "reference": "Encounter/97939518"
    },
    "location": {
      "reference": "Location/32545019",
      "display": "A"
    },
    "doseQuantity": {
      "value": 0.0,
      "unit": "unknown unit",
      "system": "http://unitsofmeasure.org",
      "code": "{unknownunit}"
    }
  }
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.