API Change (22.1): Analyte name available when retrieving lab result

Summary: Point of Care Test lab orders with a Dropdown/Freetext List result type will populate the analyte name, analyteid and value within the observations object.

Products: athenaClinicals

Available: Jan 27, 2022

Highlights: 

API endpoints affected include these categories

  • Documents and Forms

 

Overview

Endpoint(s) affected:  

  • GET /patients/{patientid}/documents/labresult/{labresultid}

 

Is this a breaking change: 

No
 

What is changing

If a Point of Care Test lab order has the result type of Dropdown/Freetext List, the analyte name will populate within the observations object along with the analyteid and the value.

 

Why we’re making the change

This is being made to make it easier to find the name of the analyte the value relates to.

 

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 it.

 

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
Submit

On this Page