Vitals

The Vitals feature allows the user to view vitals of all the patient currently in the hospital . It also allows to view vitals information of a specific patient during the hospital stay.

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 vitals from inpatient sources based on stay
id.

GET

Get patient vitals from inpatient sources based on
patientid

GET

Get list of vitals of all active hospital
stays

Get patient vitals from inpatient sources based on stay id.

GET

/v1/{practiceid}/stays/{stayid}/vitals

BETA: Retrieves a list patient vitals reading from inpatient sources for a specific patient stay in the hospital. Note: API lists vital readings, grouped by vital type (height, weight, blood pressure, etc).

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

stayid integer stayid

startdatetime string Only retrieve vitals that were taking on or after this date and time. Please use the format mm/dd/yyyy hh24:mi:ss.

enddatetime string Only retrieve vitals that were taking on or before this date and time. Please use the format mm/dd/yyyy hh24:mi:ss.

showemptyvitals boolean Show configured vitals that have no readings for this patient.

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

THIRDPARTYUSERNAME string User name of the patient in the third party application.

PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all

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

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. Returned in mm/dd/yyyy hh24:mi:ss format.

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.

stayid integer The ID of the stay associated with the patient

Example Code

Get patient vitals from inpatient sources based on patientid

GET

/v1/{practiceid}/chart/{patientid}/vitals/inpatient

Retrieves a list patient vitals reading from inpatient sources. Note: API lists vital readings, grouped by vital type (height, weight, blood pressure, etc).

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

enddate string Only retrieve vitals that were taking on or before this date

departmentid integer The department for this patient. A patient may have multiple charts, and the department determines which chart to retrieve.

startdate string Only retrieve vitals that were taking on or after this date

showemptyvitals boolean Show configured vitals that have no readings for this patient.

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

THIRDPARTYUSERNAME string User name of the patient in the third party application.

PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all

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.

Example Code

Get list of vitals of all active hospital stays

GET

/v1/{practiceid}/stays/active/vitals

BETA: Retrieves vitals across all the active stays in the hospital. Note: API lists vital readings, grouped by vital type (height, weight, blood pressure, etc).

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

startdatetime string Only retrieve vitals that were taking on or after this date and time.

enddatetime string Only retrieve vitals that were taking on or before this date and time.

showemptyvitals boolean Show configured vitals that have no readings for this patient.

key string Key for the vital group, E.g., HEIGHT. Get the keys using /chart/configuration/vitals

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

THIRDPARTYUSERNAME string User name of the patient in the third party application.

PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all

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

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. Returned in mm/dd/yyyy hh24:mi:ss format.

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.

stayid integer The ID of the stay associated with the patient

Example Code