TRANXACT.AI Help

EHR · Rehabilitation

Rehabilitation Therapy

Physical, occupational and speech therapy: episodes, authorized visits and sessions.

Type REST10 operationsBase path /api/ehr/therapy-episodesPublished as /api/v1/therapy-episodes

Download specification (OpenAPI 3.1) Screen: Rehabilitation Therapy

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 › Rehabilitation Therapy 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.therapy_episodes · 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

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

GET/api/ehr/therapy-episodesList rehabilitation therapy

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",
      "episode_no": "EPI-000001",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "therapy_type": "text",
      "referring_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "therapist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "diagnosis": "text",
      "referral_date": "2026-10-30",
      "start_date": "2026-10-30",
      "end_date": "2026-10-30",
      "authorized_visits": 10,
      "visits_used": 10,
      "frequency": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "episode_no": "EPI-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "therapy_type": "text",
  "referring_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "therapist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "diagnosis": "text",
  "referral_date": "2026-10-30",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "authorized_visits": 10,
  "visits_used": 10,
  "frequency": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
patient_iduuidYesPatient
therapy_typetextNoTherapy type
referring_provider_iduuidNoReferred by
therapist_iduuidNoTherapist
diagnosistextNoDiagnosis
referral_datedateNoReferred
start_datedateNoStarts
end_datedateNoEnd date
authorized_visitsintegerNoAuthorized visits
frequencytextNoFrequency
statustextNoStatus
Allowed: referred evaluation active on_hold completed discharged cancelled
discharge_reasontextNoDischarge reason
care_plan_iduuidNoCare plan

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "therapy_type": "text",
  "referring_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "therapist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "diagnosis": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "episode_no": "EPI-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "therapy_type": "text",
  "referring_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "therapist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "diagnosis": "text",
  "referral_date": "2026-10-30",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "authorized_visits": 10,
  "visits_used": 10,
  "frequency": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/therapy-episodes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","therapy_type":"text","referring_provider_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","therapist_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","diagnosis":"text"}'
PUT/api/ehr/therapy-episodes/{id}Change a therapy episodes

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
therapy_typetextNoTherapy type
referring_provider_iduuidNoReferred by
therapist_iduuidNoTherapist
diagnosistextNoDiagnosis
referral_datedateNoReferred
start_datedateNoStarts
end_datedateNoEnd date
authorized_visitsintegerNoAuthorized visits
frequencytextNoFrequency
statustextNoStatus
Allowed: referred evaluation active on_hold completed discharged cancelled
discharge_reasontextNoDischarge reason
care_plan_iduuidNoCare plan

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "episode_no": "EPI-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "therapy_type": "text",
  "referring_provider_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "therapist_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "diagnosis": "text",
  "referral_date": "2026-10-30",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "authorized_visits": 10,
  "visits_used": 10,
  "frequency": "text"
}

Sample request

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

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

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

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

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

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/therapy-episodes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sessions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a therapy episodes, 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
episode_notextread onlyEpisode no
patient_iduuidread, writePatient
therapy_typetextread, writeTherapy type
referring_provider_iduuidread, writeReferred by
therapist_iduuidread, writeTherapist
diagnosistextread, writeDiagnosis
referral_datedateread, writeReferred
start_datedateread, writeStarts
end_datedateread, writeEnd date
authorized_visitsintegerread, writeAuthorized visits
visits_usedintegerread onlyVisits used
frequencytextread, writeFrequency
statustextread, writeStatus
Allowed: referred evaluation active on_hold completed discharged cancelled
discharge_reasontextread, writeDischarge reason
care_plan_iduuidread, writeCare plan
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 › Rehabilitation Therapy 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.