EHR · Clinical
Order Entry (CPOE)
Orders run through decision support before they are written. A contraindication stops the order unless it is overridden with a reason.
Type REST2 operationsBase path
/api/ehr/cpoeDownload specification (OpenAPI 3.1) Screen: Order Entry (CPOE)
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 › Order Entry (CPOE) 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
2 operations. Open one for its parameters, bodies, responses and a sample request.
POST/api/ehr/cpoe/orderOrder
Request body
The keys this action reads (* = required; "one of" lists the only values):
dose, route, frequency, durationDays, quantity, refills, instructions, patientId*, encounterId, orderType, providerId, priority, procedureId*, formularyId*, overrideReason, clinicalNotes, indication; priority one of routine|urgent|stat|timed; tests: [{ trim }]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/cpoe/order" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"dose":"value","route":"value","frequency":"value","durationDays":"value","quantity":"value","refills":"value"}'POST/api/ehr/cpoe/order-setOrder set
Request body
The keys this action reads (* = required; "one of" lists the only values):
patientId*, orderSetId, providerId, encounterId, excludeResponse
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/cpoe/order-set" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"patientId":"value","orderSetId":"value","providerId":"value","encounterId":"value","exclude":"value"}'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 › Order Entry (CPOE) 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.