curl --request PATCH \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/medication-statements/{medication_statement_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dosage": {
"text": "<string>",
"route": "<string>",
"frequency": "<string>"
},
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"reason": "<string>",
"note": "<string>",
"client_reference": "<string>",
"origin_assistant_name": "<string>"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dosage: {text: '<string>', route: '<string>', frequency: '<string>'},
effective_start: '2023-12-25',
effective_end: '2023-12-25',
reason: '<string>',
note: '<string>',
client_reference: '<string>',
origin_assistant_name: '<string>'
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/medication-statements/{medication_statement_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}/medication-statements/{medication_statement_id}"
payload = {
"dosage": {
"text": "<string>",
"route": "<string>",
"frequency": "<string>"
},
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"reason": "<string>",
"note": "<string>",
"client_reference": "<string>",
"origin_assistant_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource_type": "condition",
"action": "create",
"review_status": "pending",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accepted_automatically": true,
"source": "api",
"submitted_at": "2023-11-07T05:31:56Z",
"decided_at": "2023-11-07T05:31:56Z",
"decision_reason": "<string>",
"result_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"client_reference": "<string>",
"origin_assistant_name": "<string>",
"payload": {}
}
}{
"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>"
}
]
}Update or retract a reported medicine
Permission: medications:write
Propose a change to a reported medicine, or retract it.
The change is held for a clinician to confirm and answers 202 Accepted with a Location header pointing at the new submission; the statement is unchanged until then. A change is always reviewed by a clinician, even when the clinic accepts new reported medicines automatically. status: entered_in_error proposes a retraction. The medicine cannot be changed. The Idempotency-Key header is optional. JSON only: a FHIR MedicationStatement body is not accepted.
curl --request PATCH \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/medication-statements/{medication_statement_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dosage": {
"text": "<string>",
"route": "<string>",
"frequency": "<string>"
},
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"reason": "<string>",
"note": "<string>",
"client_reference": "<string>",
"origin_assistant_name": "<string>"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dosage: {text: '<string>', route: '<string>', frequency: '<string>'},
effective_start: '2023-12-25',
effective_end: '2023-12-25',
reason: '<string>',
note: '<string>',
client_reference: '<string>',
origin_assistant_name: '<string>'
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/medication-statements/{medication_statement_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}/medication-statements/{medication_statement_id}"
payload = {
"dosage": {
"text": "<string>",
"route": "<string>",
"frequency": "<string>"
},
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"reason": "<string>",
"note": "<string>",
"client_reference": "<string>",
"origin_assistant_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource_type": "condition",
"action": "create",
"review_status": "pending",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accepted_automatically": true,
"source": "api",
"submitted_at": "2023-11-07T05:31:56Z",
"decided_at": "2023-11-07T05:31:56Z",
"decision_reason": "<string>",
"result_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"client_reference": "<string>",
"origin_assistant_name": "<string>",
"payload": {}
}
}{
"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.
Headers
Optional. A unique value you choose for this request, such as a UUID. When sent, a retry with the same key returns the first answer instead of applying the change twice. See Retries and idempotency.
1Body
A proposed change to a reported medicine. It becomes a NEW pending submission; the statement does not change until a clinician confirms it. The medicine itself can never be changed (a different medicine is a new statement). status: entered_in_error proposes retracting the statement and cannot be combined with other changes.
active, completed, stopped, on_hold, not_taken, entered_in_error Show child attributes
Show child attributes
1 - 5001 - 2000200200Response
Accepted - waiting for a clinician.
What the clinic's review queue holds for something this key sent: one outside record waiting for, or already past, a clinician's decision.
Show child attributes
Show child attributes