Patient Goals

The Patient Goals feature allows the user to view a list of goals set for the patient in the 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

GET

Get list of patient
goals

Get list of patient goals

GET

/v1/{practiceid}/chart/encounter/{encounterid}/patientgoals

Retrieves the list of patient goals 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

Output Parameters

Expand all

auditinformation object Lastmodified timestamps and usernames of data in the database

discussionnotes object Lastmodified timestamps and usernames of the discussion notes

freetextgoal object Lastmodified timestamps and usernames of the freetext goal

patientinstructions object Lastmodified timestamps and usernames of the patient instructions

discussionnotes string Further discussion notes about these patient goals.

freetextgoal string Unstructured goal. More of a note field.

goals array List of goals for the patient resulting from this encounter.

compoundvalues array Some goals have target values that include multiple parts. This output provides additional data that adds to or replaces the target value.

duration string Expected time frame for reaching goal. This will not be returned if the goal has been met.

goaltype string Clinical goal type. Usually a VITALS or a LABANALYTE.

isprimarygoal string Indicates primary goal. Value would be true if the goal is primary else false.

name string Display name of goal.

status string Status of goal. Null means not yet met. If met will have a value of MET.

targetvalue string Goal target value.

patientinstructions string Instructions to the patient about achieving these goals.

topicsofdiscussion array Topics of Discussion. This API attribute is being rolled out and will be Generally Available on or before July 1, 2022.

clinicalencounternotetopicid integer Clinical Encounter Note Topic ID.

declined string True / False for if the topic is declined.

declinedreason string Reason the topic is declined.

declinedreasonid integer ID for the reason the topic is declined.

encounterid integer Encounter ID.

lastmodifiedby string The username of the user who last updated the topic.

lastmodifieddatetime string The date and time the topic was last modified.

sectionid integer ID for the encounter section to which the topic is linked.

sectionname string Name for the encounter section to which the topic is linked.

topicid integer Topic ID.

topicname string Human readable description of topic.

versiontoken string The version token for the topic.

versiontokens object Tokens specifying a unique version of data in the database.

Example Code