HPI Findings

The HPI Findings feature allows the user to view the record and update the history of the patient's present illness. The HPI Findings Template are custom templates for the History of Present Illness encounter section. This is configured in Practice.

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

Get HPI findings for given encounter

GET
/v1/{practiceid}/chart/encounter/{encounterid}/hpi
Retrieves the HPI summary for an 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
showstructured boolean If true, returns history of present illness templates as structured data. If false, returns it via lightly-HTML marked up English text, as displayed in the athenanet encounter summary.
templateids array If templateids is passed in, it will return only the template data for the array of ids passed in. The SHOWSTRUCTURED flag must be true to use this.

Output Parameters

Expand all
hpi array The structured HPI data. It is structured as a list of paragraphs, each containing a list of sentences, each containing a list of findings.
hpitoros string Whether ROS is as noted in HPI.
hpitoroslastmodifiedby string The username of the provider that last modified the hpitoros parameter. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.
hpitoroslastmodifieddatetime string The date and time that the hpitoros field was last modified. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.
lastmodifiedby string A string representing the username of the user who last modified the history of present illness section.
lastmodifieddatetime string The last time any information in the history of present illness section was modified
sectionnote string The structured section-level note for the history of present illness section.
sectionnotelastmodifiedby string A string representing the username of a the user who last modified the history of present illness section note.
sectionnotelastmodifieddatetime string The last time the history of present illness section note was modified
summarytext string The unstructured summary
templatedata array An array of objects each containing the names, ids and notes for templates attached to the encounter.
templates string The comma separated list of selected HPI templates used
Example Code

Update HPI findings for given encounter

PUT
/v1/{practiceid}/chart/encounter/{encounterid}/hpi
Modifies the HPI Summary for an 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

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

Feedback from Elavon for HPI transaction

POST
/v1/{practiceid}/hpi/transactionid/{transactionid}
Returns SUCCESS/ERRORTEXT.
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
transactionid integer transactionid
Content-Type string Content type of the payload

Request Body

Expand all

Output Parameters

Expand all
code string Return the response code
errortext string Describes the error on API Call
success string Returns true or false depending on API call success criteria
Example Code

Get reference template for HPI findings

GET
/v1/{practiceid}/chart/encounter/{encounterid}/hpi/templates
BETA: Retrieves the configured HPI templates for this 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
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
ageunits string The units for measuring age. (Y=years, M=months, W=weeks, D=days)
goals string If true, this template contains findings that can be used as goals in the Assessment and Plan.
maxage integer The minimum age filtered by this template
minage integer The minimum age filtered by this template
name string The name of the template
note string The note attached to this template
sex string The sex filtered by this template
templateid integer The template ID.
Example Code