content entity per ambient session. Show the control after an ambient session is completed.- Rate the note while the visit is still fresh.
- Leave a short comment when something was wrong or especially good.
- Finish review without a second, confusing feedback screen later.
- A rating control on the note review screen (Suki suggests a 1 to 5 scale).
- An optional comment field (max 2000 characters). Do not prompt for PII or PHI unless it is required to understand the feedback.
- A way to skip feedback and continue to approve / save.
- One submit for the
contententity per ambient session.
Why collect feedback
Feedback gives Suki information about how clinicians assess generated ambient content. Ratings and comments are reviewed and used to help improve AI-generated clinical content over time.Decide before you build
When Does Feedback Appear
When Does Feedback Appear
completed and the generated note is visible. That is when the clinician can judge the note and provide feedback.The API does not reject feedback sent earlier, but there is nothing useful to rate until the note is ready. Do not request feedback while the session is Generating, or after skipped / failed.What Scale You Use
What Scale You Use
min_rating and max_rating in the Feedback API request. The range is inclusive.Suki suggests 1 to 5:How Often You Submit
How Often You Submit
content.After a successful submit, disable or hide the feedback control for that entity. A second submission for the same entity type is not valid.What Belongs in Comments
What Belongs in Comments
qualitative_comments. Do not send patient identifiers or other PHI unless that detail is required for the feedback to be understood. Comments improve the product and model. They are not a second clinical note.How feedback fits into the visit
Collect feedback after the generated note is available and the clinician has had a chance to review it. Feedback is independent of chart save. The clinician can approve or save without submitting feedback.Recommended UI patterns
Place feedback on the same screen where the clinician reviews the generated note. Keep the experience to a few seconds.Show the Generated Note
completed. Let the clinician read or edit first.Show a Compact Rating Control
Keep Comments Optional
Submit Once, Then Confirm
content. Show a brief thank-you, disable or hide the control, and leave them on review so they can approve or save.Should Feedback Be Required before Approve
Should Feedback Be Required before Approve
Where Should the Feedback Control Appear
Where Should the Feedback Control Appear
Can a Clinician Submit Only a Rating
Can a Clinician Submit Only a Rating
qualitative_comments, or leave it empty when your client allows.What If Feedback Submission Fails
What If Feedback Submission Fails
How to implement feedback
Wait for the Note to Be Ready
completed, load content with Get the generated clinical note.Show Rating and Optional Comment
Submit Once for Content
content for that ambient session ID. Do not submit the same entity type twice.Continue the Note Workflow
Example code samples
- TypeScript
- Python
Handle feedback failures
Feedback must not block clinical documentation.Keep the Note Visible
Keep Approve or Save Available
Offer a Quiet Retry
- Show feedback after
completedand note is visible. - Provide a rating control (1 to 5 unless you need another supported range).
- Keep comments optional (max 2000). Do not send patient identifiers unless the comment needs them.
- Submit
contentonce. - Allow skip.
- Never block Approve / Save on feedback failure.
- Never show feedback for
skippedorfailed.