TRANXACT.AI Help

EHR · Existing Records

Clinical Orders

Read and maintain clinical orders records (ehr.clinical_orders).

Type REST12 operationsBase path /api/ehr/clinical-ordersPublished as /api/v1/clinical-orders

Download specification (OpenAPI 3.1) Screen: Clinical Orders

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 › Clinical Orders 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.clinical_orders · 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

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

GET/api/ehr/clinical-ordersList clinical orders

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",
      "order_no": "ORD-000001",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "order_type": "text",
      "description": "text",
      "priority": "text",
      "status": "draft",
      "ordered_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "ordered_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "xf_text_1": "text",
      "xf_text_2": "text",
      "xf_text_3": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_no": "ORD-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_type": "text",
  "description": "text",
  "priority": "text",
  "status": "draft",
  "ordered_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ordered_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
patient_iduuidYesPatient id
encounter_iduuidNoEncounter id
order_typetextNoOrder type
descriptiontextYesDescription
prioritytextNoPriority
statustextNoStatus
ordered_byuuidNoOrdered by

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_type": "text",
  "priority": "text",
  "status": "draft"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_no": "ORD-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_type": "text",
  "description": "text",
  "priority": "text",
  "status": "draft",
  "ordered_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ordered_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/clinical-orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","description":"text","encounter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","order_type":"text","priority":"text","status":"draft"}'
PUT/api/ehr/clinical-orders/{id}Change a clinical orders

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 id
encounter_iduuidNoEncounter id
order_typetextNoOrder type
descriptiontextYesDescription
prioritytextNoPriority
statustextNoStatus
ordered_byuuidNoOrdered by

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "description": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_no": "ORD-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "order_type": "text",
  "description": "text",
  "priority": "text",
  "status": "draft",
  "ordered_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ordered_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text",
  "xf_text_2": "text",
  "xf_text_3": "text"
}

Sample request

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

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/clinical-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/clinical-orders/{id}/send-hl7Send hl7

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 POST "https://demo.tranxact.ai/api/ehr/clinical-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send-hl7" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/clinical-orders/{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/clinical-orders/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/clinical-orders/{parentId}/itemsItems

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

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

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

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

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):

observedAt, observed_at, code*, name, valueNum, valueText, unit, referenceRange, abnormalFlag, resultState; abnormalFlag one of H|HH|L|LL

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/clinical-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/result" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"observedAt":"value","observed_at":"value","code":"value","name":"value","valueNum":"value","valueText":"value"}'

Data model

Every field of a clinical orders, 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
order_notextread onlyOrder no
patient_iduuidread, writePatient id
encounter_iduuidread, writeEncounter id
order_typetextread, writeOrder type
descriptiontextread, writeDescription
prioritytextread, writePriority
statustextread, writeStatus
ordered_byuuidread, writeOrdered by
ordered_attimestamp with time zoneread onlyOrdered at
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
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 › Clinical Orders 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.