Lab Analyte

The Lab analytes feature allows the user to retrieve and view analytes information which is a part of laboratory Results. Analyte is the substance that is of interest in the analysis (for example: amount of hemoglobin in blood). To retrieve a list of vitals configured by the practice, please refer Vitals Overview. See the POST /patients/{patientid}/documents/labresult API on how to add lab result documents and analytes.

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

Endpoints

Get list of patient's lab analytes
GET
/v1/{practiceid}/chart/{patientid}/analytes

Retrieves the list of patient lab analytes

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

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
allresultsbyencounterid integer ID used to return lab results for a specific encounter.
exactduplicatedocumentid integer ID used when the lab results sends the exact same result multiple times.
supersededdocumentid integer ID used when the lab sends a result and later sends a more complete version of the result with additional information.
startdate string Filter lab orders not individual results that are on or after this date. Example: startdate=6/21/2015. If no startdate is specified, all prior lab orders will be included until enddate if specified.
labresultstatus string Filter the results based on the lab result's result status. Since the result status is a free text field, this list is not exhaustive, but does represent a majority of the used statuses.
showtemplate boolean If true, interpretation template added to the document is also returned.
showportalonly boolean If true, only documents published to the portal at the time of this call are returned.
showhidden boolean Includes the lab results and analytes marked as hidden. Hidden lab results and analytes are created when they are manually entered, for example on the qm tab or in flowsheets.
showabnormaldetails boolean Include the translation of the abnormalflag into HL7 code standards.
enddate string Filter lab orders not individual results that are on or before this date. Example: enddate=1/21/2018. If no enddate is specified, all lab orders found since startdate will be included if specified.
departmentid integer The athenaNet department id.
hideduplicate boolean If true, filters out results that have been marked as an as exact duplicate of another.
analyteresultstatus string Filter the results based on the analyte's result status. Since the result status is a free text field, this list is not exhaustive, but does represent a majority of the used statuses.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
abnormalflag string Status indicator of the measurement relative to normal (low, high, normal, abnormal)
abnormalhl7code string The HL7 code related to the abnormal flag.
abnormalhl7name string The HL7 description related to the abnormal flag.
analytedate string Date when this observation was recorded
analyteid number Athena ID for the given lab result observation/analyte
analytename string Name / description specific to this analyte
description string General description of the lab result test
labresultstatus string The status of the underlying lab result
loinc string Logical Observation Identifiers Names and Codes ID, if available
note string Additional note for this analyte, if applicable
observationidentifier string Local lab ID for the given lab result observation/analyte
referencerange string Reference range of values accepted as normal for this observation
resultstatus string The status of the result (e.g., "final", "preliminary", "corrected", etc.)
units string Units for this analyte entry, if provided by the lab
value string Value recorded for this observation
valuestatus string DEPRECATED -- use "abnormalflag" instead. Status indicator of the measurement relative to normal (low, high, normal, abnormal)
Example Code