Home
FHIR® API actions
Medication
Retrieve a patient's vaccination history

Retrieve a patient's vaccination history

If you want to access a patient’s vaccination history—as documented by a specific organization—you can use this API action to retrieve a list. Typically, you can use this for:

  • tracking a patient’s vaccinations; or
  • making targeted recommendations for immunizations to patients.

With this API action, you can retrieve information like dose, manufacturer, lot, route number, and more.

Supported systems

You can use this API action with the Redox FHIR® API.

Your connection's system can return results with their own FHIR® or query-based API.

Things you need to know

Action steps

Prerequisites

The following actions must be completed before attempting the steps below.

Steps
  • 1
    Retrieve a patient's vaccinations
    required

This table has notes about how to use parameters for this API action specifically, but it's not exhaustive. Refer to the Immunization resource schema for more details.

Query parameter
Required
Notes
patient.identifier
Y
You must include at least one identifier for the patient that's used by the EHR system you're querying. If you don't have a patient identifier, you can find one by searching for a patient with demographics.

The response contains one or more vaccinations for an individual patient. You can find the total number of included vaccinations in the total array for FHIR® responses.

We recommend that you check the StatusReason field to ascertain whether a vaccination was administered. If populated, it should contain a reason for not administering a vaccination. If the field is empty, it’s likely that the vaccination was successfully administered. 

Query Response
curl 'https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Immunization/_search' \
--request POST \
--header 'Authorization: Bearer ${API_TOKEN}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'patient=Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7'
{
  "id": "eb8215ca-9ce8-43ea-bf65-4f9828bfc87a",
  "type": "searchset",
  "entry": [
    {
      "search": {
        "mode": "match",
        "score": 1
      },
      "resource": {
        "id": "4180c215-5c39-4da0-989f-ed861dd32c91",
        "meta": {
          "lastUpdated": "2022-12-02T21:06:21.612Z"
        },
        "note": [
          {
            "text": "Notes on administration of vaccine"
          }
        ],
        "site": {
          "coding": [
            {
              "code": "LA",
              "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
              "display": "left arm"
            }
          ]
        },
        "route": {
          "coding": [
            {
              "code": "IM",
              "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
              "display": "Injection, intramuscular"
            }
          ]
        },
        "status": "completed",
        "patient": {
          "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
        },
        "education": [
          {
            "documentType": "253088698300010311120702",
            "publicationDate": "2012-07-02",
            "presentationDate": "2013-01-10"
          }
        ],
        "lotNumber": "AAJN11K",
        "performer": [
          {
            "actor": {
              "reference": "Practitioner/dbed0f85-e3cd-47ac-9305-3f629e138832"
            },
            "function": {
              "coding": [
                {
                  "code": "OP",
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0443"
                }
              ]
            }
          },
          {
            "actor": {
              "reference": "Practitioner/dbed0f85-e3cd-47ac-9305-3f629e138832"
            },
            "function": {
              "coding": [
                {
                  "code": "AP",
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0443"
                }
              ]
            }
          }
        ],
        "identifier": [
          {
            "value": "9800440089",
            "system": "urn:redox:redox-fhir-sandbox:Immunization",
            "extension": [
              {
                "url": "https://fhir.redoxengine.com/StructureDefinition/identifier-origin",
                "valueString": "RedoxAPI"
              }
            ]
          }
        ],
        "reasonCode": [
          {
            "coding": [
              {
                "code": "429060002",
                "system": "http://snomed.info/sct"
              }
            ]
          }
        ],
        "isSubpotent": true,
        "vaccineCode": {
          "text": "Fluvax (Influenza)",
          "coding": [
            {
              "code": "FLUVAX",
              "system": "urn:oid:1.2.36.1.2001.1005.17"
            }
          ]
        },
        "doseQuantity": {
          "code": "mg",
          "value": 5,
          "system": "http://unitsofmeasure.org"
        },
        "resourceType": "Immunization",
        "fundingSource": {
          "coding": [
            {
              "code": "private",
              "system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source"
            }
          ]
        },
        "primarySource": true,
        "expirationDate": "2015-02-15",
        "occurrenceDateTime": "2013-01-10T10:00:00.000Z",
        "programEligibility": [
          {
            "coding": [
              {
                "code": "ineligible",
                "system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility"
              }
            ]
          }
        ]
      }
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}