curl --request GET \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/referrals/{referral_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/referrals/{referral_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}/referrals/{referral_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",
"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"
}
}{
"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 a referral
Permission: referrals:read
Get one referral from the clinic’s list.
Only a confirmed referral is fetchable by id. With Accept: application/fhir+json the answer is a FHIR R4 ServiceRequest.
curl --request GET \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/referrals/{referral_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/referrals/{referral_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}/referrals/{referral_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",
"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"
}
}{
"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.
A clinical referral: another provider or service asks this clinic to see a patient. It is NOT the clinic referral programme (clinic-to-clinic credits for recommending ClinikEHR), the marketing "referred by" source on a client, or an antenatal or postnatal referral note. The exposed-field allow-list, field by field. review_status says where the record stands: confirmed is on the clinic's referral list; pending is an outside submission still waiting for clinic staff; rejected and withdrawn are this key's own submissions that did not become a referral. For a confirmed referral status is the clinic's workflow: it lands received, and only the clinic accepts, declines, schedules, completes or cancels it. A sender can never change status, recipient or scheduled_appointment_id. decision_reason on a confirmed referral (the clinic's reason for declining or cancelling) is shown only to the key or organization that sent it; everyone else sees null.
Show child attributes
Show child attributes