EHR · Administration
Scheduling
A booking is refused when the provider or the room is already taken, and schedules its own reminders.
/api/ehr/appointmentsPublished as /api/v1/appointmentsOverview
| 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 › Scheduling 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.appointments · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ehr/appointmentsList scheduling
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",
"appointment_no": "APP-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"appointment_type": "text",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"reason": "text",
"status": "scheduled",
"is_telehealth": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ehr/appointments?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ehr/appointments/{id}Read one appointments
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",
"appointment_no": "APP-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"appointment_type": "text",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"reason": "text",
"status": "scheduled",
"is_telehealth": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ehr/appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/appointmentsCreate a appointments
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Location id |
patient_id | uuid | Yes | Patient |
provider_id | uuid | No | Provider |
department_id | uuid | No | Department |
resource_id | uuid | No | Room or resource |
appointment_type | text | No | Type |
starts_at | timestamp with time zone | Yes | Starts |
ends_at | timestamp with time zone | Yes | Ends |
reason | text | No | Reason |
status | text | No | Status Allowed: scheduled confirmed arrived roomed in_progress completed no_show cancelled |
is_telehealth | boolean | No | Telehealth |
meeting_url | text | No | Meeting url |
cancel_reason | text | No | Cancel reason |
Sample body
{
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"appointment_no": "APP-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"appointment_type": "text",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"reason": "text",
"status": "scheduled",
"is_telehealth": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ehr/appointments" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","starts_at":"2026-10-30T09:00:00Z","ends_at":"2026-10-30T09:00:00Z","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","provider_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","department_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","resource_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/ehr/appointments/{id}Change a appointments
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 |
|---|---|---|---|
location_id | uuid | No | Location id |
patient_id | uuid | Yes | Patient |
provider_id | uuid | No | Provider |
department_id | uuid | No | Department |
resource_id | uuid | No | Room or resource |
appointment_type | text | No | Type |
starts_at | timestamp with time zone | Yes | Starts |
ends_at | timestamp with time zone | Yes | Ends |
reason | text | No | Reason |
status | text | No | Status Allowed: scheduled confirmed arrived roomed in_progress completed no_show cancelled |
is_telehealth | boolean | No | Telehealth |
meeting_url | text | No | Meeting url |
cancel_reason | text | No | Cancel reason |
Sample body
{
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"starts_at": "2026-10-30T09:00:00Z"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"appointment_no": "APP-000001",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"resource_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"appointment_type": "text",
"starts_at": "2026-10-30T09:00:00Z",
"ends_at": "2026-10-30T09:00:00Z",
"reason": "text",
"status": "scheduled",
"is_telehealth": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ehr/appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","starts_at":"2026-10-30T09:00:00Z"}'DELETE/api/ehr/appointments/{id}Delete a appointments
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/appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/appointments/{id}/calendar-inviteCalendar invite
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar-invite" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/appointments/{id}/calendar-invite/cancelCalendar invite cancel
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/calendar-invite/cancel" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/appointments/{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/appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/ehr/appointments/bookBook
Request body
The keys this action reads (* = required; "one of" lists the only values):
patientId*, providerId, departmentId, resourceId, appointmentType, startsAt, minutes, reason, isTelehealth; appointmentType one of office_visit|new_patient|follow_up|procedure|imaging|lab|therapy|telehealth|vaccination|surgeryResponse
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/appointments/book" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patientId":"value","providerId":"value","departmentId":"value","resourceId":"value","appointmentType":"value","startsAt":"value"}'POST/api/ehr/appointments/{id}/arriveArrive
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, 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/appointments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/arrive" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a appointments, 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, write | Location id |
appointment_no | text | read only | Appointment no |
patient_id | uuid | read, write | Patient |
provider_id | uuid | read, write | Provider |
department_id | uuid | read, write | Department |
resource_id | uuid | read, write | Room or resource |
appointment_type | text | read, write | Type |
starts_at | timestamp with time zone | read, write | Starts |
ends_at | timestamp with time zone | read, write | Ends |
reason | text | read, write | Reason |
status | text | read, write | Status Allowed: scheduled confirmed arrived roomed in_progress completed no_show cancelled |
is_telehealth | boolean | read, write | Telehealth |
meeting_url | text | read, write | Meeting url |
encounter_id | uuid | read only | Encounter id |
cancel_reason | text | read, write | Cancel reason |
created_at | timestamp with time zone | read only | Created at |
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_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
eligibility_check_id | uuid | read only | Eligibility check id |
eligibility_status | text | read only | Eligibility status |
eligibility_note | text | read only | Eligibility note |
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 › Scheduling 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.