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. .
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 or National Drug Code (NDC) 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.
This API action comprises one step.
Required search parameters | Description |
---|---|
patient | Include the patient resource.id , which can be returned from a search 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/epic-fhir-sandbox/Development/Immunization/_search' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'Authorization: Bearer ${API_TOKEN}' \--data-urlencode 'patient: eAB3mDIBBcyUKviyzrxsnAw3'
{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization?_id=&_include=&_revinclude=&_sort=&_count=&date=&patient=eAB3mDIBBcyUKviyzrxsnAw3&status=","relation": "self"}],"type": "searchset","entry": [{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/eLfCxkFfWmaDt5ZdAaMYZYw3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/eLfCxkFfWmaDt5ZdAaMYZYw3","resource": {"id": "eLfCxkFfWmaDt5ZdAaMYZYw3","note": [{"text": "WI Family Medicince"}],"status": "completed","patient": {"display": "Powell, Desiree Caroline","reference": "Patient/eAB3mDIBBcyUKviyzrxsnAw3"},"encounter": {"reference": "Encounter/es09oReoYsZk20hcbnd7r4A3"},"lotNumber": "156","identifier": [{"use": "usual","value": "29338","system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.768076"}],"vaccineCode": {"text": "DTaP","coding": [{"code": "20","system": "http://hl7.org/fhir/sid/cvx"}]},"doseQuantity": {"code": "1","unit": "mL","value": 0.5,"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4019"},"manufacturer": {"display": "GlaxoSmithKline"},"resourceType": "Immunization","primarySource": false,"occurrenceDateTime": "2015-01-06"}},{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/ejWXcpMg1lzyY7ZMafFIskQ3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/ejWXcpMg1lzyY7ZMafFIskQ3","resource": {"id": "ejWXcpMg1lzyY7ZMafFIskQ3","note": [{"text": "WI Family Medicince"}],"status": "completed","patient": {"display": "Powell, Desiree Caroline","reference": "Patient/eAB3mDIBBcyUKviyzrxsnAw3"},"encounter": {"reference": "Encounter/es09oReoYsZk20hcbnd7r4A3"},"lotNumber": "963","identifier": [{"use": "usual","value": "29339","system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.768076"}],"vaccineCode": {"text": "DTaP","coding": [{"code": "20","system": "http://hl7.org/fhir/sid/cvx"}]},"doseQuantity": {"code": "1","unit": "mL","value": 0.5,"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4019"},"manufacturer": {"display": "GlaxoSmithKline"},"resourceType": "Immunization","primarySource": false,"occurrenceDateTime": "2015-03-17"}},{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/eXSvUcV2Op9kl6dWHc0gk8Q3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/eXSvUcV2Op9kl6dWHc0gk8Q3","resource": {"id": "eXSvUcV2Op9kl6dWHc0gk8Q3","note": [{"text": "WI Family Medicince"}],"status": "completed","patient": {"display": "Powell, Desiree Caroline","reference": "Patient/eAB3mDIBBcyUKviyzrxsnAw3"},"encounter": {"reference": "Encounter/es09oReoYsZk20hcbnd7r4A3"},"lotNumber": "1089","identifier": [{"use": "usual","value": "29340","system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.768076"}],"vaccineCode": {"text": "DTaP","coding": [{"code": "20","system": "http://hl7.org/fhir/sid/cvx"}]},"doseQuantity": {"code": "1","unit": "mL","value": 0.5,"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4019"},"manufacturer": {"display": "GlaxoSmithKline"},"resourceType": "Immunization","primarySource": false,"occurrenceDateTime": "2015-05-28"}},{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/eP9iaYOhVjU5lAja0sOn8fw3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/eP9iaYOhVjU5lAja0sOn8fw3","resource": {"id": "eP9iaYOhVjU5lAja0sOn8fw3","note": [{"text": "WI Family Medicince"}],"status": "completed","patient": {"display": "Powell, Desiree Caroline","reference": "Patient/eAB3mDIBBcyUKviyzrxsnAw3"},"encounter": {"reference": "Encounter/es09oReoYsZk20hcbnd7r4A3"},"lotNumber": "2693","identifier": [{"use": "usual","value": "29341","system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.768076"}],"vaccineCode": {"text": "DTaP","coding": [{"code": "20","system": "http://hl7.org/fhir/sid/cvx"}]},"doseQuantity": {"code": "1","unit": "mL","value": 0.5,"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4019"},"manufacturer": {"display": "GlaxoSmithKline"},"resourceType": "Immunization","primarySource": false,"occurrenceDateTime": "2016-01-20"}},{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/e2Y6vNZ-vOq0qM9mMKjdRsA3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/e2Y6vNZ-vOq0qM9mMKjdRsA3","resource": {"id": "e2Y6vNZ-vOq0qM9mMKjdRsA3","note": [{"text": "WI Family Medicine"}],"status": "completed","patient": {"display": "Powell, Desiree Caroline","reference": "Patient/eAB3mDIBBcyUKviyzrxsnAw3"},"encounter": {"reference": "Encounter/es09oReoYsZk20hcbnd7r4A3"},"lotNumber": "8741","identifier": [{"use": "usual","value": "29342","system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.768076"}],"vaccineCode": {"text": "MMR","coding": [{"code": "03","system": "http://hl7.org/fhir/sid/cvx"}]},"doseQuantity": {"code": "1","unit": "mL","value": 0.5,"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4019"},"manufacturer": {"display": "Novavax Inc"},"resourceType": "Immunization","primarySource": false,"occurrenceDateTime": "2016-01-20"}},{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/eLbU-jCL9uorPAn61jsjp7g3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/eLbU-jCL9uorPAn61jsjp7g3","resource": {"id": "eLbU-jCL9uorPAn61jsjp7g3","site": {"text": "Left vastus lateralis","coding": [{"code": "1","system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4040","display": "Left vastus lateralis"}]},"route": {"text": "Intramuscular","coding": [{"code": "2","system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4030","display": "Intramuscular"}]},"status": "completed","patient": {"display": "Powell, Desiree Caroline","reference": "Patient/eAB3mDIBBcyUKviyzrxsnAw3"},"encounter": {"reference": "Encounter/es09oReoYsZk20hcbnd7r4A3"},"lotNumber": "48973","performer": [{"actor": {"display": "Family Medicine, Physician, MD","reference": "Practitioner/eM5CWtq15N0WJeuCet5bJlQ3"},"function": {"text": "Administering Provider","coding": [{"code": "AP","system": "http://terminology.hl7.org/CodeSystem/v2-0443","display": "Administering Provider"}]}}],"identifier": [{"use": "usual","value": "29343","system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.768076"}],"vaccineCode": {"text": "DTaP","coding": [{"code": "20","system": "http://hl7.org/fhir/sid/cvx"},{"code": "58160-810-01","system": "http://hl7.org/fhir/sid/ndc"}]},"doseQuantity": {"code": "1","unit": "mL","value": 0.5,"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4019"},"manufacturer": {"display": "Sanofi Pasteur"},"resourceType": "Immunization","primarySource": true,"occurrenceDateTime": "2019-05-28"}},{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/e.szGGbVgECad5ALVttEBdw3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Immunization/e.szGGbVgECad5ALVttEBdw3","resource": {"id": "e.szGGbVgECad5ALVttEBdw3","site": {"text": "Left Thigh","coding": [{"code": "22","system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4040","display": "Left Thigh"}]},"route": {"text": "Subcutaneous","coding": [{"code": "5","system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4030","display": "Subcutaneous"}]},"status": "completed","patient": {"display": "Powell, Desiree Caroline","reference": "Patient/eAB3mDIBBcyUKviyzrxsnAw3"},"encounter": {"reference": "Encounter/es09oReoYsZk20hcbnd7r4A3"},"lotNumber": "AMB MMR LOT","performer": [{"actor": {"display": "Family Medicine, Physician, MD","reference": "Practitioner/eM5CWtq15N0WJeuCet5bJlQ3"},"function": {"text": "Administering Provider","coding": [{"code": "AP","system": "http://terminology.hl7.org/CodeSystem/v2-0443","display": "Administering Provider"}]}}],"identifier": [{"use": "usual","value": "29344","system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.768076"}],"vaccineCode": {"text": "MMR","coding": [{"code": "03","system": "http://hl7.org/fhir/sid/cvx"},{"code": "0006-4681-01","system": "http://hl7.org/fhir/sid/ndc"}]},"doseQuantity": {"code": "1","unit": "mL","value": 0.5,"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.768076.4019"},"manufacturer": {"display": "GeoVax Labs Inc"},"resourceType": "Immunization","primarySource": true,"occurrenceDateTime": "2019-05-28"}}],"total": 7,"resourceType": "Bundle"}