Assessment

The Assessment feature allows the provider to document the assessment (diagnosis) for the encounter, and to create a plan (orders) for the patient. This is considered as a note field. Note: HTML format is allowed.

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

Endpoints

Get assessment for given encounter

GET
/v1/{practiceid}/chart/encounter/{encounterid}/assessment
Retrieves the Assessment /Plan note by the provider 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
showstructured boolean If true, returns assessment note templates as structured data. If false, returns it via lightly-HTML marked up English text, as displayed in the athenanet encounter summary.

Output Parameters

Expand all
assessmenttext string The text of the Assessment / Plan section. Not all practices use this. Some use it extensively with HTML templates.
lastmodifiedby string The username of the user who last updated this text.
lastmodifieddatetime string The datetime that this text was last updated.
Example Code

Update assessment for given encounter

PUT
/v1/{practiceid}/chart/encounter/{encounterid}/assessment
Modifies the Assessment /Plan note 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
Content-Type string Content type of the payload

❙ Request Body

Expand all
assessmenttext string The text to be updated to the assessment note.
replacetext boolean If true, will replace the existing assessment text with the new one. If false, will append to the existing text.

Output Parameters

Expand all
assessmenttext string The text of the Assessment / Plan section after the successful PUT.
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code