TRANXACT.AI Help

EHR · Health Information

Release of Information

Records are not released without an authorization on file, and a release is logged as an access.

Type REST7 operationsBase path /api/ehr/record-requestsPublished as /api/v1/record-requests

Download specification (OpenAPI 3.1) Screen: Release of Information

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 › Release of Information 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.record_requests · 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

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

GET/api/ehr/record-requestsList release of information

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",
      "request_no": "REQ-000001",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requester_name": "Example",
      "requester_type": "patient",
      "purpose": "text",
      "scope": "text",
      "date_from": "2026-10-30",
      "date_to": "2026-10-30",
      "authorization_on_file": true,
      "authorization_expires": "2026-10-30",
      "status": "draft",
      "requested_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "request_no": "REQ-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requester_name": "Example",
  "requester_type": "patient",
  "purpose": "text",
  "scope": "text",
  "date_from": "2026-10-30",
  "date_to": "2026-10-30",
  "authorization_on_file": true,
  "authorization_expires": "2026-10-30",
  "status": "draft",
  "requested_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
patient_iduuidYesPatient
requester_nametextYesRequester
requester_typetextNoRequester type
Allowed: patient provider insurer legal employer research family
purposetextYesPurpose
scopetextNoScope
date_fromdateNoRecords from
date_todateNoRecords to
authorization_on_filebooleanNoAuthorization on file
authorization_expiresdateNoAuthorization expires
statustextNoStatus
requested_attimestamp with time zoneNoReceived — When the request arrived — it starts the response clock. Leave empty for now.
delivery_methodtextNoDelivery
fee_amountnumericNoFee
denial_reasontextNoDenial reason

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requester_name": "Example",
  "purpose": "text",
  "requester_type": "patient",
  "scope": "text",
  "date_from": "2026-10-30",
  "date_to": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "request_no": "REQ-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requester_name": "Example",
  "requester_type": "patient",
  "purpose": "text",
  "scope": "text",
  "date_from": "2026-10-30",
  "date_to": "2026-10-30",
  "authorization_on_file": true,
  "authorization_expires": "2026-10-30",
  "status": "draft",
  "requested_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/record-requests" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","requester_name":"Example","purpose":"text","requester_type":"patient","scope":"text","date_from":"2026-10-30","date_to":"2026-10-30"}'
PUT/api/ehr/record-requests/{id}Change a record requests

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
requester_nametextYesRequester
requester_typetextNoRequester type
Allowed: patient provider insurer legal employer research family
purposetextYesPurpose
scopetextNoScope
date_fromdateNoRecords from
date_todateNoRecords to
authorization_on_filebooleanNoAuthorization on file
authorization_expiresdateNoAuthorization expires
statustextNoStatus
requested_attimestamp with time zoneNoReceived — When the request arrived — it starts the response clock. Leave empty for now.
delivery_methodtextNoDelivery
fee_amountnumericNoFee
denial_reasontextNoDenial reason

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "request_no": "REQ-000001",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requester_name": "Example",
  "requester_type": "patient",
  "purpose": "text",
  "scope": "text",
  "date_from": "2026-10-30",
  "date_to": "2026-10-30",
  "authorization_on_file": true,
  "authorization_expires": "2026-10-30",
  "status": "draft",
  "requested_at": "2026-10-30T09:00:00Z"
}

Sample request

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

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

Path parameters

NameTypeDescription
idstring (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/record-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a record requests, 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
request_notextread onlyRequest no
patient_iduuidread, writePatient
requester_nametextread, writeRequester
requester_typetextread, writeRequester type
Allowed: patient provider insurer legal employer research family
purposetextread, writePurpose
scopetextread, writeScope
date_fromdateread, writeRecords from
date_todateread, writeRecords to
authorization_on_filebooleanread, writeAuthorization on file
authorization_expiresdateread, writeAuthorization expires
statustextread, writeStatus
requested_attimestamp with time zoneread, writeReceived — When the request arrived — it starts the response clock. Leave empty for now.
released_attimestamp with time zoneread onlyReleased at
released_byuuidread onlyReleased by
delivery_methodtextread, writeDelivery
fee_amountnumericread, writeFee
denial_reasontextread, writeDenial reason
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 › Release of Information 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.