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
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
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
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
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
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
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
stayid
integer
The ID of the stay associated with the patient
Example Code