If you want to access a patient’s current allergies—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. .
You can use this API action with the Redox FHIR® API.
It’s also possible to use the Redox Data Model API for this API action. Talk to a Redoxer to learn about your options if you want to use alternative integration methods.
Your connection's system can return results with their own FHIR® or query-based API.
You can only search and receive allergy data from one organization for one patient. If you want a more comprehensive list, you must perform this API action for every organization you’re interested in receiving data from.
Allergies are typically represented in RxNorm codes, but some EHR systems may record allergies as free text. If this happens, Redox passes these values through as a normal text string. We recommend that you work with your connection to understand what codesets to expect for allergies.
You can locate a patient’s allergies to medication, food, or materials, to name a few. But a documented allergy may be active or resolved, and the patient’s reaction may be anywhere from moderate to severe. The response you receive contains information to create a holistic view of the documented allergy so that you know whether the allergy is current and needs to be treated, or how severe the patient’s reaction may be for a given allergy.
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. |
clinical-status | Defines the status of the allergy (either active or inactive ). |
The response contains one or more allergies for an individual patient. In a FHIR® response, you can find the total number of included medications in the total
array.
It’s also possible that you receive an empty response body with no listed allergies. This doesn’t necessarily mean that the patient is allergy-free; it only means that the organization hasn’t documented any known allergies for the patient.
The returned data fields that should help inform your workflow the most are the clinicalStatus[]
and reaction[]
arrays.
curl --location --request POST 'https://api.redoxengine.com/fhir/R4/epic-fhir-sandbox/Development/AllergyIntolerance/_search' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'Authorization: Bearer ${API_TOKEN}' \--data-urlencode 'patient: egqBHVfQlt4Bw3XGXoxVxHg3' \--data-urlencode 'clinical-status: active'
{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/AllergyIntolerance?_id=&_include=&_revinclude=&_sort=&_count=&clinical-status=active&patient=egqBHVfQlt4Bw3XGXoxVxHg3","relation": "self"}],"type": "searchset","entry": [{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/AllergyIntolerance/eND7CmZvBZzYkROEJRaJNPg3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/AllergyIntolerance/eND7CmZvBZzYkROEJRaJNPg3","resource": {"id": "eND7CmZvBZzYkROEJRaJNPg3","code": {"text": "LACTOSE","coding": [{"code": "6211","system": "http://www.nlm.nih.gov/research/umls/rxnorm","display": "LACTOSE"},{"code": "1305527","system": "http://www.nlm.nih.gov/research/umls/rxnorm"},{"code": "1307662","system": "http://www.nlm.nih.gov/research/umls/rxnorm"},{"code": "3SY5LH9PMK","system": "urn:oid:2.16.840.1.113883.4.9"},{"code": "EWQ57Q8I5X","system": "urn:oid:2.16.840.1.113883.4.9"},{"code": "J2B2A4N98G","system": "urn:oid:2.16.840.1.113883.4.9"}]},"patient": {"display": "Davis, Elijah John","reference": "Patient/egqBHVfQlt4Bw3XGXoxVxHg3"},"category": ["medication"],"reaction": [{"severity": "moderate","description": "GI intolerance","manifestation": [{"text": "GI intolerance","coding": [{"code": "Nausea","system": "http://snomed.info/sct"}]}]}],"onsetPeriod": {"start": "2010"},"recordedDate": "2019-05-24T20:18:04Z","resourceType": "AllergyIntolerance","clinicalStatus": {"coding": [{"code": "active","system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical","display": "Active","version": "4.0.0"}]},"verificationStatus": {"coding": [{"code": "confirmed","system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification","display": "Confirmed","version": "4.0.0"}]}}},{"link": [{"url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/AllergyIntolerance/ebQl6qITL5qCOEvKKdxylgg3","relation": "self"}],"search": {"mode": "match"},"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/AllergyIntolerance/ebQl6qITL5qCOEvKKdxylgg3","resource": {"id": "ebQl6qITL5qCOEvKKdxylgg3","code": {"text": "LATEX","coding": [{"code": "1314891","system": "http://www.nlm.nih.gov/research/umls/rxnorm","display": "LATEX"},{"code": "2LQ0UUW8IN","system": "urn:oid:2.16.840.1.113883.4.9"},{"code": "544D0W9VKA","system": "urn:oid:2.16.840.1.113883.4.9"}]},"patient": {"display": "Davis, Elijah John","reference": "Patient/egqBHVfQlt4Bw3XGXoxVxHg3"},"category": ["medication"],"reaction": [{"severity": "moderate","description": "Hives","manifestation": [{"text": "Hives","coding": [{"code": "Hives","system": "http://snomed.info/sct"}]}]},{"severity": "moderate","description": "Itching","manifestation": [{"text": "Itching","coding": [{"code": "Itching","system": "http://snomed.info/sct"}]}]}],"onsetPeriod": {"start": "2015-06-17"},"recordedDate": "2019-05-24T20:19:17Z","resourceType": "AllergyIntolerance","clinicalStatus": {"coding": [{"code": "active","system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical","display": "Active","version": "4.0.0"}]},"verificationStatus": {"coding": [{"code": "confirmed","system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification","display": "Confirmed","version": "4.0.0"}]}}}],"total": 2,"resourceType": "Bundle"}