EHR · Emergency
Emergency Visits
Arrival, triage, treatment and disposition. An ESI of 1 or 2 raises an alert at triage.
/api/ehr/ed-visitsPublished as /api/v1/ed-visitsDownload specification (OpenAPI 3.1) Screen: Emergency Visits
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 › 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. |
| Table | ehr.ed_visits · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ehr/ed-visitsList emergency visits
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",
"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
| 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",
"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.
| Field | Type | Required | Description |
|---|---|---|---|
patient_id | uuid | Yes | Patient |
encounter_id | uuid | No | Encounter id |
arrival_mode | text | No | Arrival mode |
chief_complaint | text | Yes | Chief complaint |
acuity | integer | No | Acuity |
triage_notes | text | No | Triage notes |
vital_bp | text | No | Vital bp |
vital_pulse | integer | No | Vital pulse |
vital_temp | numeric | No | Vital temp |
vital_resp | integer | No | Vital resp |
vital_spo2 | integer | No | Vital spo2 |
pain_score | integer | No | Pain score |
bed | text | No | Bed |
attending_id | uuid | No | Attending |
disposition | text | No | Disposition |
status | text | No | Status Allowed: waiting triaged roomed in_treatment pending_results pending_disposition departed left_without_being_seen |
discharge_instructions | text | No | Discharge instructions |
follow_up_with | text | No | Follow up with |
follow_up_days | integer | No | Follow 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
| 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 |
arrival_mode | text | No | Arrival mode |
chief_complaint | text | Yes | Chief complaint |
acuity | integer | No | Acuity |
triage_notes | text | No | Triage notes |
vital_bp | text | No | Vital bp |
vital_pulse | integer | No | Vital pulse |
vital_temp | numeric | No | Vital temp |
vital_resp | integer | No | Vital resp |
vital_spo2 | integer | No | Vital spo2 |
pain_score | integer | No | Pain score |
bed | text | No | Bed |
attending_id | uuid | No | Attending |
disposition | text | No | Disposition |
status | text | No | Status Allowed: waiting triaged roomed in_treatment pending_results pending_disposition departed left_without_being_seen |
discharge_instructions | text | No | Discharge instructions |
follow_up_with | text | No | Follow up with |
follow_up_days | integer | No | Follow 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
| 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/ed-visits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/ed-visits/{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/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.
| 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 |
location_id | uuid | read only | Location id |
visit_no | text | read only | Visit no |
patient_id | uuid | read, write | Patient |
encounter_id | uuid | read, write | Encounter id |
arrived_at | timestamp with time zone | read only | Arrived at |
arrival_mode | text | read, write | Arrival mode |
chief_complaint | text | read, write | Chief complaint |
acuity | integer | read, write | Acuity |
triaged_at | timestamp with time zone | read only | Triaged at |
triaged_by | uuid | read only | Triaged by |
triage_notes | text | read, write | Triage notes |
vital_bp | text | read, write | Vital bp |
vital_pulse | integer | read, write | Vital pulse |
vital_temp | numeric | read, write | Vital temp |
vital_resp | integer | read, write | Vital resp |
vital_spo2 | integer | read, write | Vital spo2 |
pain_score | integer | read, write | Pain score |
bed | text | read, write | Bed |
attending_id | uuid | read, write | Attending |
roomed_at | timestamp with time zone | read only | Roomed at |
seen_at | timestamp with time zone | read only | Seen at |
disposition | text | read, write | Disposition |
disposition_at | timestamp with time zone | read only | Disposition at |
departed_at | timestamp with time zone | read only | Departed at |
status | text | read, write | Status Allowed: waiting triaged roomed in_treatment pending_results pending_disposition departed left_without_being_seen |
discharge_instructions | text | read, write | Discharge instructions |
follow_up_with | text | read, write | Follow up with |
follow_up_days | integer | read, write | Follow up days |
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 › Emergency Visits 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.