EHR · Radiology & Imaging
Imaging Worklist
From order through acquisition to a signed report. A critical finding raises an alert.
/api/ehr/imaging-studiesPublished as /api/v1/imaging-studiesDownload specification (OpenAPI 3.1) Screen: Imaging Worklist
Overview
| 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 › Imaging Worklist 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.imaging_studies · 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/imaging-studiesList imaging worklist
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",
"accession_no": "ACC-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"procedure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ordering_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performing_tech_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"radiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"priority": "text",
"clinical_indication": "text",
"ordered_at": "2026-10-30T09:00:00Z",
"scheduled_at": "2026-10-30T09:00:00Z",
"performed_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ehr/imaging-studies?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ehr/imaging-studies/{id}Read one imaging studies
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",
"accession_no": "ACC-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"procedure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ordering_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performing_tech_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"radiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"priority": "text",
"clinical_indication": "text",
"ordered_at": "2026-10-30T09:00:00Z",
"scheduled_at": "2026-10-30T09:00:00Z",
"performed_at": "2026-10-30T09:00:00Z"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ehr/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/imaging-studiesCreate a imaging studies
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 |
procedure_id | uuid | Yes | Procedure |
ordering_provider_id | uuid | No | Ordering provider |
performing_tech_id | uuid | No | Performing tech id |
radiologist_id | uuid | No | Radiologist |
priority | text | No | Priority |
clinical_indication | text | No | Clinical indication |
scheduled_at | timestamp with time zone | No | Scheduled |
performed_at | timestamp with time zone | No | Performed at |
status | text | No | Status |
study_uid | text | No | Study uid |
storage_url | text | No | Storage url |
location_id | uuid | No | Location id |
room | text | No | Room |
radiation_dose | numeric | No | Radiation dose |
cost_center_id | uuid | No | Cost center id |
Sample body
{
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"procedure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ordering_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performing_tech_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"radiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"accession_no": "ACC-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"procedure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ordering_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performing_tech_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"radiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"priority": "text",
"clinical_indication": "text",
"ordered_at": "2026-10-30T09:00:00Z",
"scheduled_at": "2026-10-30T09:00:00Z",
"performed_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/imaging-studies" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","procedure_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","encounter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","ordering_provider_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","performing_tech_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","radiologist_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/ehr/imaging-studies/{id}Change a imaging studies
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 |
procedure_id | uuid | Yes | Procedure |
ordering_provider_id | uuid | No | Ordering provider |
performing_tech_id | uuid | No | Performing tech id |
radiologist_id | uuid | No | Radiologist |
priority | text | No | Priority |
clinical_indication | text | No | Clinical indication |
scheduled_at | timestamp with time zone | No | Scheduled |
performed_at | timestamp with time zone | No | Performed at |
status | text | No | Status |
study_uid | text | No | Study uid |
storage_url | text | No | Storage url |
location_id | uuid | No | Location id |
room | text | No | Room |
radiation_dose | numeric | No | Radiation dose |
cost_center_id | uuid | No | Cost center id |
Sample body
{
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"procedure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"accession_no": "ACC-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"procedure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"ordering_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performing_tech_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"radiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"priority": "text",
"clinical_indication": "text",
"ordered_at": "2026-10-30T09:00:00Z",
"scheduled_at": "2026-10-30T09:00:00Z",
"performed_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ehr/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","procedure_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/ehr/imaging-studies/{id}Delete a imaging studies
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/imaging-studies/{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/imaging-studies/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/imaging-studies/{parentId}/seriesSeries
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/series" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/imaging-studies/{parentId}/seriesSeries
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/series" \
-H "Authorization: Bearer $TOKEN"PUT/api/ehr/imaging-studies/{parentId}/series/{lineId}Series
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/series/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ehr/imaging-studies/{parentId}/series/{lineId}Series
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/series/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/ehr/imaging-studies/{parentId}/reportsReports
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reports" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/imaging-studies/{parentId}/reportsReports
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reports" \
-H "Authorization: Bearer $TOKEN"PUT/api/ehr/imaging-studies/{parentId}/reports/{lineId}Reports
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ehr/imaging-studies/{parentId}/reports/{lineId}Reports
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reports/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/imaging-studies/{id}/acquireAcquire
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):
imageCount, storageUrl, studyUid, radiationDose, techId; series: [{ uid, description, modality, imageCount, storageUrl }]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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/acquire" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"imageCount":"value","storageUrl":"value","studyUid":"value","radiationDose":"value","techId;":"value","description":"value"}'POST/api/ehr/imaging-studies/{id}/reportReport
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):
findings*, impression, technique, comparison, recommendation, radiologistId, reportType, criticalFinding; reportType one of preliminary|final|addendumResponse
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/imaging-studies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/report" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"findings":"value","impression":"value","technique":"value","comparison":"value","recommendation":"value","radiologistId":"value"}'Data model
Every field of a imaging studies, 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 |
accession_no | text | read only | Accession no |
patient_id | uuid | read, write | Patient |
encounter_id | uuid | read, write | Encounter id |
procedure_id | uuid | read, write | Procedure |
ordering_provider_id | uuid | read, write | Ordering provider |
performing_tech_id | uuid | read, write | Performing tech id |
radiologist_id | uuid | read, write | Radiologist |
priority | text | read, write | Priority |
clinical_indication | text | read, write | Clinical indication |
ordered_at | timestamp with time zone | read only | Ordered at |
scheduled_at | timestamp with time zone | read, write | Scheduled |
performed_at | timestamp with time zone | read, write | Performed at |
reported_at | timestamp with time zone | read only | Reported at |
status | text | read, write | Status |
study_uid | text | read, write | Study uid |
image_count | integer | read only | Image count |
storage_url | text | read, write | Storage url |
location_id | uuid | read, write | Location id |
room | text | read, write | Room |
radiation_dose | numeric | read, write | Radiation dose |
cost_center_id | uuid | read, write | Cost center id |
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 |
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 › Imaging Worklist 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.