API Change (21.9): Provider ID field returns Facility ID when running Lab/Imaging Result subscription API

Summary: We’re updating our lab/imaging result endpoints so that the practice Provider ID is populated in the providerid attribute. The Clinical Provider ID, which is the provider/facility that created the result, will continue to populate in the facilityid attribute. Previously, the Clinical Provider ID incorrectly populated both the providerid and facilityid attribute.

Products: athenaClinicals

Available: September 3, 2021


  • This has a breaking change
  • API endpoints affected include these categories
    • Lab Results
    • Imaging Results


All endpoints affected

  • GET /imagingresults/changed
  • GET /labresults/changed
  • GET /patients/{patientid}/documents/labresult
  • GET /patients/{patientid}/documents/imagingresult

Is this a breaking change: Yes 


What is changing

We have identified an issue in our lab and imaging result APIs where the providerid is incorrectly displaying the Clinical Provider ID rather than the practice Provider ID for the document. This update will resolve that issue so the providerid attribute is populated with the practice provider ID for the document rather than the Clinical Provider ID.

Why we’re making the change

This is a bug that was identified and is now being changed.

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

Users of these endpoints should evaluate if they are expecting the Clinical Provider ID from the providerid attribute. If so, they should change their code to gather the Clinical Provider ID from the facilityid attribute.

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

If users do not update their code and expect the Clinical Provider ID from the providerid attribute this could potentially break the integration or populate incorrect provider or clinical provider details.

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