Order- IV Medication
The Order - IV Medications allows the user to view a list of IV Medication orders for all the patients currently in the hospital. It also allows to view order for a specific inpatient.
The Order - IV Medication Reference allows the user to view the list of configured 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 IV medication orders for a stay
GET
/v1/{practiceid}/stays/{stayid}/orders/ivmedication
BETA: Retrieves a list of IV medication 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.
completeddate
string
The date the order was completed. Returned in mm/dd/yyyy hh24:mi:ss format.
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.
diluentdoseamount
integer
The dose amount of the Diluent.
diluentdoseunit
string
The name of the unit of the Dose for the additive (Like 'mL').
diluentingredientname
string
The name of the ingredient the infusion is being diluted in. This name correlates to the description of the HIC_SEQN.
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 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 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.
doseamount
string
The quantity of the IV medication ordered.
doseunit
string
The unit attribution of the dose amount. E.g., mg,mcg
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, minutes, weeks, doses).
frequency
string
The frequency the order will be performed (every day, once).
infusionadministrationmethod
string
The method this infusion is going to be administered. 1 of these values: push : The Medication is given via Push (syringe). infusionwithdiluent : The medication is being administered via an Infusion over time and being diluted in a diluent. infusionwithoutdiluent : The medication is being administered via an Infusion over time, but not being diluted in a diluent.
infusionrateamount
integer
The rate (always assumed to be ml/hr) that the order is to be infused.
inpatientslidingscale
string
The name of the locally defined sliding scale configuration.
isprn
string
Whether or not the order was ordered as "pro re nata", or "as needed".
isslidingscalesig
string
Describes if the medication is using sliding scale configuration.
ivadditives
object
An array of medications also attached to the order. They are only used with IV orders.'
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.
pharmacistverifieddate
string
The date the order was verified by the pharmacy. Returned in mm/dd/yyyy hh24:mi:ss format.
pharmacistverifieduser
string
The name of the user who verified the order.
priority
string
The urgency of the order to be performed. Options are STAT/Now/Routine/Scheduled.
prnnote
string
If the order was ordered as PRN, the note will describe what symptoms the medication should be given for. Example: as needed for pain.
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.
stopdate
string
The date the order is scheduled to end. Returned in mm/dd/yyyy hh24:mi:ss format.
unstructuredsig
string
Order details entered through a free text, rather than structured, order workflow.
Example Code
Get list of IV medication orders for all patients currently in hospital
GET
/v1/{practiceid}/stays/active/orders/ivmedication
BETA: Retrieves a list of IV medication orders for all patients currently in the hospital based on the specific ordertype.
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/ivmedication.
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.
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.
diluentdoseamount
integer
The dose amount of the Diluent.
diluentdoseunit
string
The name of the unit of the Dose for the additive (Like 'mL').
diluentingredientname
string
The name of the ingredient the infusion is being diluted in. This name correlates to the description of the HIC_SEQN.
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 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 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.
doseamount
string
The quantity of the IV medication ordered.
doseunit
string
The unit attribution of the dose amount. E.g., mg,mcg
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, minutes, weeks, doses).
frequency
string
The frequency the order will be performed (every day, once).
infusionadministrationmethod
string
The method this infusion is going to be administered. 1 of these values: push : The Medication is given via Push (syringe). infusionwithdiluent : The medication is being administered via an Infusion over time and being diluted in a diluent. infusionwithoutdiluent : The medication is being administered via an Infusion over time, but not being diluted in a diluent.
infusionrateamount
integer
The rate (always assumed to be ml/hr) that the order is to be infused.
inpatientslidingscale
string
The name of the locally defined sliding scale configuration.
isprn
string
Whether or not the order was ordered as "pro re nata", or "as needed".
isslidingscalesig
string
Describes if the medication is using sliding scale configuration.
ivadditives
object
An array of medications also attached to the order. They are only used with IV orders.'
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.
pharmacistverifieddate
string
The date the order was verified by the pharmacy. Returned in mm/dd/yyyy hh24:mi:ss format.
pharmacistverifieduser
string
The name of the user who verified the order.
priority
string
The urgency of the order to be performed. Options are STAT/Now/Routine/Scheduled.
prnnote
string
If the order was ordered as PRN, the note will describe what symptoms the medication should be given for. Example: as needed for pain.
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.
stopdate
string
The date the order is scheduled to end. Returned in mm/dd/yyyy hh24:mi:ss format.
unstructuredsig
string
Order details entered through a free text, rather than structured, order workflow.
Example Code
Get reference list of orderable IV medications
GET
/v1/{practiceid}/stays/configuration/orders/ivmedication
BETA: Retrieves the configured list of IV medications 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