v1
latestOpenAPI 3.0.12026-07-2649123153.6 KB/api/v1/form-filling/session
Submit form-filling session feedback
Submits feedback on form-filling session output. You can submit feedback once per entity type per session.
post/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback
Path parameters
ambient_session_idstring required
Form-filling session ID. The path parameter is named ambient_session_id, but this value identifies the form-filling session, not an ambient clinical documentation session. Use the ID returned from Create Form filling Session, or the UUID you supplied in that request.
entitystring required
Example:AMBIENT_GENERATED_MEDICAL_FORM
Entity type you are rating. For form-filling sessions, use AMBIENT_GENERATED_MEDICAL_FORM for generated medical form output.
Headers
sdp_provider_idstring
Example:provider-123
Optional for standard partners.
Required for:
- Bearer authentication. Use the same provider_id returned by the Login or Register API.
- Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.
Request body
Example request
{
"feedback": {
"qualitative_comments": "Accurate and well-structured form output.",
"ratingFeedback": {
"min_rating": 1,
"max_rating": 5,
"rating": 5
}
},
"feedback_metadata": {
"form_id": "018f94e8-7aa8-7bfd-bc83-046262001234"
}
}Response
Resource created successfully.