Cancel a drug request
curl --request POST \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/drug_requests/{request_id}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/drug_requests/{request_id}/cancel', 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}/drug_requests/{request_id}/cancel"
payload = { "reason": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clinic_patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "submitted",
"requester_reference": "<string>",
"authorization_reference": "<string>",
"needed_by": "2023-11-07T05:31:56Z",
"pharmacist_note": "<string>",
"decline_reason": "<string>",
"cancel_reason": "<string>",
"cancelled_by_actor": "<string>",
"decided_at": "2023-11-07T05:31:56Z",
"ready_at": "2023-11-07T05:31:56Z",
"dispensed_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"lines": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_no": 123,
"code_system": "gtin",
"code_value": "<string>",
"description": "<string>",
"quantity": "<string>",
"directions": "<string>",
"matched_inventory_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matched_medicine_index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_status": "<string>",
"substituted_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"substitution_reason": "<string>",
"decline_reason": "<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>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Drug requests
Cancel a drug request
Permission: requests:write Cancel a drug request. Never available once dispensed. Refused with invalid_status_transition (409) when the current status does not allow a requester cancel.
POST
/
v1
/
clinics
/
{clinic_id}
/
drug_requests
/
{request_id}
/
cancel
Cancel a drug request
curl --request POST \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/drug_requests/{request_id}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/drug_requests/{request_id}/cancel', 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}/drug_requests/{request_id}/cancel"
payload = { "reason": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clinic_patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "submitted",
"requester_reference": "<string>",
"authorization_reference": "<string>",
"needed_by": "2023-11-07T05:31:56Z",
"pharmacist_note": "<string>",
"decline_reason": "<string>",
"cancel_reason": "<string>",
"cancelled_by_actor": "<string>",
"decided_at": "2023-11-07T05:31:56Z",
"ready_at": "2023-11-07T05:31:56Z",
"dispensed_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"expired_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"lines": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_no": 123,
"code_system": "gtin",
"code_value": "<string>",
"description": "<string>",
"quantity": "<string>",
"directions": "<string>",
"matched_inventory_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matched_medicine_index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"line_status": "<string>",
"substituted_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"substitution_reason": "<string>",
"decline_reason": "<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>"
}
]
}{
"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.
Body
application/json
Response
OK.
Never carries a price/cost/amount field — a request is a commitment to fill medicine, never a billing document.
Show child attributes
Show child attributes