The Vitals feature allow the user to retrieve patient vitals measurements, record vitals to the patient's flowsheet. Patient vitals elements are configured by the practice. All patient vitals are returned regardless of source, but the adding of vitals here is only when it's outside the context of an encounter. If you wish to add vitals to an encounter, please use the POST /chart/encounter/{encounterid}/vitals endpoint instead. Please note that if you do add vitals using this endpoint, you are responsible for notifying the provider or practice about any clinically relevant data or results. See the GET /chart/configuration/vitals endpoint for the list of available vitals this practice accepts. The Vitals Reference feature allows the user to retrieve the list of vitals configured for a practice.

API users can add and update vitals that occur outside an encounter (i.e., an encounterid is not required). The only vitals allowed to be posted/updated through these endpoints are device-generated vitals. Device-generated vitals are measurements taken by a device (e.g., blood pressure cuff, pulse oximeter) connected to the partner’s application. The device-generated vitals simulate a practice member entering vitals measurements directly into a patient’s flowsheet.

The user’s application must be the primary source of the vitals information. API users are responsible for contacting the patient’s care manager or physician if the vitals are outside a set threshold. The vitals added through the endpoint are a back-up of the measurements presented in the partner’s application.

A rollout toggle must be turned on for practices to see the vitals posted by these endpoints in the patient flowsheets. With the toggle disabled, only non-API entries appear in the flowsheets.

Retrieve a patient’s vitals via:
GET /chart/{patientid}/vitals

This returns a list of vitals tied to the patient, and for each vital, a list of readings (in different subsections). By default, only the attributes that have readings for the patient are returned.

However, you can get the complete list via: GET /chart/{patientid}/vitals&showemptyvitals=true

Add vitals via:
POST /chart/{patientid}/vitals

The vitals value in the POST API is a complex url-encoded JSON structure. It’s an array of arrays. Each subarray contains a group of related readings.

  • All of the vital attributes must have the readingtaken date.
  • You may not post vitals with different readingtaken dates in the same POST.
  • If no readingtaken date is given, the date defaults to the current day.
  • Multiple vitals measurements can be posted for the same date.

The list of readings returned by the GET contains a vitalid value. This uniquely identifies that particular reading.

You can use the vitalid to update the value of that particular reading via: PUT/chart/{patientid}/vitals/{vitalid}

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Get patient's vitals
Example Code
List patient's vitals from all sources
Example Code
Update vitals reading

Modifies the specific vital information of the patient

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

Input Parameters

Expand all
Example Code