Flowsheet

The Flowsheet feature provides a view of patient information over time. This feature will allow the user to retrieve the flow sheet data for a specific problem. Flowsheet Template Reference feature allows the user to retrieve the templates from the streamlined enabled practices.

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

Submit

Endpoints

Primary

GET

Get patient's problem-specific
flowsheet
Reference

GET

Get list of problem-specific flowsheet
templates

Get patient's problem-specific flowsheet

GET

/v1/{practiceid}/chart/{patientid}/flowsheets/{snomedcode}

Retrieves data of the patient with a specific problem

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

snomedcode integer snomedcode

enddate string Date you want flowsheet element's data to stop.

departmentid integer The department ID of the patient chart.

providerid array The list of provider IDs to format the flowsheet as.

showglobalflowsheetelementsonly boolean Show elements from the globally configured flowsheet rather than those specific to a provider. This may restrict the information returned, but is generally faster.

startdate string Date you want flowsheet element's data to start.

Output Parameters

Expand all

globalflowsheettemplateid integer ID of the global template for this flowsheet (if applicable).

headers array An array of header elements associated with this flowsheet.

elementid integer The element ID of this header element.

elementkey string The element key of this header element.

name string The name of this header element.

question object The information on the question being asked.

type string The type of this header element.

value string The value entered for this header field.

labanalytes array Flowsheet elements of type LABANALYTE.

analytename string Text that describes this kind of analyte.

chartdata array An array of analytes for this specific type of analyte.

name string The name of the LABANALYTE.

medications array Flowsheet elements of type MEDICATION.

chartdata array Data for this flowsheet.

name string The name of the MEDICATION.

problemid integer ID of the problem related to this flowsheet.

vitals array Flowsheet elements of type VITAL.

chartdata object

abbreviation string Short human-readable string for this vital group. E.g., Ht.

key string Key for this vital group. E.g., HEIGHT.

ordering integer Configured order for this vital group

readings array List of vital attribute readings. One entry per attribute (so the temperature and where the temperature was taken are two different readings, tied together by the readingid

clinicalelementid string Key used to identify this particular vital attribute

code string Code indentifier for the reading.

codedescription string Description of the code identifier.

codeset string Codeset of the code.

createdby string The athenaNet username of the person who entered the vital.

createddate string The date this vital was entered into the chart. Returned in mm/dd/yyyy hh24:mi:ss format.

isgraphable string Flag indicating if this vital is graphable.

lastmodifiedby string The athenaNet username of the user that last modified the reading. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

lastmodifieddate string The date this vital was last modified. Returned in mm/dd/yyyy hh24:mi:ss format. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

percentilespec object

readingid integer Numeric key used to tie related and distinguish separate readings. So the diastolic and systolic blood pressure should have the same readingid.

readingtaken string Date that the reading was taken.

source string The source of this reading.

sourceid integer External key to source.

unit string Unit that describes this vital's value.

value string The value of this reading. NOTE: for numeric values, the units are always in the 'native' units per the configuration.

vitalid integer Unique ID for this vital attribute reading. Used to update/delete this reading.

name string The name of the VITAL.

Example Code

Get list of problem-specific flowsheet templates

GET

/v1/{practiceid}/chart/configuration/flowsheettemplates/{snomedcode}

Retrieves a flowsheet template for a specific problem

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

snomedcode integer snomedcode

departmentid integer The department ID for the provider. For non-enterprise practices, you may choose any department. This is requried only when passing in one or more provider IDs. If no provider ID is passed in, this field is ignored.

providerid array

Output Parameters

Expand all

globalflowsheettemplateid integer ID of the global template for this flowsheet (if applicable).

headers array An array of header elements associated with this flowsheet template.

labanalytes array Flowsheet elements of type LABANALYTE.

medications array Flowsheet elements of type MEDICATION.

problemid integer ID of the problem related to this flowsheet template.

vitals array Flowsheet elements of type VITAL.

Example Code