Patient Goal Instructions

The Patient Goal Instructions feature allows the user to add, append, or clear the patient instructions in the Assessment & Plan section of the encounter.

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

Endpoints

Update instructions against patient goals
PUT
/v1/{practiceid}/chart/encounter/{encounterid}/patientgoals/patientinstructions

Modifies the patient goal instructions in a specific encounter in the 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
patientinstructions string A free text field used for patient instructions.
replaceinstructions string If true, will replace the existing section note with the new one. If false, will append to the existing note.
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
patientinstructions string The state of the patient instructions text after the successful PUT.
versiontoken string A token specifying a unique version of data in the database.
Example Code