22.7 Bi-weekly Release: Updated endpoints: Providing structured prior authorization details and Ask on Order Entry (AOE) questions with orders endpoints


Surgery and order endpoints are being updated to consistently populate Ask of Order Entry (AOE) questions and to populate structure prior auth details as entered on orders


Marketplace MDP




August 11, 2022


We are making enhancements to how ‘ask on order entry’ (AOE) questions and prior authorization details are displayed along with order details. This enhancement will do the following:

  1. Populate ask on order entry questions and values along with structured prior authorization details on
    • GET /patients/{patientid}/documents/order/{orderid}
    • GET /patients/{patientid}/documents/surgery/{surgeryid} endpoints
  2. Enable prior authorization details to be structured on 
    • GET /chart/encounter/{encounterid}/orders/{orderid}.


  • N/A

Is this a breaking change

No, this isn’t a breaking change

Endpoints affected

  • GET /patients/{patientid}/documents/order/{orderid} 
  • GET /patients/{patientid}/documents/surgery/{surgeryid}
  • GET /chart/encounter/{encounterid}/orders/{orderid}

New Endpoints

  • N/A


Refer to the following resources for more information:

What is changing

Within the following endpoints, you can use the showquestions parameter which will then return the Ask on Order Entry (AOE) questions and responses:

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

With the following endpoints you can use the showstructredauthorizationdetails parameter which will return the prior authorization details in a structured format:

  • GET /patients/{patientid}/documents/order/{orderid} 
  • GET /patients/{patientid}/documents/surgery/{surgeryid}
  • GET /chart/encounter/{encounterid}/orders/{orderid}

Why we’re making the change

We’re making this change to populate ask on order entry (AOE) questions and values along with structured prior authorization details more consistently across endpoints used to gather order detail information. This will make it easier for vendors to gather relevant ordering information.

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

These are additional attributes, which are behind parameters, so if a vendor does not want to use these new attributes no code changes are required. If a vendor would like to use these attributes, they will need to update their code to utilize parameters and attributes.

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.

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

On this Page