EHR · Pharmacy
Prescribing
Written, transmitted and dispensed. A controlled substance must be sent electronically or printed.
/api/ehr/prescriptionsPublished as /api/v1/prescriptionsOverview
| Package | EHR |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold EHR › Prescribing on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | ehr.prescriptions · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
16 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ehr/prescriptionsList prescribing
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rx_no": "RX-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"formulary_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prescriber_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"dose": "text",
"route": "text",
"frequency": "text",
"duration_days": 10,
"quantity": "12.0000",
"refills": 10,
"refills_used": 10
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ehr/prescriptions?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ehr/prescriptions/{id}Read one prescriptions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rx_no": "RX-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"formulary_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prescriber_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"dose": "text",
"route": "text",
"frequency": "text",
"duration_days": 10,
"quantity": "12.0000",
"refills": 10,
"refills_used": 10
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/prescriptionsCreate a prescriptions
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
patient_id | uuid | Yes | Patient |
encounter_id | uuid | No | Encounter id |
formulary_id | uuid | Yes | Medication |
prescriber_id | uuid | No | Prescriber |
dose | text | Yes | Dose |
route | text | No | Route |
frequency | text | Yes | Frequency |
duration_days | integer | No | Duration (days) |
quantity | numeric | No | Quantity |
refills | integer | No | Refills |
indication | text | No | Indication |
instructions | text | No | Instructions |
is_prn | boolean | No | As needed |
start_date | date | No | Start date |
end_date | date | No | End date |
pharmacy_name | text | No | Pharmacy name |
pharmacy_id | uuid | No | Pharmacy |
drug_ndc | text | No | Drug ndc |
sig_text | text | No | Directions (Sig) |
sig_dose_quantity | numeric | No | Dose quantity |
sig_dose_unit_code | text | No | Sig dose unit code |
sig_frequency_per_day | numeric | No | Sig frequency per day |
quantity_unit_code | text | No | Quantity unit code |
days_supply | integer | No | Days supply |
substitutions | text | No | Substitution — 1 = dispense as written. Allowed: 0 1 |
note_to_pharmacist | text | No | Note to the pharmacist |
Sample body
{
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"formulary_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"dose": "text",
"frequency": "text",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prescriber_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"route": "text",
"duration_days": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rx_no": "RX-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"formulary_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prescriber_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"dose": "text",
"route": "text",
"frequency": "text",
"duration_days": 10,
"quantity": "12.0000",
"refills": 10,
"refills_used": 10
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/prescriptions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","formulary_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","dose":"text","frequency":"text","encounter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","prescriber_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","route":"text","duration_days":10}'PUT/api/ehr/prescriptions/{id}Change a prescriptions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
patient_id | uuid | Yes | Patient |
encounter_id | uuid | No | Encounter id |
formulary_id | uuid | Yes | Medication |
prescriber_id | uuid | No | Prescriber |
dose | text | Yes | Dose |
route | text | No | Route |
frequency | text | Yes | Frequency |
duration_days | integer | No | Duration (days) |
quantity | numeric | No | Quantity |
refills | integer | No | Refills |
indication | text | No | Indication |
instructions | text | No | Instructions |
is_prn | boolean | No | As needed |
start_date | date | No | Start date |
end_date | date | No | End date |
pharmacy_name | text | No | Pharmacy name |
pharmacy_id | uuid | No | Pharmacy |
drug_ndc | text | No | Drug ndc |
sig_text | text | No | Directions (Sig) |
sig_dose_quantity | numeric | No | Dose quantity |
sig_dose_unit_code | text | No | Sig dose unit code |
sig_frequency_per_day | numeric | No | Sig frequency per day |
quantity_unit_code | text | No | Quantity unit code |
days_supply | integer | No | Days supply |
substitutions | text | No | Substitution — 1 = dispense as written. Allowed: 0 1 |
note_to_pharmacist | text | No | Note to the pharmacist |
Sample body
{
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"formulary_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"rx_no": "RX-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"formulary_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"prescriber_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"dose": "text",
"route": "text",
"frequency": "text",
"duration_days": 10,
"quantity": "12.0000",
"refills": 10,
"refills_used": 10
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","formulary_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/ehr/prescriptions/{id}Delete a prescriptions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/prescriptions/{id}/transmitTransmit
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
method, pharmacyId, password, otp, overrideReasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transmit" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"method":"value","pharmacyId":"value","password":"value","otp":"value","overrideReason":"value"}'POST/api/ehr/prescriptions/{id}/erx-cancelErx cancel
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reason*Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/erx-cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/ehr/prescriptions/{id}/erx-simulateErx simulate
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
kindResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/erx-simulate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"kind":"value"}'GET/api/ehr/prescriptions/{id}/erx-messagesErx messages
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/erx-messages" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/prescriptions/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/ehr/prescriptions/{parentId}/dispensesDispenses
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/dispenses" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/prescriptions/{parentId}/dispensesDispenses
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/dispenses" \
-H "Authorization: Bearer $TOKEN"PUT/api/ehr/prescriptions/{parentId}/dispenses/{lineId}Dispenses
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/dispenses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ehr/prescriptions/{parentId}/dispenses/{lineId}Dispenses
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/dispenses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/prescriptions/checkCheck
Request body
The keys this action reads (* = required; "one of" lists the only values):
patientId*, formularyIdResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/prescriptions/check" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patientId":"value","formularyId":"value"}'POST/api/ehr/prescriptions/{id}/dispenseDispense
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
quantity, lotNo, expiryDate, dispensedBy, binId, counselledResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/prescriptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/dispense" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"quantity":"value","lotNo":"value","expiryDate":"value","dispensedBy":"value","binId":"value","counselled":"value"}'Data model
Every field of a prescriptions, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
rx_no | text | read only | Rx no |
patient_id | uuid | read, write | Patient |
encounter_id | uuid | read, write | Encounter id |
formulary_id | uuid | read, write | Medication |
prescriber_id | uuid | read, write | Prescriber |
dose | text | read, write | Dose |
route | text | read, write | Route |
frequency | text | read, write | Frequency |
duration_days | integer | read, write | Duration (days) |
quantity | numeric | read, write | Quantity |
refills | integer | read, write | Refills |
refills_used | integer | read only | Refills used |
indication | text | read, write | Indication |
instructions | text | read, write | Instructions |
is_prn | boolean | read, write | As needed |
written_at | timestamp with time zone | read only | Written at |
start_date | date | read, write | Start date |
end_date | date | read, write | End date |
status | text | read only | Status |
transmitted_at | timestamp with time zone | read only | Transmitted at |
transmit_method | text | read only | Transmit method |
pharmacy_name | text | read, write | Pharmacy name |
discontinued_reason | text | read only | Discontinued reason |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
pharmacy_id | uuid | read, write | Pharmacy |
drug_ndc | text | read, write | Drug ndc |
sig_text | text | read, write | Directions (Sig) |
sig_dose_quantity | numeric | read, write | Dose quantity |
sig_dose_unit_code | text | read, write | Sig dose unit code |
sig_frequency_per_day | numeric | read, write | Sig frequency per day |
quantity_unit_code | text | read, write | Quantity unit code |
days_supply | integer | read, write | Days supply |
substitutions | text | read, write | Substitution — 1 = dispense as written. Allowed: 0 1 |
note_to_pharmacist | text | read, write | Note to the pharmacist |
erx_status | text | read only | Erx status |
erx_message_id | text | read only | Erx message id |
erx_status_note | text | read only | Erx status note |
epcs_signed_at | timestamp with time zone | read only | Epcs signed at |
epcs_signed_by | uuid | read only | Epcs signed by |
renewal_of_id | uuid | read only | Renewal of id |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold EHR › Prescribing for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.