curl --request GET \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/allergies/{allergy_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/allergies/{allergy_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/allergies/{allergy_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entry": "structured",
"substance": {
"text": "<string>",
"code": {
"system": "rxnorm",
"code": "<string>",
"display": "<string>"
}
},
"verification_status": "confirmed",
"review_status": "confirmed",
"category": [
"food"
],
"criticality": "low",
"type": "allergy",
"clinical_status": "active",
"reactions": [
{
"manifestation": [
"<string>"
],
"severity": "mild",
"description": "<string>"
}
],
"onset_date": "2023-12-25",
"note": "<string>",
"recorded_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "clinic",
"origin_assistant_name": "<string>",
"accepted_by": "clinic",
"reviewed_at": "2023-11-07T05:31:56Z",
"reviewed_by_staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"decision_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Get an allergy
Permission: allergies:read
Get one allergy from the chart.
Only a detailed (structured) allergy has an id; an allergy that is only a name on the clinic’s simple list is not fetchable by id. With Accept: application/fhir+json the answer is a FHIR R4 AllergyIntolerance.
curl --request GET \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/allergies/{allergy_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/allergies/{allergy_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/allergies/{allergy_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entry": "structured",
"substance": {
"text": "<string>",
"code": {
"system": "rxnorm",
"code": "<string>",
"display": "<string>"
}
},
"verification_status": "confirmed",
"review_status": "confirmed",
"category": [
"food"
],
"criticality": "low",
"type": "allergy",
"clinical_status": "active",
"reactions": [
{
"manifestation": [
"<string>"
],
"severity": "mild",
"description": "<string>"
}
],
"onset_date": "2023-12-25",
"note": "<string>",
"recorded_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "clinic",
"origin_assistant_name": "<string>",
"accepted_by": "clinic",
"reviewed_at": "2023-11-07T05:31:56Z",
"reviewed_by_staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"decision_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
OK.
An allergy or intolerance - the exposed-field allow-list, field by field. review_status says where the record stands: confirmed is on the clinic's chart (clinic truth); pending is an outside submission still waiting for a clinician (verification_status: unconfirmed); rejected and withdrawn are this key's own submissions that did not become chart truth. entry is structured for a detailed allergy record and legacy_text for an allergy that is only a name on the clinic's simple allergy list: it has id: null, no detail, and cannot be fetched or changed by id. An empty list does NOT mean "no known allergies".
Show child attributes
Show child attributes