12.1 Bi-weekly Release: Updated Endpoints: Display Schedule within Time Period for Consult Orders


You can now populate the Schedule Within time period for consult orders.


athenaClinicals, athenaClinicals for Hospitals & Health Systems




December 1, 2022


Consult orders will populate a SCHEDULEWITHIN attribute on a consult order document which will populate the schedule within time period documented on the order.


  • N/A

Is this a breaking change

No, this is not a breaking change

Endpoints affected

  • GET /patients/{patientid}/documents/order/{orderid}

New Endpoints

  • N/A


Refer to the following resources for more information:

What is changing

We will be populating an attribute to provide the schedule within time period documented on consult orders. 

Why we’re making the change

We are making this change to populate additional relevant information via API.  

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

Users of the current endpoint must update their code if they would like to use this functionality.

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

This is not a breaking change so currently users do not need to update their code if they do not wish to use this functionality.

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

On this Page