curl --request GET \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/referrals \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/referrals', 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}/referrals"
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",
"direction": "incoming",
"status": "received",
"service": {
"text": "<string>",
"code": {
"system": "snomed-ct",
"code": "<string>"
}
},
"reason": {
"text": "<string>",
"code": {
"system": "icd-10-cm",
"code": "<string>"
}
},
"review_status": "confirmed",
"priority": "routine",
"clinical_summary": "<string>",
"requester": {
"name": "<string>",
"organization": "<string>",
"npi": "<string>"
},
"recipient": {
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"requested_at": "2023-11-07T05:31:56Z",
"needed_by": "2023-12-25",
"scheduled_appointment_id": "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"
}
],
"has_more": true,
"next_cursor": "<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>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}List referrals
Permission: referrals:read
List one patient’s clinical referrals (the clinic’s list, or what this key submitted).
patient_id is required. review_status picks the view: confirmed (default) is the clinic’s own referral list for the patient, whoever sent each referral; pending is this key’s own submissions still waiting for clinic staff (and those staff rejected); all is both. status filters confirmed referrals by the clinic’s workflow state. These are clinical referrals to the clinic; they are not the clinic referral programme. A restricted patient’s referrals are never returned. With Accept: application/fhir+json the answer is a searchset Bundle of FHIR R4 ServiceRequest resources.
curl --request GET \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/referrals \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/referrals', 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}/referrals"
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",
"direction": "incoming",
"status": "received",
"service": {
"text": "<string>",
"code": {
"system": "snomed-ct",
"code": "<string>"
}
},
"reason": {
"text": "<string>",
"code": {
"system": "icd-10-cm",
"code": "<string>"
}
},
"review_status": "confirmed",
"priority": "routine",
"clinical_summary": "<string>",
"requester": {
"name": "<string>",
"organization": "<string>",
"npi": "<string>"
},
"recipient": {
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"requested_at": "2023-11-07T05:31:56Z",
"needed_by": "2023-12-25",
"scheduled_appointment_id": "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"
}
],
"has_more": true,
"next_cursor": "<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>"
}
]
}{
"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.
Path Parameters
Query Parameters
confirmed, pending, all received, accepted, scheduled, completed, declined, cancelled, entered_in_error 1 <= x <= 100