Get a list of Allergies
GET {{baseUrl}}/api/v2/AllergyIntolerance?patient=<string>&departmentId=<string>&_count=<integer>&_offset=<integer>&category=environment&asserter=<string>&clinical-status=resolved&code=<string>&criticality=high&date=<date>&encounter=<string>&identifier=<string>&include=<string>&last-date=<date>&manifestation=<string>&onset=<date>&patient-facing-call=<boolean>&practitioner=<string>&quorum=<boolean>&recorder=<string>&route=<string>&severity=mild&third-party-user-name=<string>&type=findings&verification-status=entered-in-error
Overview:
A targeted request enabling providers to add new allergy or intolerance records for a patient or propagate entries from integrated systems, with encoded substance, criticality, and reaction details, into the consolidated allergy profile for downstream alerts preventing adverse events.
Use Cases:
EHR Documentation Workflows: Structured allergy entry forms
Inpatient Pharmacy Intake: Propagate new inpatient reactions
Clinical Trial Adverse Event Monitoring: Encoded observable details
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
patient | string | (Required) The unique identifier of the patient | |
departmentId | string | (Required) The department identifier | |
_count | string | Number of records to return | |
_offset | string | Number of records to skip | |
category | string | Category of the allergy or intolerance | |
asserter | string | Source of the information about the allergy | |
clinical-status | string | The clinical status of the allergy or intolerance | |
code | string | Code that identifies the allergy or intolerance | |
criticality | string | Estimated potential clinical harm | |
date | string | Date record was believed accurate | |
encounter | string | Encounter when the allergy or intolerance was asserted | |
identifier | string | External ids for this item | |
include | string | Additional resources to include in the response | |
last-date | string | Date of last known occurrence of a reaction | |
manifestation | string | Clinical symptoms/signs associated with the allergy or intolerance | |
onset | string | Date when allergy or intolerance was identified | |
patient-facing-call | string | Indicates if the call is patient-facing | |
practitioner | string | ID of the practitioner associated with the allergy | |
quorum | string | Sets sync/async mode | |
recorder | string | Who recorded the sensitivity | |
route | string | How the subject was exposed to the substance | |
severity | string | Type of severity of the reaction | |
third-party-user-name | string | Username of the third-party user | |
type | string | Allergy or intolerance - Underlying mechanism (if known) | |
verification-status | string | Unconfirmed, confirmed, refuted, entered-in-error |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","patient":{"reference":"\u003cstring\u003e"},"code":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"category":["\u003cstring\u003e","\u003cstring\u003e"],"criticality":"\u003cstring\u003e","note":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"reaction":[{"manifestation":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]}],"severity":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"}]},{"manifestation":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]}],"severity":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"}]}]}},{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","patient":{"reference":"\u003cstring\u003e"},"code":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"category":["\u003cstring\u003e","\u003cstring\u003e"],"criticality":"\u003cstring\u003e","note":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"reaction":[{"manifestation":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]}],"severity":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"}]},{"manifestation":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]}],"severity":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"}]}]}}],"meta":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e","valueDateTime":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e","valueDateTime":"\u003cstring\u003e"}]}}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","patient":{"reference":"\u003cstring\u003e"},"code":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"category":["\u003cstring\u003e","\u003cstring\u003e"],"criticality":"\u003cstring\u003e","note":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"reaction":[{"manifestation":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]}],"severity":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"}]},{"manifestation":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]}],"severity":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"}]}]}},{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","patient":{"reference":"\u003cstring\u003e"},"code":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"category":["\u003cstring\u003e","\u003cstring\u003e"],"criticality":"\u003cstring\u003e","note":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"reaction":[{"manifestation":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]}],"severity":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"}]},{"manifestation":[{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]},{"coding":[{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cinteger\u003e","display":"\u003cstring\u003e"}]}],"severity":"\u003cstring\u003e","extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e"}]}]}}],"meta":{"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e","valueDateTime":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e","valueBoolean":"\u003cboolean\u003e","valueDateTime":"\u003cstring\u003e"}]}}}]