TRANXACT.AI Help

EHR · Pharmacy

Prescribing

Written, transmitted and dispensed. A controlled substance must be sent electronically or printed.

Type REST16 operationsBase path /api/ehr/prescriptionsPublished as /api/v1/prescriptions

Download specification (OpenAPI 3.1) Screen: Prescribing

Overview

PackageEHR
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableehr.prescriptions · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
patient_iduuidYesPatient
encounter_iduuidNoEncounter id
formulary_iduuidYesMedication
prescriber_iduuidNoPrescriber
dosetextYesDose
routetextNoRoute
frequencytextYesFrequency
duration_daysintegerNoDuration (days)
quantitynumericNoQuantity
refillsintegerNoRefills
indicationtextNoIndication
instructionstextNoInstructions
is_prnbooleanNoAs needed
start_datedateNoStart date
end_datedateNoEnd date
pharmacy_nametextNoPharmacy name
pharmacy_iduuidNoPharmacy
drug_ndctextNoDrug ndc
sig_texttextNoDirections (Sig)
sig_dose_quantitynumericNoDose quantity
sig_dose_unit_codetextNoSig dose unit code
sig_frequency_per_daynumericNoSig frequency per day
quantity_unit_codetextNoQuantity unit code
days_supplyintegerNoDays supply
substitutionstextNoSubstitution — 1 = dispense as written.
Allowed: 0 1
note_to_pharmacisttextNoNote 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
patient_iduuidYesPatient
encounter_iduuidNoEncounter id
formulary_iduuidYesMedication
prescriber_iduuidNoPrescriber
dosetextYesDose
routetextNoRoute
frequencytextYesFrequency
duration_daysintegerNoDuration (days)
quantitynumericNoQuantity
refillsintegerNoRefills
indicationtextNoIndication
instructionstextNoInstructions
is_prnbooleanNoAs needed
start_datedateNoStart date
end_datedateNoEnd date
pharmacy_nametextNoPharmacy name
pharmacy_iduuidNoPharmacy
drug_ndctextNoDrug ndc
sig_texttextNoDirections (Sig)
sig_dose_quantitynumericNoDose quantity
sig_dose_unit_codetextNoSig dose unit code
sig_frequency_per_daynumericNoSig frequency per day
quantity_unit_codetextNoQuantity unit code
days_supplyintegerNoDays supply
substitutionstextNoSubstitution — 1 = dispense as written.
Allowed: 0 1
note_to_pharmacisttextNoNote 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, overrideReason

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

kind

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-simulate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind":"value"}'
GET/api/ehr/prescriptions/{id}/erx-messagesErx messages

Path parameters

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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*, formularyId

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/check" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patientId":"value","formularyId":"value"}'
POST/api/ehr/prescriptions/{id}/dispenseDispense

Path parameters

NameTypeDescription
idstring (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, counselled

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
rx_notextread onlyRx no
patient_iduuidread, writePatient
encounter_iduuidread, writeEncounter id
formulary_iduuidread, writeMedication
prescriber_iduuidread, writePrescriber
dosetextread, writeDose
routetextread, writeRoute
frequencytextread, writeFrequency
duration_daysintegerread, writeDuration (days)
quantitynumericread, writeQuantity
refillsintegerread, writeRefills
refills_usedintegerread onlyRefills used
indicationtextread, writeIndication
instructionstextread, writeInstructions
is_prnbooleanread, writeAs needed
written_attimestamp with time zoneread onlyWritten at
start_datedateread, writeStart date
end_datedateread, writeEnd date
statustextread onlyStatus
transmitted_attimestamp with time zoneread onlyTransmitted at
transmit_methodtextread onlyTransmit method
pharmacy_nametextread, writePharmacy name
discontinued_reasontextread onlyDiscontinued reason
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
pharmacy_iduuidread, writePharmacy
drug_ndctextread, writeDrug ndc
sig_texttextread, writeDirections (Sig)
sig_dose_quantitynumericread, writeDose quantity
sig_dose_unit_codetextread, writeSig dose unit code
sig_frequency_per_daynumericread, writeSig frequency per day
quantity_unit_codetextread, writeQuantity unit code
days_supplyintegerread, writeDays supply
substitutionstextread, writeSubstitution — 1 = dispense as written.
Allowed: 0 1
note_to_pharmacisttextread, writeNote to the pharmacist
erx_statustextread onlyErx status
erx_message_idtextread onlyErx message id
erx_status_notetextread onlyErx status note
epcs_signed_attimestamp with time zoneread onlyEpcs signed at
epcs_signed_byuuidread onlyEpcs signed by
renewal_of_iduuidread onlyRenewal of id

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold EHR › Prescribing for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.