TRANXACT.AI Help

EHR · E-Prescribing

E-Prescribing Messages

Every NCPDP SCRIPT message sent to or received from a pharmacy: NewRx, renewals, changes, cancellations, fill notices and the network's status answers, with the raw XML exactly as it travelled.

Type REST8 operationsBase path /api/ehr/erx-messagesPublished as /api/v1/erx-messages

Download specification (OpenAPI 3.1) Screen: E-Prescribing Messages

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 › E-Prescribing Messages 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.erx_messages · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/ehr/erx-messagesList e-prescribing messages

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",
      "message_id": "text",
      "relates_to_message_id": "text",
      "message_type": "text",
      "direction": "text",
      "prescription_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "pharmacy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "prescriber_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "transport": "text",
      "status": "draft",
      "status_code": "STA-000001"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "message_id": "text",
  "relates_to_message_id": "text",
  "message_type": "text",
  "direction": "text",
  "prescription_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "pharmacy_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "prescriber_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "transport": "text",
  "status": "draft",
  "status_code": "STA-000001"
}

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

Sample request

curl "https://demo.tranxact.ai/api/ehr/erx-messages/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/erx-messagesPost e-prescribing messages

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/erx-messages" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/erx-messages/{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/erx-messages/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/erx-messages/{id}Put e-prescribing messages

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 PUT "https://demo.tranxact.ai/api/ehr/erx-messages/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/ehr/erx-messages/{id}Delete e-prescribing messages

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 DELETE "https://demo.tranxact.ai/api/ehr/erx-messages/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/erx-messages/{id}/xmlXml

Path parameters

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

Response

200 with the data as JSON.

Sample request

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

Request body

The keys this action reads (* = required; "one of" lists the only values):

xml*

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/erx-messages/inbound" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"xml":"value"}'

Data model

Every field of a erx messages, 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
message_idtextread onlyMessage id
relates_to_message_idtextread onlyRelates to message id
message_typetextread onlyMessage type
directiontextread onlyDirection
prescription_iduuidread onlyPrescription id
patient_iduuidread onlyPatient id
pharmacy_iduuidread onlyPharmacy id
prescriber_iduuidread onlyPrescriber id
connection_iduuidread onlyConnection id
transporttextread onlyTransport
statustextread onlyStatus
status_codetextread onlyStatus code
status_detailtextread onlyStatus detail
is_controlledbooleanread onlyIs controlled
signedbooleanread onlySigned
digest_sha256textread onlyDigest sha256
signaturetextread onlySignature
signing_key_idtextread onlySigning key id
raw_xmltextread onlyRaw xml
sent_attimestamp with time zoneread onlySent at
received_attimestamp with time zoneread onlyReceived at
processed_attimestamp with time zoneread onlyProcessed at
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › E-Prescribing Messages 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.