--- title: "Retrieve an allergy" url: "https://docs.unified.to/healthcare/allergy/Retrieve_an_allergy" description: "Retrieve an allergy with Unified's Allergy API (GET /healthcare/{connection_id}/allergy/{id}). Filter by fields and raw. Supported by 15 Allergy integrations." --- # Retrieve an allergy GET/healthcare/{connection\_id}/allergy/{id} ## Parameters **fields**string array id created\_at updated\_at patient\_id encounter\_id practitioner\_id name codes status type criticality reactions onset\_at recorded\_at notes metadata raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection **id**string required ID of the Allergy ## Returns [HealthcareAllergy](https://docs.unified.to/healthcare/allergy/model.md) | Response field | Type | Required | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------------------------------------------------------------------------------- | | id | string | No | Unique identifier for the allergy/intolerance | | created\_at | string (date-time) | No | When the allergy record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the allergy record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | patient\_id | string | No | The patient who has the allergy | | encounter\_id | string | No | The encounter in which the allergy was recorded | | practitioner\_id | string | No | The practitioner who recorded or asserted the allergy | | name | string | No | Human-readable name of the substance | | codes | [HealthcareCode](https://docs.unified.to/healthcare/allergy/Retrieve%5Fan%5Fallergy.md#HealthcareCode)\[\] | No | Codings for the substance (e.g. RxNorm, SNOMED CT) | | codes\[\].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) | | codes\[\].code | string | No | The code within the system | | codes\[\].display | string | No | Human-readable display text for the code | | status | enum | No | Clinical status of the allergy Values: ACTIVE, INACTIVE, RESOLVED, OTHER | | type | enum | No | Category of the substance Values: FOOD, MEDICATION, ENVIRONMENT, BIOLOGIC, OTHER | | criticality | enum | No | Potential severity of future reactions Values: LOW, HIGH, UNABLE\_TO\_ASSESS, OTHER | | reactions | [HealthcareCode](https://docs.unified.to/healthcare/allergy/Retrieve%5Fan%5Fallergy.md#HealthcareCode)\[\] | No | Codings for observed reaction manifestations (e.g. hives, anaphylaxis) | | reactions\[\].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) | | reactions\[\].code | string | No | The code within the system | | reactions\[\].display | string | No | Human-readable display text for the code | | onset\_at | string (date-time) | No | When the allergy was first identified (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | recorded\_at | string (date-time) | No | When the allergy was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | notes | string | No | Free-text notes about the allergy | | metadata | [HealthcareMetadata](https://docs.unified.to/healthcare/allergy/Retrieve%5Fan%5Fallergy.md#HealthcareMetadata)\[\] | No | | | metadata\[\].id | string | No | | | metadata\[\].value | object | No | | | metadata\[\].namespace | string | No | | | metadata\[\].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT | | metadata\[\].extra\_data | object | No | | | metadata\[\].slug | string | No | | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.healthcare.getHealthcareAllergy({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/allergy/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("GET", "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/allergy/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/healthcare/5de520f96e439b002043d8dc/allergy/5de520f96e439b002043d8d8?fields=&raw= req, _ := http.NewRequest("GET", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/allergy/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.get(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/allergy/5de520f96e439b002043d8d8?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/healthcare/5de520f96e439b002043d8dc/allergy/5de520f96e439b002043d8d8?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request GET \ --url 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/allergy/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```