TRANXACT.AI Help

EHR · Radiology & Imaging

Imaging Worklist

From order through acquisition to a signed report. A critical finding raises an alert.

Type REST16 operationsBase path /api/ehr/imaging-studiesPublished as /api/v1/imaging-studies

Download specification (OpenAPI 3.1) Screen: Imaging Worklist

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 › 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.
Tableehr.imaging_studies · 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/imaging-studiesList imaging worklist

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
patient_iduuidYesPatient
encounter_iduuidNoEncounter id
procedure_iduuidYesProcedure
ordering_provider_iduuidNoOrdering provider
performing_tech_iduuidNoPerforming tech id
radiologist_iduuidNoRadiologist
prioritytextNoPriority
clinical_indicationtextNoClinical indication
scheduled_attimestamp with time zoneNoScheduled
performed_attimestamp with time zoneNoPerformed at
statustextNoStatus
study_uidtextNoStudy uid
storage_urltextNoStorage url
location_iduuidNoLocation id
roomtextNoRoom
radiation_dosenumericNoRadiation dose
cost_center_iduuidNoCost 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

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
procedure_iduuidYesProcedure
ordering_provider_iduuidNoOrdering provider
performing_tech_iduuidNoPerforming tech id
radiologist_iduuidNoRadiologist
prioritytextNoPriority
clinical_indicationtextNoClinical indication
scheduled_attimestamp with time zoneNoScheduled
performed_attimestamp with time zoneNoPerformed at
statustextNoStatus
study_uidtextNoStudy uid
storage_urltextNoStorage url
location_iduuidNoLocation id
roomtextNoRoom
radiation_dosenumericNoRadiation dose
cost_center_iduuidNoCost 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

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

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

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

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

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

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

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

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

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

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

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

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

findings*, impression, technique, comparison, recommendation, radiologistId, reportType, criticalFinding; reportType one of preliminary|final|addendum

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
accession_notextread onlyAccession no
patient_iduuidread, writePatient
encounter_iduuidread, writeEncounter id
procedure_iduuidread, writeProcedure
ordering_provider_iduuidread, writeOrdering provider
performing_tech_iduuidread, writePerforming tech id
radiologist_iduuidread, writeRadiologist
prioritytextread, writePriority
clinical_indicationtextread, writeClinical indication
ordered_attimestamp with time zoneread onlyOrdered at
scheduled_attimestamp with time zoneread, writeScheduled
performed_attimestamp with time zoneread, writePerformed at
reported_attimestamp with time zoneread onlyReported at
statustextread, writeStatus
study_uidtextread, writeStudy uid
image_countintegerread onlyImage count
storage_urltextread, writeStorage url
location_iduuidread, writeLocation id
roomtextread, writeRoom
radiation_dosenumericread, writeRadiation dose
cost_center_iduuidread, writeCost center 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 › Imaging Worklist 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.