Patient Goal Free Text

The Patient Goal Free Text feature allows the user to add or modify patient goals in Assessment & Plan section of the encounter.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Endpoints

Update patient's free text goal against patient goals
PUT
/v1/{practiceid}/chart/encounter/{encounterid}/patientgoals/freetextgoal

Modifies discussion notes of the patient goal for a specific encounter in Assessment and Plan section

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
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
freetextgoal string A free text field used for unstructured goals.
replacefreetextgoal string If true, will replace the existing free text goal with the new one. If false, will append to the existing free text goal.
versiontoken string A token specifying a unique version of data in the database. If it's specified and does not match the version token on the server, the update will fail.

Output Parameters

Expand all
freetextgoal string The state of the free text unstructured goals after the successful PUT.
versiontoken string A token specifying a unique version of data in the database.
Example Code