API Change (21.8): Populate 'Priority' attribute on Order ID Endpoint

Summary: When orders are placed, they can be determined as STAT/Urgent. This means that the order should be completed ASAP. This update will populate the priority attribute in GET /chart/encounter/{encounterid}/orders/{orderid}. 

Products: athenaClinicals  

Available: August 6, 2021  


  • API endpoints affected include these categories  
    • Orders 


All endpoints affected

  • GET /chart/encounter/{encounterid}/orders/{orderid} 

Is this a breaking change: No 


What is changing

We are adding a ‘priority’ attribute to the GET /chart/encounter/{encounterid}/orders/{orderid} endpoint. Priority informs if the order is scheduled as STAT or Urgent in which case it is of high priority. 

Why we’re making the change

This update is being made to inform endpoint users of the priority of the order. 

What will current users of the endpoint need to update in their code

This is an additional attribute so if a user does not want to use the attribute no code changes are required. If a user would like to use this attribute they will need to update their code to utilize this attribute. 

What will happen if users of the endpoint do not update their code

This is not a breaking change so nothing will happen if changes are not made. 

Link to Developer Portal documentation

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

On this Page