Vitals

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.

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
Submit

Get patient's vitals

GET
/v1/{practiceid}/ccda/{patientid}/vitals
Retrieves the vital signs data obtained from the patient during the clinical encounter
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
format string Document type.
enddate string For date filterable items, exclude data after this datetime. Format is MM/DD/YYYY HH24:MM:SS.
xmloutput boolean If set to true, use XML (not JSON) as output. Not needed if an Accept header with application/xml header is included in the request. If set to false, it will return the CCDA format (XML) wrapped in a JSON response.
departmentid integer The department from which to retrieve the patient's chart.
startdate string For date filterable items, exclude data before this datetime. Format is MM/DD/YYYY HH24:MM:SS.
encounterid string The encounter vitals are associated with.
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

Add vitals to patient's chart

POST
/v1/{practiceid}/chart/{patientid}/vitals
Records the source of the data and vitals measurements of the patient.
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
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

List patient's vitals from all sources

GET
/v1/{practiceid}/chart/{patientid}/vitals
Retrieves the list of Vitals information of a specific patient
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
Example Code

Update vitals reading

PUT
/v1/{practiceid}/chart/{patientid}/vitals/{vitalid}
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
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
vitalid integer vitalid
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.
Example Code

Get list of practice-configured vitals fields

GET
/v1/{practiceid}/chart/configuration/vitals
The Vitals Reference feature allows the user to retrieve the list of vitals configured for a practice.
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
specialtyid string Show only the vitals configured for this specialty
showunconfigured boolean Show all global vitals, even if they are not configured at this practice.
limit integer Number of entries to return (default 1000, max 1000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
abbreviation string Short human-readable string for this vital group. E.g., Ht.
attributes array List of vital attributes in this vital group. Contains all possible attributes even if there are no readings.
istiedtomeasurement string If true, this vital is tied to some measurement.
key string Key for this vital group. E.g., HEIGHT.
ordering integer Configured order for this vital group
Example Code