TRANXACT.AI Help

EHR · Pharmacy

Formulary

What may be prescribed, with the controlled and high-alert flags that change how it is handled.

Type REST6 operationsBase path /api/ehr/formularyPublished as /api/v1/formulary

Download specification (OpenAPI 3.1) Screen: Formulary

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 › Formulary 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.formulary · 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/formularyList formulary

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",
      "code": "COD-000001",
      "drug_name": "Example",
      "generic_name": "Example",
      "drug_class": "text",
      "rxnorm_code": "RXN-000001",
      "form": "text",
      "strength": "text",
      "route": "text",
      "is_controlled": true,
      "controlled_schedule": "text",
      "is_high_alert": true,
      "requires_pa": true,
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "drug_name": "Example",
  "generic_name": "Example",
  "drug_class": "text",
  "rxnorm_code": "RXN-000001",
  "form": "text",
  "strength": "text",
  "route": "text",
  "is_controlled": true,
  "controlled_schedule": "text",
  "is_high_alert": true,
  "requires_pa": true,
  "item_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/formulary/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/formularyCreate a formulary

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
drug_nametextYesMedication
generic_nametextNoGeneric name
drug_classtextNoClass
rxnorm_codetextNoRxNorm
formtextNoForm
strengthtextNoStrength
routetextNoRoute
is_controlledbooleanNoControlled substance
controlled_scheduletextNoSchedule
is_high_alertbooleanNoHigh alert
requires_pabooleanNoPrior authorization
item_iduuidNoInventory item
unit_pricenumericNoUnit price
min_age_yearsintegerNoMin age years
max_dose_per_daynumericNoMaximum daily dose
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "drug_name": "Example",
  "generic_name": "Example",
  "drug_class": "text",
  "rxnorm_code": "RXN-000001",
  "form": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "drug_name": "Example",
  "generic_name": "Example",
  "drug_class": "text",
  "rxnorm_code": "RXN-000001",
  "form": "text",
  "strength": "text",
  "route": "text",
  "is_controlled": true,
  "controlled_schedule": "text",
  "is_high_alert": true,
  "requires_pa": true,
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/formulary" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","drug_name":"Example","generic_name":"Example","drug_class":"text","rxnorm_code":"RXN-000001","form":"text"}'
PUT/api/ehr/formulary/{id}Change a formulary

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
codetextYesCode
drug_nametextYesMedication
generic_nametextNoGeneric name
drug_classtextNoClass
rxnorm_codetextNoRxNorm
formtextNoForm
strengthtextNoStrength
routetextNoRoute
is_controlledbooleanNoControlled substance
controlled_scheduletextNoSchedule
is_high_alertbooleanNoHigh alert
requires_pabooleanNoPrior authorization
item_iduuidNoInventory item
unit_pricenumericNoUnit price
min_age_yearsintegerNoMin age years
max_dose_per_daynumericNoMaximum daily dose
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "drug_name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "drug_name": "Example",
  "generic_name": "Example",
  "drug_class": "text",
  "rxnorm_code": "RXN-000001",
  "form": "text",
  "strength": "text",
  "route": "text",
  "is_controlled": true,
  "controlled_schedule": "text",
  "is_high_alert": true,
  "requires_pa": true,
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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/formulary/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/formulary/{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/formulary/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 formulary, 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
codetextread, writeCode
drug_nametextread, writeMedication
generic_nametextread, writeGeneric name
drug_classtextread, writeClass
rxnorm_codetextread, writeRxNorm
formtextread, writeForm
strengthtextread, writeStrength
routetextread, writeRoute
is_controlledbooleanread, writeControlled substance
controlled_scheduletextread, writeSchedule
is_high_alertbooleanread, writeHigh alert
requires_pabooleanread, writePrior authorization
item_iduuidread, writeInventory item
unit_pricenumericread, writeUnit price
min_age_yearsintegerread, writeMin age years
max_dose_per_daynumericread, writeMaximum daily dose
is_activebooleanread, writeActive
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
ndc_codetextread onlyNDC
quantity_unit_codetextread onlyQuantity unit code

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