TRANXACT.AI Help

EHR · Emergency

Emergency Visits

Arrival, triage, treatment and disposition. An ESI of 1 or 2 raises an alert at triage.

Type REST6 operationsBase path /api/ehr/ed-visitsPublished as /api/v1/ed-visits

Download specification (OpenAPI 3.1) Screen: Emergency Visits

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 › Emergency Visits 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.ed_visits · 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

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

GET/api/ehr/ed-visitsList emergency visits

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",
      "visit_no": "VIS-000001",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "arrived_at": "2026-10-30T09:00:00Z",
      "arrival_mode": "text",
      "chief_complaint": "text",
      "acuity": 10,
      "triaged_at": "2026-10-30T09:00:00Z",
      "triaged_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "triage_notes": "text",
      "vital_bp": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "visit_no": "VIS-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "arrived_at": "2026-10-30T09:00:00Z",
  "arrival_mode": "text",
  "chief_complaint": "text",
  "acuity": 10,
  "triaged_at": "2026-10-30T09:00:00Z",
  "triaged_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "triage_notes": "text",
  "vital_bp": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
patient_iduuidYesPatient
encounter_iduuidNoEncounter id
arrival_modetextNoArrival mode
chief_complainttextYesChief complaint
acuityintegerNoAcuity
triage_notestextNoTriage notes
vital_bptextNoVital bp
vital_pulseintegerNoVital pulse
vital_tempnumericNoVital temp
vital_respintegerNoVital resp
vital_spo2integerNoVital spo2
pain_scoreintegerNoPain score
bedtextNoBed
attending_iduuidNoAttending
dispositiontextNoDisposition
statustextNoStatus
Allowed: waiting triaged roomed in_treatment pending_results pending_disposition departed left_without_being_seen
discharge_instructionstextNoDischarge instructions
follow_up_withtextNoFollow up with
follow_up_daysintegerNoFollow up days

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "chief_complaint": "text",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "arrival_mode": "text",
  "acuity": 10,
  "triage_notes": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "visit_no": "VIS-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "arrived_at": "2026-10-30T09:00:00Z",
  "arrival_mode": "text",
  "chief_complaint": "text",
  "acuity": 10,
  "triaged_at": "2026-10-30T09:00:00Z",
  "triaged_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "triage_notes": "text",
  "vital_bp": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/ed-visits" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","chief_complaint":"text","encounter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","arrival_mode":"text","acuity":10,"triage_notes":"text"}'
PUT/api/ehr/ed-visits/{id}Change a ed visits

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
arrival_modetextNoArrival mode
chief_complainttextYesChief complaint
acuityintegerNoAcuity
triage_notestextNoTriage notes
vital_bptextNoVital bp
vital_pulseintegerNoVital pulse
vital_tempnumericNoVital temp
vital_respintegerNoVital resp
vital_spo2integerNoVital spo2
pain_scoreintegerNoPain score
bedtextNoBed
attending_iduuidNoAttending
dispositiontextNoDisposition
statustextNoStatus
Allowed: waiting triaged roomed in_treatment pending_results pending_disposition departed left_without_being_seen
discharge_instructionstextNoDischarge instructions
follow_up_withtextNoFollow up with
follow_up_daysintegerNoFollow up days

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "visit_no": "VIS-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "encounter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "arrived_at": "2026-10-30T09:00:00Z",
  "arrival_mode": "text",
  "chief_complaint": "text",
  "acuity": 10,
  "triaged_at": "2026-10-30T09:00:00Z",
  "triaged_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "triage_notes": "text",
  "vital_bp": "text"
}

Sample request

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

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/ed-visits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/ed-visits/{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/ed-visits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a ed visits, 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 onlyLocation id
visit_notextread onlyVisit no
patient_iduuidread, writePatient
encounter_iduuidread, writeEncounter id
arrived_attimestamp with time zoneread onlyArrived at
arrival_modetextread, writeArrival mode
chief_complainttextread, writeChief complaint
acuityintegerread, writeAcuity
triaged_attimestamp with time zoneread onlyTriaged at
triaged_byuuidread onlyTriaged by
triage_notestextread, writeTriage notes
vital_bptextread, writeVital bp
vital_pulseintegerread, writeVital pulse
vital_tempnumericread, writeVital temp
vital_respintegerread, writeVital resp
vital_spo2integerread, writeVital spo2
pain_scoreintegerread, writePain score
bedtextread, writeBed
attending_iduuidread, writeAttending
roomed_attimestamp with time zoneread onlyRoomed at
seen_attimestamp with time zoneread onlySeen at
dispositiontextread, writeDisposition
disposition_attimestamp with time zoneread onlyDisposition at
departed_attimestamp with time zoneread onlyDeparted at
statustextread, writeStatus
Allowed: waiting triaged roomed in_treatment pending_results pending_disposition departed left_without_being_seen
discharge_instructionstextread, writeDischarge instructions
follow_up_withtextread, writeFollow up with
follow_up_daysintegerread, writeFollow up days
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 › Emergency Visits 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.