Scribe: Capture to Finalized Note
Prepare provider access, create an in-person or Zoom Scribe session, verify transcript and artifact readiness, and finalize the note the provider reviewed.
Use this workflow with a provisioned Scribe deployment and an authorized provider. For integration testing, use an approved synthetic encounter. Confirm the supported visit type and note template, capture method, required permissions, and recording/disclosure process before capture begins.
Prepare Access and Capture
Scribe uses its own deployment base and provider-principal authentication. The provider's workspace must match the request, and access to a session is scoped to its owner. Read, session-write, and note-write scopes authorize different operations.
Choose in-person microphone capture or Zoom when creating the session. Mode cannot be changed later. Zoom requires the provider's connected account and the supported meeting/disclosure configuration. Use the assigned Scribe schema; Platform text-session endpoints are a different contract.
Create and Capture
Follow Create an In-Person Session or Create a Zoom Session. Supply a supported canonical visit type that resolves the note template, including where the generated request model marks the selection optional, and the provider's IANA timezone, which both create paths require. Record the returned session identifier.
Use the configured capture client and its supported attachment or Zoom controls. Check that recording has attached and usable transcript segments are arriving; session creation alone confirms neither.
End Capture and Inspect Artifacts
Use the capture mode's lifecycle operation. An in-person end can be refused while streaming remains attached; a Zoom end acknowledgement can precede transcript finalization. Read the resulting session and artifact state separately.
Wait for the note's generation_status to reach ready before displaying it for review. Continue checking while it is pending, and handle failed and empty results explicitly. The provider then reviews the transcript, note, checklist, and coding suggestions; generated content and confidence values do not substitute for that review.
Finalize the Reviewed Version
Read the current note and retain its version. If the provider edits it, save the complete structured document and retain the returned version. The provider reviews that version, then the client submits its base_version to Finalize a Note. If another edit produces a version conflict, reload and have the provider review the new version before submitting again.
Read back the submitted note and session outcome. When EHR writeback is enabled for the workspace, finalization also writes the note to the EHR: check writeback_status, and treat ehr_writeback_failed as a rolled-back finalize, so the note stays a draft. See Finalize a Note. If a separate integration sends the note to another clinical system, verify receipt there as well.
Verify Failure and Cleanup
In the approved test deployment, verify the documented stale-version conflict using a mutable test note and an older version. Confirm that the current note remains intact, reload it, and complete the intended review path. Cancel an unfinished test session using the supported lifecycle; finalization and cancellation are not general data-deletion operations. Follow the agreed retention and test-data cleanup process.
Keep the session identifier, capture mode, artifact outcome, reviewed version, finalization result, and correlation identifiers. Use the Scribe HTTP reference for exact request and response contracts.
Last updated
Was this helpful?