EHR · Claims EDI
Eligibility Checks
Each 270 inquiry and the payer's 271 answer: coverage, plan, copay, deductible and what is left of it, coinsurance and out-of-pocket.
/api/ehr/eligibility-checksPublished as /api/v1/eligibility-checksDownload specification (OpenAPI 3.1) Screen: Eligibility Checks
Overview
| 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 › Eligibility Checks 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.eligibility_checks · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The 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/eligibility-checksList eligibility checks
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",
"check_no": "CHE-000001",
"policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"service_type": "text",
"trace_no": "TRA-000001",
"request_file_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"response_file_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"coverage_active": true,
"plan_name": "Example"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ehr/eligibility-checks?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ehr/eligibility-checks/{id}Read one eligibility checks
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",
"check_no": "CHE-000001",
"policy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"service_type": "text",
"trace_no": "TRA-000001",
"request_file_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"response_file_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"status": "draft",
"coverage_active": true,
"plan_name": "Example"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ehr/eligibility-checks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/eligibility-checksPost eligibility checks
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/eligibility-checks" \
-H "Authorization: Bearer $TOKEN"POST/api/ehr/eligibility-checks/{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/eligibility-checks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/ehr/eligibility-checks/{id}Put eligibility checks
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 PUT "https://demo.tranxact.ai/api/ehr/eligibility-checks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/ehr/eligibility-checks/{id}Delete eligibility checks
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 DELETE "https://demo.tranxact.ai/api/ehr/eligibility-checks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a eligibility checks, 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 |
check_no | text | read only | Check no |
policy_id | uuid | read only | Policy id |
patient_id | uuid | read only | Patient id |
payer_id | uuid | read only | Payer id |
connection_id | uuid | read only | Connection id |
service_type | text | read only | Service type |
trace_no | text | read only | Trace no |
request_file_id | uuid | read only | Request file id |
response_file_id | uuid | read only | Response file id |
status | text | read only | Status |
coverage_active | boolean | read only | Coverage active |
plan_name | text | read only | Plan name |
copay | numeric | read only | Copay |
coinsurance_pct | numeric | read only | Coinsurance pct |
deductible | numeric | read only | Deductible |
deductible_remaining | numeric | read only | Deductible remaining |
out_of_pocket_max | numeric | read only | Out of pocket max |
out_of_pocket_remaining | numeric | read only | Out of pocket remaining |
rejection | text | read only | Rejection |
benefits | jsonb | read only | Benefits |
checked_at | timestamp with time zone | read only | Checked at |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 |
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 › Eligibility Checks 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.