Order - Consult

Order - Consult allows the user to view a list of consultation orders for all the patients currently in the hospital . It also allows to view consultation  orders  for a specific patient's stay in the hospital.

Order - Consult Reference allows the user to view a list of consultation  that can be ordered for  a particular diagnosis.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Get list of consult orders for a stay
GET
/v1/{practiceid}/stays/{stayid}/orders/consult
BETA: Retrieves a the list of consult orders for a stayid.
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
stayid integer stayid
statusgroup string Active: Orders that are not yet completed. Signed orders: Orders that are signed by a doctor. Unsigned orders: Orders that have not yet been signed.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
activateddate string The date the order was entered. Returned in mm/dd/yyyy hh24:mi:ss format.
activateduser string The user who placed the order.
approveddate string The date the order was signed by a doctor. Returned in mm/dd/yyyy hh24:mi:ss format.
approveduser string The user who signed the placed order.
completeddate string The date the order was completed. Returned in mm/dd/yyyy hh24:mi:ss format.
completedreason string The reason a user entered for why the order was marked completed.
completeduser string The user who marked the order as completed via OrderView (means no work left).
createddate string The date the order was queued up to be placed in order entry. Returned in mm/dd/yyyy hh24:mi:ss format.
createduser string The user who queued up the order to be placed
departmentid integer The ID of the department from where the order was placed.
discontinueddate string The date the order was discontinued. Returned in mm/dd/yyyy hh24:mi:ss format.
discontinuedreason string The reason a user entered for why the order was discontinued.
discontinueduser string The user who discontinued the order.
discontinueorderingmethodname string The method through which the doctor instructed the order to be discontinued (Verbal, Written, Fax, Phone).
discontinueorderingproviderid integer The ID of the doctor who instructed the order to be discontinued.
discontinueorderingprovidername string The name of the doctor who instructed the order to be discontinued.
discontinuereferringproviderid integer The ID of the doctor who instructed the order to be discontinued from outside the practice.
discontinuesigneddate string The date the discontinue order was signed by a doctor. Returned in mm/dd/yyyy hh24:mi:ss format.
discontinuesigneduser string The doctor who signed the discontinue order.
name string The name of the order.
note string Free text comments field.
orderid integer The unique athena ID of this instance of the order.
orderingmethodname string The method through which the doctor instructed the order to be placed (Verbal, Written, Fax, Phone).
orderingproviderid integer The ID of the ordering doctor, which could be different than the user who placed the order (for example, an intake nurse).
orderingprovidername string The name of the doctor who is placing the order.
orderingproviderphone string The phone number for the ordering doctor.
ordertypeid integer The athena ID for the type of order being placed.
priority string The urgency of the order to be performed: Now or Routine.
reason string The reason why an order was placed.
referringproviderid integer The ID of the referring doctor, which may be a doctor outside of the practice who placed an order getting fulfilled in the hospital.
startdate string The date the order is scheduled to begin. Returned in mm/dd/yyyy hh24:mi:ss format.
status string The status the order is in.
stayid integer The ID of the hospital stay where the order was placed from.
Example Code
Get list of consult orders for all patients currently in hospital
GET
/v1/{practiceid}/stays/active/orders/consult
BETA: Retrieves a list of consult orders of a particular type for all patients currently in the hospital.
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
statusgroup string Active: Orders that are not yet completed. Signed orders: Orders that are signed by a doctor. Unsigned orders: Orders that have not yet been signed.
ordertypeid integer The athena ID for the type of order being placed. Get the IDs using /stays/configuration/orders/consult.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
activateddate string The date the order was entered. Returned in mm/dd/yyyy hh24:mi:ss format.
activateduser string The user who placed the order.
approveddate string The date the order was signed by a doctor. Returned in mm/dd/yyyy hh24:mi:ss format.
approveduser string The user who signed the placed order.
completeddate string The date the order was completed. Returned in mm/dd/yyyy hh24:mi:ss format.
completedreason string The reason a user entered for why the order was marked completed.
completeduser string The user who marked the order as completed via OrderView (means no work left).
createddate string The date the order was queued up to be placed in order entry. Returned in mm/dd/yyyy hh24:mi:ss format.
createduser string The user who queued up the order to be placed
departmentid integer The ID of the department from where the order was placed.
discontinueddate string The date the order was discontinued. Returned in mm/dd/yyyy hh24:mi:ss format.
discontinuedreason string The reason a user entered for why the order was discontinued.
discontinueduser string The user who discontinued the order.
discontinueorderingmethodname string The method through which the doctor instructed the order to be discontinued (Verbal, Written, Fax, Phone).
discontinueorderingproviderid integer The ID of the doctor who instructed the order to be discontinued.
discontinueorderingprovidername string The name of the doctor who instructed the order to be discontinued.
discontinuereferringproviderid integer The ID of the doctor who instructed the order to be discontinued from outside the practice.
discontinuesigneddate string The date the discontinue order was signed by a doctor. Returned in mm/dd/yyyy hh24:mi:ss format.
discontinuesigneduser string The doctor who signed the discontinue order.
name string The name of the order.
note string Free text comments field.
orderid integer The unique athena ID of this instance of the order.
orderingmethodname string The method through which the doctor instructed the order to be placed (Verbal, Written, Fax, Phone).
orderingproviderid integer The ID of the ordering doctor, which could be different than the user who placed the order (for example, an intake nurse).
orderingprovidername string The name of the doctor who is placing the order.
orderingproviderphone string The phone number for the ordering doctor.
ordertypeid integer The athena ID for the type of order being placed.
priority string The urgency of the order to be performed: Now or Routine.
reason string The reason why an order was placed.
referringproviderid integer The ID of the referring doctor, which may be a doctor outside of the practice who placed an order getting fulfilled in the hospital.
startdate string The date the order is scheduled to begin. Returned in mm/dd/yyyy hh24:mi:ss format.
status string The status the order is in.
stayid integer The ID of the hospital stay where the order was placed from.
Example Code
Get reference list of consult orders
GET
/v1/{practiceid}/stays/configuration/orders/consult
BETA: Retrieves a list of consult orders 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
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
searchvalue string A term to search for. Must be at least 2 characters

Output Parameters

Expand all
name string The name of the order
ordertypeid integer The athena ID of the type of order
Example Code