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

POST

Add new vital information for given
encounter

GET

Get list of vitals for given
encounter

PUT

Update vital information for given
encounter

DELETE

Delete vital information for given
encounter

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

Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

encounterid integer encounterid

Content-Type string Content type of the payload

❙ Request Body

Expand all

vitals array This is an array of arrays in JSON. Each subarray contains a group of related readings, like systolic and diastolic blood pressure. They will be assigned the same readingID

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

Try in Postman

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

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

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

Try in Postman

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 all

value string The reading value. See the configuration for the proper units.

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

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

Try in Postman

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