TRANXACT.AI Help

EHR · Administration

Providers

Clinicians and the departments they work in. Linked to the HRMS personnel record.

Type REST6 operationsBase path /api/ehr/providersPublished as /api/v1/providers

Download specification (OpenAPI 3.1) Screen: Providers

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 › Providers 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.providers · 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/providersList providers

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",
      "provider_no": "PRO-000001",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "first_name": "Example",
      "last_name": "Example",
      "credentials": "text",
      "role": "text",
      "specialty": "text",
      "npi": "text",
      "license_no": "LIC-000001",
      "license_expires": "2026-10-30",
      "department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "provider_no": "PRO-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "credentials": "text",
  "role": "text",
  "specialty": "text",
  "npi": "text",
  "license_no": "LIC-000001",
  "license_expires": "2026-10-30",
  "department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidNoPersonnel record
user_iduuidNoUser id
first_nametextYesFirst name
last_nametextYesLast name
credentialstextNoCredentials
roletextNoRole
specialtytextNoSpecialty
npitextNoNPI
license_notextNoLicense number
license_expiresdateNoLicense expires
department_iduuidNoDepartment
can_prescribebooleanNoMay prescribe
is_activebooleanNoActive
dea_notextNoDEA number — Two letters and seven digits.
dea_expiresdateNoDEA registration expires
dea_schedulestextNoDEA schedules — For example 2,2N,3,3N,4,5
practice_statetextNoState that issued the license number
spitextNoSurescripts prescriber id
practice_site_iduuidNoPractice site

Sample body

{
  "first_name": "Example",
  "last_name": "Example",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "credentials": "text",
  "role": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider_no": "PRO-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "credentials": "text",
  "role": "text",
  "specialty": "text",
  "npi": "text",
  "license_no": "LIC-000001",
  "license_expires": "2026-10-30",
  "department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/providers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Example","last_name":"Example","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","user_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","credentials":"text","role":"text"}'
PUT/api/ehr/providers/{id}Change a providers

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
employee_iduuidNoPersonnel record
user_iduuidNoUser id
first_nametextYesFirst name
last_nametextYesLast name
credentialstextNoCredentials
roletextNoRole
specialtytextNoSpecialty
npitextNoNPI
license_notextNoLicense number
license_expiresdateNoLicense expires
department_iduuidNoDepartment
can_prescribebooleanNoMay prescribe
is_activebooleanNoActive
dea_notextNoDEA number — Two letters and seven digits.
dea_expiresdateNoDEA registration expires
dea_schedulestextNoDEA schedules — For example 2,2N,3,3N,4,5
practice_statetextNoState that issued the license number
spitextNoSurescripts prescriber id
practice_site_iduuidNoPractice site

Sample body

{
  "first_name": "Example",
  "last_name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "provider_no": "PRO-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "first_name": "Example",
  "last_name": "Example",
  "credentials": "text",
  "role": "text",
  "specialty": "text",
  "npi": "text",
  "license_no": "LIC-000001",
  "license_expires": "2026-10-30",
  "department_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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/providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/providers/{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/providers/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 providers, 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
provider_notextread onlyProvider no
employee_iduuidread, writePersonnel record
user_iduuidread, writeUser id
first_nametextread, writeFirst name
last_nametextread, writeLast name
credentialstextread, writeCredentials
roletextread, writeRole
specialtytextread, writeSpecialty
npitextread, writeNPI
license_notextread, writeLicense number
license_expiresdateread, writeLicense expires
department_iduuidread, writeDepartment
can_prescribebooleanread, writeMay prescribe
is_activebooleanread, writeActive
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
dea_notextread, writeDEA number — Two letters and seven digits.
dea_expiresdateread, writeDEA registration expires
dea_schedulestextread, writeDEA schedules — For example 2,2N,3,3N,4,5
practice_statetextread, writeState that issued the license number
spitextread, writeSurescripts prescriber id
practice_site_iduuidread, writePractice site
epcs_statustextread onlyEpcs status

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