Order - Labs
The Order - Lab feature allows the user to view a list of lab orders for all the patients currently in the hospital. It also allows to view lab order for a specific inpatient.
The Order - Labs Reference allows the user to view the list of configured orderable lab orders.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
- Reference
Get list of lab orders for a stay
GET
/v1/{practiceid}/stays/{stayid}/orders/lab
BETA: Retrieves a list of lab orders for a specific patient stay 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
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.
clinicalproviderid
integer
The athena ID of the facility (facilityid) and or person that is performing the lab order and will be sending a result.
clinicalproviderordertypeid
integer
The ID of the clinical provider order type which is the facility specific ID of the order.
clinicalproviderordertypename
string
The name of the clinical provider order type which is the facility specific name of the 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.
duration
string
How long the order should be repeated for. For instance should it be done for 1 day, 2 days or until discontinued.
durationamount
integer
The number of units that the order will repeat for. Such as '4' days.
durationunit
string
The unit the duration amount corresponds to (days, hours, times).
frequency
string
The frequency the order will be performed (every day, once).
loinccode
string
The LOINC code for the order.
loincdescription
string
The LOINC description for the order.
name
string
The name of the order.
note
string
Free text comments field.
ordercreateddate
string
The date the order was originally placed if order was generated outside athena. Returned in mm/dd/yyyy hh24:mi:ss format.
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. For instance does the lab need to be performed immediately or can it wait for a routine rounding time. Options are STAT/Now/Routine/Scheduled.
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.
samplecollectedby
string
The user who will take the specimen.
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.
stopdate
string
The date the order is scheduled to end. Returned in mm/dd/yyyy hh24:mi:ss format.
Example Code
Get specific lab order details
GET
/v1/{practiceid}/stays/orders/lab/{orderid}
BETA: Retrieves information of a specific laboratory order.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
orderid
integer
orderid
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.
clinicalproviderid
integer
The athena ID of the facility (facilityid) and or person that is performing the lab order and will be sending a result.
clinicalproviderordertypeid
integer
The ID of the clinical provider order type which is the facility specific ID of the order.
clinicalproviderordertypename
string
The name of the clinical provider order type which is the facility specific name of the 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.
duration
string
How long the order should be repeated for. For instance should it be done for 1 day, 2 days or until discontinued.
durationamount
integer
The number of units that the order will repeat for. Such as '4' days.
durationunit
string
The unit the duration amount corresponds to (days, hours, times).
frequency
string
The frequency the order will be performed (every day, once).
loinccode
string
The LOINC code for the order.
loincdescription
string
The LOINC description for the order.
name
string
The name of the order.
note
string
Free text comments field.
ordercreateddate
string
The date the order was originally placed if order was generated outside athena. Returned in mm/dd/yyyy hh24:mi:ss format.
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. For instance does the lab need to be performed immediately or can it wait for a routine rounding time. Options are STAT/Now/Routine/Scheduled.
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.
samplecollectedby
string
The user who will take the specimen.
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.
stopdate
string
The date the order is scheduled to end. Returned in mm/dd/yyyy hh24:mi:ss format.
Example Code
Get list of lab orders for all patients currently in hospital
GET
/v1/{practiceid}/stays/active/orders/lab
BETA: Retrieves a list of laboratory orders 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
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/lab.
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.
clinicalproviderid
integer
The athena ID of the facility (facilityid) and or person that is performing the lab order and will be sending a result.
clinicalproviderordertypeid
integer
The ID of the clinical provider order type which is the facility specific ID of the order.
clinicalproviderordertypename
string
The name of the clinical provider order type which is the facility specific name of the 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.
duration
string
How long the order should be repeated for. For instance should it be done for 1 day, 2 days or until discontinued.
durationamount
integer
The number of units that the order will repeat for. Such as '4' days.
durationunit
string
The unit the duration amount corresponds to (days, hours, times).
frequency
string
The frequency the order will be performed (every day, once).
loinccode
string
The LOINC code for the order.
loincdescription
string
The LOINC description for the order.
name
string
The name of the order.
note
string
Free text comments field.
ordercreateddate
string
The date the order was originally placed if order was generated outside athena. Returned in mm/dd/yyyy hh24:mi:ss format.
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. For instance does the lab need to be performed immediately or can it wait for a routine rounding time. Options are STAT/Now/Routine/Scheduled.
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.
samplecollectedby
string
The user who will take the specimen.
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.
stopdate
string
The date the order is scheduled to end. Returned in mm/dd/yyyy hh24:mi:ss format.
Example Code
Get reference list of orderable labs
GET
/v1/{practiceid}/stays/configuration/orders/lab
BETA: Retrieves the configured list of lab orders based on the seach criteria.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
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