TRANXACT.AI Help

EHR · Operating Theatre

Surgical Cases

Scheduling refuses a double booking; the safety checklist is a gate, not a form.

Type REST13 operationsBase path /api/ehr/surgical-casesPublished as /api/v1/surgical-cases

Download specification (OpenAPI 3.1) Screen: Surgical Cases

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 › Surgical Cases 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.surgical_cases · 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

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

GET/api/ehr/surgical-casesList surgical cases

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",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "case_no": "CAS-000001",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "procedure_name": "Example",
      "cpt_code": "CPT-000001",
      "laterality": "left",
      "primary_surgeon_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "anesthesiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "theatre_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "scheduled_start": "2026-10-30T09:00:00Z",
      "scheduled_minutes": 10
    }
  ],
  "count": 1
}

Sample request

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

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",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "case_no": "CAS-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "procedure_name": "Example",
  "cpt_code": "CPT-000001",
  "laterality": "left",
  "primary_surgeon_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "anesthesiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "theatre_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scheduled_start": "2026-10-30T09:00:00Z",
  "scheduled_minutes": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
location_iduuidNoLocation id
patient_iduuidYesPatient
encounter_iduuidNoEncounter id
procedure_nametextYesProcedure
cpt_codetextNoCPT code
lateralitytextNoSide
Allowed: left right bilateral n/a
primary_surgeon_iduuidNoSurgeon
anesthesiologist_iduuidNoAnaesthetist
theatre_iduuidNoTheatre
scheduled_starttimestamp with time zoneNoScheduled start
scheduled_minutesintegerNoPlanned minutes
anesthesia_typetextNoAnaesthesia
asa_classintegerNoASA class
urgencytextNoUrgency
Allowed: elective urgent emergent
statustextNoStatus
consent_signedbooleanNoConsent signed
site_markedbooleanNoSite marked
timeout_completedbooleanNoTimeout completed
count_correctbooleanNoCount correct
estimated_blood_loss_mlintegerNoEstimated blood loss ml
specimenstextNoSpecimens
complicationstextNoComplications
cancel_reasontextNoCancel reason
cost_center_iduuidNoCost center id

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "procedure_name": "Example",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cpt_code": "CPT-000001",
  "laterality": "left"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "case_no": "CAS-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "procedure_name": "Example",
  "cpt_code": "CPT-000001",
  "laterality": "left",
  "primary_surgeon_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "anesthesiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "theatre_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scheduled_start": "2026-10-30T09:00:00Z",
  "scheduled_minutes": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/surgical-cases" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","procedure_name":"Example","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","encounter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","cpt_code":"CPT-000001","laterality":"left"}'
PUT/api/ehr/surgical-cases/{id}Change a surgical cases

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
location_iduuidNoLocation id
patient_iduuidYesPatient
encounter_iduuidNoEncounter id
procedure_nametextYesProcedure
cpt_codetextNoCPT code
lateralitytextNoSide
Allowed: left right bilateral n/a
primary_surgeon_iduuidNoSurgeon
anesthesiologist_iduuidNoAnaesthetist
theatre_iduuidNoTheatre
scheduled_starttimestamp with time zoneNoScheduled start
scheduled_minutesintegerNoPlanned minutes
anesthesia_typetextNoAnaesthesia
asa_classintegerNoASA class
urgencytextNoUrgency
Allowed: elective urgent emergent
statustextNoStatus
consent_signedbooleanNoConsent signed
site_markedbooleanNoSite marked
timeout_completedbooleanNoTimeout completed
count_correctbooleanNoCount correct
estimated_blood_loss_mlintegerNoEstimated blood loss ml
specimenstextNoSpecimens
complicationstextNoComplications
cancel_reasontextNoCancel reason
cost_center_iduuidNoCost center id

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "case_no": "CAS-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "procedure_name": "Example",
  "cpt_code": "CPT-000001",
  "laterality": "left",
  "primary_surgeon_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "anesthesiologist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "theatre_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "scheduled_start": "2026-10-30T09:00:00Z",
  "scheduled_minutes": 10
}

Sample request

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

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

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

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

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

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

Request body

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

patientId*, procedureName, cptCode, laterality, surgeonId, anesthesiologistId, theatreId, scheduledStart, minutes, urgency, asaClass; laterality one of left|right|bilateral|n/a; urgency one of elective|urgent|emergent

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/surgical-cases/schedule" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patientId":"value","procedureName":"value","cptCode":"value","laterality":"value","surgeonId":"value","anesthesiologistId":"value"}'
POST/api/ehr/surgical-cases/{id}/timeoutTimeout

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

consentSigned, siteMarked

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/surgical-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/timeout" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"consentSigned":"value","siteMarked":"value"}'
POST/api/ehr/surgical-cases/{id}/completeComplete

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

countCorrect, bloodLossMl, specimens, complications

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/surgical-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"countCorrect":"value","bloodLossMl":"value","specimens":"value","complications":"value"}'

Data model

Every field of a surgical cases, 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
location_iduuidread, writeLocation id
case_notextread onlyCase no
patient_iduuidread, writePatient
encounter_iduuidread, writeEncounter id
procedure_nametextread, writeProcedure
cpt_codetextread, writeCPT code
lateralitytextread, writeSide
Allowed: left right bilateral n/a
primary_surgeon_iduuidread, writeSurgeon
anesthesiologist_iduuidread, writeAnaesthetist
theatre_iduuidread, writeTheatre
scheduled_starttimestamp with time zoneread, writeScheduled start
scheduled_minutesintegerread, writePlanned minutes
anesthesia_typetextread, writeAnaesthesia
asa_classintegerread, writeASA class
urgencytextread, writeUrgency
Allowed: elective urgent emergent
statustextread, writeStatus
pre_op_attimestamp with time zoneread onlyPre op at
in_room_attimestamp with time zoneread onlyIn room at
incision_attimestamp with time zoneread onlyIncision at
closure_attimestamp with time zoneread onlyClosure at
out_room_attimestamp with time zoneread onlyOut room at
pacu_attimestamp with time zoneread onlyPacu at
consent_signedbooleanread, writeConsent signed
site_markedbooleanread, writeSite marked
timeout_completedbooleanread, writeTimeout completed
count_correctbooleanread, writeCount correct
estimated_blood_loss_mlintegerread, writeEstimated blood loss ml
specimenstextread, writeSpecimens
complicationstextread, writeComplications
cancel_reasontextread, writeCancel reason
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 › Surgical Cases 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.