Quick summary
An ambient session captures patient-provider conversations and generates clinical notes in real-time. The SDK handles recording, note generation, and error handling automatically.
Manage sessions in two ways: uncontrolled mode where users interact only with SDK UI controls, or controlled mode where your EHR system controls when sessions start and stop through external triggers.
Manage sessions in two ways: uncontrolled mode where users interact only with SDK UI controls, or controlled mode where your EHR system controls when sessions start and stop through external triggers.
Overview
An ambient session captures patient-provider conversations and generates clinical notes in real-time. The SDK handles recording, note generation, and error handling automatically. To generate notes, you must configure sections that organize the content. Use either predefined note types or LOINC codes. The SDK creates notes from the conversation using these configured sections.LOINC code support is available in version 2.0 and above. See the note sections documentation for supported codes. For older versions, contact support to configure note types.
Session management in Web SDK
Manage ambient sessions in the Web SDK in two ways:Uncontrolled Mode
Users interact only with SDK UI controls. The SDK manages the session lifecycle automatically.
Controlled Mode
Your EHR system controls the session lifecycle (start, stop, resume) through external triggers. The SDK handles recording and note generation while your app controls when sessions start and stop.
Ambient guides
Implementation
Controlled session management and updating encounter or ambient options.
Session Status
Lifecycle events and status flags for ambient sessions.
Problem-Based Charting
Enable PBC and pass existing patient diagnoses.
Multilingual Support
Use multiple languages in ambient sessions.
Offline Mode
How sessions behave during network interruptions.
Re-Ambient & Recovery
Continue existing notes and recover abandoned sessions.