Order Group

The Order group feature allows the user to create orders, RTO's ( Return To Office - appointment ticklers), and letters for a patient outside an encounter. Order Set Reference allows the user to retrieve and view the types of ordersets configured in the system.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Create order groups for given patient
POST
/v1/{practiceid}/chart/{patientid}/ordergroups

Creates an ordergroup for a specific patient chart outside an encounter flow

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
departmentid integer The department to use for the order group.
orderingproviderid integer The ordering provider ID, if not given a random provider from that department will be used.
patientcaseid integer The ID of the patient case generating this new order group.

Output Parameters

Expand all
encounterid integer Encounter id.
errormessage string Error message will be set if something goes wrong while creating the order group.
success string The value will be set to true if order group created successfully.
Example Code
Get list of ordersets for given user
GET
/v1/{practiceid}/configuration/ordersets

Retrieves the list of ordersets

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
username string Username to find all available order sets for. Will return all order sets configured for this user as well as order sets configured for all users.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
diagnoses array An array of diagnosis objects attached to this order set.
error string Some order sets cannot be used during an encounter because some of the orders have become invalid. If that is the case, an error message will be returned along with the order set name and ID. If there is an error, a diagnoses array will not be returned.
ordersetid integer ID of the order set.
ordersetname string Name of the order set. This is set by the practice/user.
Example Code