TRANXACT.AI Help

EHR · Clinical

Patients

Read and maintain patients records (ehr.patients).

Type REST9 operationsBase path /api/ehr/patientsPublished as /api/v1/patients

Download specification (OpenAPI 3.1) Screen: Patients

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 › Patients 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.patients · 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

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

GET/api/ehr/patientsList patients

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",
      "mrn": "text",
      "first_name": "Example",
      "last_name": "Example",
      "native_name": "Example",
      "date_of_birth": "2026-10-30",
      "sex_at_birth": "female",
      "gender_identity": "text",
      "preferred_language": "text",
      "interpreter_needed": true,
      "phone": "+1 555 0100",
      "email": "someone@example.com",
      "address": "text",
      "restricted_chart": true
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "mrn": "text",
  "first_name": "Example",
  "last_name": "Example",
  "native_name": "Example",
  "date_of_birth": "2026-10-30",
  "sex_at_birth": "female",
  "gender_identity": "text",
  "preferred_language": "text",
  "interpreter_needed": true,
  "phone": "+1 555 0100",
  "email": "someone@example.com",
  "address": "text",
  "restricted_chart": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
mrntextYesMedical record number — Left blank, the platform allocates the next one from the number range.
first_nametextYesFirst name
last_nametextYesLast name
native_nametextNoName in native script
date_of_birthdateYesDate of birth
sex_at_birthtextNoSex at birth
Allowed: female male other unknown
gender_identitytextNoGender identity
preferred_languagetextNoPreferred language
interpreter_neededbooleanNoInterpreter needed
phonetextNoPhone
emailtextNoEmail
addresstextNoAddress
restricted_chartbooleanNoRestricted chart
is_activebooleanNoIs active
citytextNoCity
state_codetextNoState
postal_codetextNoZIP code
bad_addressbooleanNoMail came back (hold statements)
in_collectionsbooleanNoWith a collection agency
statement_holdtextNoHold statements because
reminders_opt_outbooleanNoNo reminders — The patient has asked not to be sent appointment or recall reminders.

Sample body

{
  "mrn": "text",
  "first_name": "Example",
  "last_name": "Example",
  "date_of_birth": "2026-10-30",
  "native_name": "Example",
  "sex_at_birth": "female",
  "gender_identity": "text",
  "preferred_language": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "mrn": "text",
  "first_name": "Example",
  "last_name": "Example",
  "native_name": "Example",
  "date_of_birth": "2026-10-30",
  "sex_at_birth": "female",
  "gender_identity": "text",
  "preferred_language": "text",
  "interpreter_needed": true,
  "phone": "+1 555 0100",
  "email": "someone@example.com",
  "address": "text",
  "restricted_chart": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/patients" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mrn":"text","first_name":"Example","last_name":"Example","date_of_birth":"2026-10-30","native_name":"Example","sex_at_birth":"female","gender_identity":"text","preferred_language":"text"}'
PUT/api/ehr/patients/{id}Change a patients

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
mrntextYesMedical record number — Left blank, the platform allocates the next one from the number range.
first_nametextYesFirst name
last_nametextYesLast name
native_nametextNoName in native script
date_of_birthdateYesDate of birth
sex_at_birthtextNoSex at birth
Allowed: female male other unknown
gender_identitytextNoGender identity
preferred_languagetextNoPreferred language
interpreter_neededbooleanNoInterpreter needed
phonetextNoPhone
emailtextNoEmail
addresstextNoAddress
restricted_chartbooleanNoRestricted chart
is_activebooleanNoIs active
citytextNoCity
state_codetextNoState
postal_codetextNoZIP code
bad_addressbooleanNoMail came back (hold statements)
in_collectionsbooleanNoWith a collection agency
statement_holdtextNoHold statements because
reminders_opt_outbooleanNoNo reminders — The patient has asked not to be sent appointment or recall reminders.

Sample body

{
  "mrn": "text",
  "first_name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "mrn": "text",
  "first_name": "Example",
  "last_name": "Example",
  "native_name": "Example",
  "date_of_birth": "2026-10-30",
  "sex_at_birth": "female",
  "gender_identity": "text",
  "preferred_language": "text",
  "interpreter_needed": true,
  "phone": "+1 555 0100",
  "email": "someone@example.com",
  "address": "text",
  "restricted_chart": true
}

Sample request

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

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/patients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
PATCH/api/ehr/patients/{id}Patch patients

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

confirm_duplicate, duplicate_reason, review_later

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 PATCH "https://demo.tranxact.ai/api/ehr/patients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"confirm_duplicate":"value","duplicate_reason":"value","review_later":"value"}'
POST/api/ehr/patients/{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/patients/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/patients/check-duplicatesCheck duplicates

Request body

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

firstName, lastName*, dateOfBirth

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/patients/check-duplicates" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"value","lastName":"value","dateOfBirth":"value"}'
GET/api/ehr/patients/{id}/chartChart

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

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

Data model

Every field of a patients, 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
mrntextread, writeMedical record number — Left blank, the platform allocates the next one from the number range.
first_nametextread, writeFirst name
last_nametextread, writeLast name
native_nametextread, writeName in native script
date_of_birthdateread, writeDate of birth
sex_at_birthtextread, writeSex at birth
Allowed: female male other unknown
gender_identitytextread, writeGender identity
preferred_languagetextread, writePreferred language
interpreter_neededbooleanread, writeInterpreter needed
phonetextread, writePhone
emailtextread, writeEmail
addresstextread, writeAddress
restricted_chartbooleanread, writeRestricted chart
is_activebooleanread, writeIs active
org_unit_iduuidread onlyOrg unit 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
citytextread, writeCity
state_codetextread, writeState
postal_codetextread, writeZIP code
bad_addressbooleanread, writeMail came back (hold statements)
in_collectionsbooleanread, writeWith a collection agency
statement_holdtextread, writeHold statements because
reminders_opt_outbooleanread, writeNo reminders — The patient has asked not to be sent appointment or recall reminders.

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 › Patients 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.