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

Endpoints

Primary

GET

Get HPI findings for given
encounter

PUT

Update HPI findings for given
encounter

POST

Feedback from Elavon for HPI
transaction
Reference

GET

Get reference template for HPI
findings

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.

paragraphid integer ID of the paragraph you are updating. If you pass in an invalid ID we will simply ignore it.

paragraphname string The label for this paragraph

sentences array

findings array The list of findings

contradictionids string A string representing an array of finding IDs that contradict the current finding ID. What this means is that if this finding is selected, any findings in the CONTRADICTIONIDS should not be selected.

findingid integer ID of the finding you are updating. If you pass in an invalid ID we will simply ignore it.

findinglastmodifiedby string The username of the provider that last modified the value for this finding.

findinglastmodifieddatetime string The date and time that the value for this finding was last modified.

findingname string The label for this finding. Note that this may contain specific answers for this finding (e.g. "wakes up 2 hours after going to sleep"). See GENERICFINDINGNAME for an example that does not contain specific answers.

findingnote string The note for this finding.

findingnotelastmodifiedby string The username of the provider that last modified the note for this finding.

findingnotelastmodifieddatetime string The date and time that the note for this finding was last modified.

findingtype string Describes the finding -- either NORMAL, ABNORMAL, or NEUTRAL.

freetext string The value of the text field sometimes associated with this finding.

freetextlastmodifiedby string The username of the provider that last modified the value of the text field sometimes associated with this finding.

freetextlastmodifieddatetime string The date and time that the value of the text field sometimes associated with this finding was last modified.

genericfindingname string The general label for this finding. It will not contain any specific answers for this finding (e.g. "wakes up ___ {{minutes*|hours}} after going to sleep").

medcinid integer Where available, the matching MEDCIN ID for this clinical finding.

optionlists string An array of arrays. Each inner array contains the possible options for a dropdown list. The order of the these arrays corresponds to the ordering of dropdowns from left to right within the finding.

selected string Whether the finding is selected. If templateids are not passed in, this field will not be returned.

selectedoptions string The options the user has chosen from any dropdowns for this finding. The order of these selections corresponds to the order of the dropdowns from left to right in the finding name.

sentenceid integer ID of the sentence you are updating. If you pass in an invalid ID we will simply ignore it.

sentencename string The label for this sentence

sentencenote string The note for this sentence

sentencenotelastmodifiedby string The username of the provider that last modified the note for this sentence.

sentencenotelastmodifieddatetime string The date and time that the note for this sentence was last modified.

templateid string The template ID this paragraph is associated with.

templatename string The template name this paragraph is associated with.

hpitoros string Whether ROS is as noted in HPI.

hpitoroslastmodifiedby string The username of the provider that last modified the hpitoros parameter.

hpitoroslastmodifieddatetime string The date and time that the hpitoros field was last modified.

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

hpi array This is a JSON structure containing everything you want the HPI to now contain. If you call the GET version of this call you can see some sample output. It is extremely important to note that anything you pass in will become the new HPI. Even if you only wish to make an addition, you will need to pass in the whole output of the GET plus your addition, otherwise anything you don't pass in will be removed.

hpitoros boolean Whether ROS is as noted in HPI.

replacesectionnote boolean If true, will replace the existing section note with the new one. If false, will append to the existing note.

sectionnote string The text to be updated to the history of present illness section note for this encounter.

templatedata array An array of objects, each containing the id and note for a template.

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

accountbalance string Account Balance

authorizationcharacteristics string Code that is used to track participation status of this transaction in interchange rate programs

authorizationcode string Code returned from the card issuer or authorizing institution indicating an approved authorization request

authorizationtransactiondate string MMDDYY - the date to be used for this transaction

authorizationtransactiontime string HHMMSS - Used to override system time as the time to be used for this transaction

businessdate string Used to control business date in Gateway - MMDDYY Format

cardname string Verbose card name defined in configuration

cardtype string Two character card abbreviation defined in configuration

cashbackamount string Amount of cashback the merchant provided back to the cardholder in the transaction.

cashierid string Can contain any code or name up to 8 uppercase characters to identify the person running the POS.

customercode string Merchant assigned code identifying this customer (i.e. customer Id or general ledger account number)

deviceid string Unique HPI identifier for the paired device.

devicestate object Object containing code and text

emvreceiptstring string String of EMV receipt data to be inserted between header and normal receipt data and the signature and footer lines.

expirationdate string MMYY - Represents the expiration date of the card. Required on CNP messages. Only on approved messages.

fundinginfo object Object containing the funding location information for the merchant.

gatewayapiresponsestring string The original string that is returned by Simplify (with no re-formatting performed by HPI)

hpimerchantid string Unique HPI merchant identifier used to identify the funding location of the merchant.

hpitransactionid string Unique identifier to indicate the transaction for HPI across all systems.

invoicenumber string

issuertransactionid string Unique tracking number assigned by the credit card issuing bank

itemlist array

merchantnumber string Acquiring MID for merchant

posdatacode string Delimited with ";" semi-colon between each POS DataCode value

posentrymode string ISO POS Entry Mode values

posreferencenumber string Uniquely generated number provided by the POS/integrator to identify the transaction with a batch/processing period.

response object

retrievalreferencenumber string Need to validate Fusebox returns. If not, then FB spec needs to be updated.

systemtraceauditnumber string Fusebox will generate the STAN on the merchants. behalf

taxamount string Total tax amount for the purchase.

tendertype string Determines type of tender/account used

token string Transaction Token. Required on CNP messages. Only on approved messages.

totalamount string Total amount of the transaction including tax, gratuity, etc.

transactiontype string The type of the transaction.

truncatedpan string Masked Primary Account Number, XX.s replacing all digits except for the last 4. Only on approved messages.

type string Type of the response

validationcode string Computed value assigned by the card association and used to verify data integrity between authorization and settlement

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