Vitals (Encounters)
The Vitals feature allows the provider to record the vital signs obtained from the patient during the clinical encounter. This functionality allows the user to retrieve, add, update, or delete vitals from a specific open encounter.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
Add new vital information for given encounter
POST
/v1/{practiceid}/chart/encounter/{encounterid}/vitals
Create a record of vital readings for a patient for a specific encounter
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
encounterid
integer
encounterid
Content-Type
string
Content type of the payload
Output Parameters
Expand all
errormessage
string
If the operation failed, this will contain any error messages.
success
string
Whether the operation was successful or not.
Example Code
Get list of vitals for given encounter
GET
/v1/{practiceid}/chart/encounter/{encounterid}/vitals
Retrieves a patient's vitals reading for a specific encounter
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
encounterid
integer
encounterid
enddate
string
Only retrieve vitals that were taking on or before this date
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.
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
Update vital information for given encounter
PUT
/v1/{practiceid}/chart/encounter/{encounterid}/vitals/{vitalid}
Modifies a patient's vitals reading for a specific encounter
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
encounterid
integer
encounterid
vitalid
integer
vitalid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
errormessage
string
If the operation failed, this will contain any error messages.
success
string
Whether the operation was successful or not.
Example Code
Delete vital information for given encounter
DELETE
/v1/{practiceid}/chart/encounter/{encounterid}/vitals/{vitalid}
Deletes the record of a specific vitals reading of the patient for a specific encounter
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
encounterid
integer
encounterid
vitalid
integer
vitalid
Output Parameters
Expand all
errormessage
string
If the operation failed, this will contain any error messages.
success
string
Whether the operation was successful or not.
Example Code