TRANXACT.AI Help

EHR · Existing Records

Medications

Every medication a patient is on or has been on: ordered here with Prescribe (safety checked), or prescribed under Prescribing. A prescription is transmitted, dispensed or stopped on Prescribing.

Type REST12 operationsBase path /api/ehr/medicationsPublished as /api/v1/medications

Download specification (OpenAPI 3.1) Screen: Medications

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 › Medications 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.medications
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

12 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ehr/medicationsList medications

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",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "drug_name": "Example",
      "dose": "text",
      "route": "text",
      "frequency": "text",
      "status": "draft",
      "origin": "text",
      "prescribed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "started_at": "2026-10-30",
      "safety_check": {},
      "xf_text_1": "text",
      "xf_text_2": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ehr/medications?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/medications/{id}Read one medications

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "drug_name": "Example",
  "dose": "text",
  "route": "text",
  "frequency": "text",
  "status": "draft",
  "origin": "text",
  "prescribed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "started_at": "2026-10-30",
  "safety_check": {},
  "xf_text_1": "text",
  "xf_text_2": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/ehr/medications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/medicationsCreate a medications

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
statustextNoStatus

Sample body

{
  "status": "draft"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "drug_name": "Example",
  "dose": "text",
  "route": "text",
  "frequency": "text",
  "status": "draft",
  "origin": "text",
  "prescribed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "started_at": "2026-10-30",
  "safety_check": {},
  "xf_text_1": "text",
  "xf_text_2": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/medications" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"draft"}'
PUT/api/ehr/medications/{id}Change a medications

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
statustextNoStatus

Sample body

{
  "status": "draft"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "drug_name": "Example",
  "dose": "text",
  "route": "text",
  "frequency": "text",
  "status": "draft",
  "origin": "text",
  "prescribed_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "started_at": "2026-10-30",
  "safety_check": {},
  "xf_text_1": "text",
  "xf_text_2": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ehr/medications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"draft"}'
DELETE/api/ehr/medications/{id}Delete a medications

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/medications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
PATCH/api/ehr/medications/{id}Patch medications

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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 PATCH "https://demo.tranxact.ai/api/ehr/medications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/medications/{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/medications/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/medications/{parentId}/administrationsAdministrations

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/medications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/administrations" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/medications/{parentId}/administrationsAdministrations

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/medications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/administrations" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/ehr/medications/{parentId}/administrations/{lineId}Administrations

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/medications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/administrations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/ehr/medications/{parentId}/administrations/{lineId}Administrations

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/medications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/administrations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/medications/prescribePrescribe

Request body

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

startedAt, startDate, started_at, patientId*, encounterId, drugName, dose, route, frequency, prescribedBy, 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/medications/prescribe" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"startedAt":"value","startDate":"value","started_at":"value","patientId":"value","encounterId":"value","drugName":"value"}'

Data model

Every field of a medications, 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
patient_iduuidread onlyPatient id
encounter_iduuidread onlyEncounter id
drug_nametextread onlyDrug name
dosetextread onlyDose
routetextread onlyRoute
frequencytextread onlyFrequency
statustextread, writeStatus
origintextread onlyOrigin
prescribed_byuuidread onlyPrescribed by
started_atdateread onlyStarted at
safety_checkjsonbread onlySafety check
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

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 › Medications 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.