TRANXACT.AI Help

EHR · Patient Access

Patient Portal

Portal invitations, activation and reminder preferences. Invite sends the patient a one-time link to the patient portal (statements, appointments and cases), with a second step at sign-in; Add a proxy lets a parent, guardian or carer see the record too.

Type REST6 operationsBase path /api/ehr/portal-accountsPublished as /api/v1/portal-accounts

Download specification (OpenAPI 3.1) Screen: Patient Portal

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 › Patient Portal 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.portal_accounts · 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/portal-accountsList patient portal

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",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "email": "someone@example.com",
      "phone": "+1 555 0100",
      "status": "needs_email",
      "invited_at": "2026-10-30T09:00:00Z",
      "activated_at": "2026-10-30T09:00:00Z",
      "last_login_at": "2026-10-30T09:00:00Z",
      "login_count": 10,
      "proxy_for_patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "proxy_relationship": "text",
      "sms_reminders": true,
      "email_reminders": true
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "status": "needs_email",
  "invited_at": "2026-10-30T09:00:00Z",
  "activated_at": "2026-10-30T09:00:00Z",
  "last_login_at": "2026-10-30T09:00:00Z",
  "login_count": 10,
  "proxy_for_patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "proxy_relationship": "text",
  "sms_reminders": true,
  "email_reminders": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
patient_iduuidYesPatient
user_iduuidNoSign-in account
emailtextNoEmail
phonetextNoPhone
statustextNoStatus — Invited only once an invitation has been sent to the email address. A patient with no email address is needs email.
Allowed: needs_email invited active locked disabled expired
proxy_for_patient_iduuidNoProxy for patient id
proxy_relationshiptextNoProxy relationship
sms_remindersbooleanNoSMS reminders — Texts go to the phone above, or else to the phone on the patient record. With neither, SMS reminders cannot be switched on.
email_remindersbooleanNoEmail reminders

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "status": "needs_email"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "status": "needs_email",
  "invited_at": "2026-10-30T09:00:00Z",
  "activated_at": "2026-10-30T09:00:00Z",
  "last_login_at": "2026-10-30T09:00:00Z",
  "login_count": 10,
  "proxy_for_patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "proxy_relationship": "text",
  "sms_reminders": true,
  "email_reminders": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/portal-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","user_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","email":"someone@example.com","phone":"+1 555 0100","status":"needs_email"}'
PUT/api/ehr/portal-accounts/{id}Change a portal accounts

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
user_iduuidNoSign-in account
emailtextNoEmail
phonetextNoPhone
statustextNoStatus — Invited only once an invitation has been sent to the email address. A patient with no email address is needs email.
Allowed: needs_email invited active locked disabled expired
proxy_for_patient_iduuidNoProxy for patient id
proxy_relationshiptextNoProxy relationship
sms_remindersbooleanNoSMS reminders — Texts go to the phone above, or else to the phone on the patient record. With neither, SMS reminders cannot be switched on.
email_remindersbooleanNoEmail reminders

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "status": "needs_email",
  "invited_at": "2026-10-30T09:00:00Z",
  "activated_at": "2026-10-30T09:00:00Z",
  "last_login_at": "2026-10-30T09:00:00Z",
  "login_count": 10,
  "proxy_for_patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "proxy_relationship": "text",
  "sms_reminders": true,
  "email_reminders": true
}

Sample request

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

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/portal-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/portal-accounts/{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/portal-accounts/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 portal accounts, 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
patient_iduuidread, writePatient
user_iduuidread, writeSign-in account
emailtextread, writeEmail
phonetextread, writePhone
statustextread, writeStatus — Invited only once an invitation has been sent to the email address. A patient with no email address is needs email.
Allowed: needs_email invited active locked disabled expired
invited_attimestamp with time zoneread onlyInvited at
activated_attimestamp with time zoneread onlyActivated at
last_login_attimestamp with time zoneread onlyLast login at
login_countintegerread onlyLogin count
proxy_for_patient_iduuidread, writeProxy for patient id
proxy_relationshiptextread, writeProxy relationship
sms_remindersbooleanread, writeSMS reminders — Texts go to the phone above, or else to the phone on the patient record. With neither, SMS reminders cannot be switched on.
email_remindersbooleanread, writeEmail reminders
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

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 › Patient Portal 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.