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:
To use this API action, you must know the patient identifier. If you don’t, you must locate the appropriate identifier first. Learn how to search for a patient with demographics.
With this API action, you can retrieve information like dose, manufacturer, lot, route number, and more.
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.
You can only search and receive vaccination data from one organization for one patient—unless you’re requesting data from a state registry or similar network. If you want a more comprehensive list, you must perform this API action for every organization you’re interested in receiving data from.
Vaccinations are typically represented in RxNorm, National Drug Code (NDC), or Vaccine Administered Code Set (VCX) codes.
Sometimes a provider recommends a vaccination that the patient declines. However, the provider still documents the offered vaccination. Depending on the connection's system, it might be difficult to tell that the vaccination wasn’t actually administered.
We recommend that you check the status of the vaccination to ascertain whether a vaccination was administered. If a status is present, it should contain a reason for not administering a vaccination; so, if a status isn’t present, it’s likely that the vaccination was administered.
Does this API action seem like a good fit for your unique workflow? If so, let your Redox rep know! You can begin development by downloading the relevant resource schema (which is noted in the relevant action step below), and deciding which data elements you need. Then head over to our Quickstart guide to dive right in.
If you're not engaged with our sales team yet, talk to a Redoxer to get started.
The following actions must be completed before attempting the steps below.
This table has notes about how to use parameters for this API action specifically, but it's not exhaustive. Refer to the 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.
curl ---location --request POST 'https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Immunization/_search' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'Authorization: Bearer ${API_TOKEN}' \--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"}