Ambient Interoperability

Ambient interoperability lets you run Ambient documentation for one patient encounter across more than one Suki modality (Mobile SDK, Headless Web SDK, and Web SDK), and keep a single shared clinical note. For example, a clinician can start recording on the Mobile SDK, continue or review in the Web SDK, and retrieve the latest note through the Ambient APIs. Before ambient interoperability, each ambient session belonged to the Suki product where it was created. For example, if you started a session using the Mobile SDK, you could only continue or retrieve that session from the Web SDK. A session created through the Ambient APIs could only be managed through the APIs. With interoperability, you can now create and access ambient sessions across different Suki products for the same patient encounter. When supported Suki products create or access an ambient session using the same emr_encounter_id, they work with a single shared clinical note for that patient encounter. This lets clinicians and you build product integrations without losing context when switching between different ambient modalities. Clinicians can:

• Start an ambient session using the Mobile SDK.
• Start a new ambient session on the Web SDK for the same clinical note.
• Open the same clinical note in the Mobile SDK to review, edit, and submit it.
• Retrieve the latest version of the note through the Ambient APIs using the emr_encounter_id.

​

How interoperability works

The core of ambient interoperability is a shared clinical note. When you create an ambient session and provide an emr_encounter_id, Suki creates a new clinical note for that patient encounter, or reuses the existing one if a note already exists for the same encounter. Every compatible ambient session created with that emr_encounter_id is linked to the same clinical note, regardless of which Suki product started the session. The products do not share audio recordings. Instead, each ambient session contributes to the same clinical note. Because every supported ambient product references the note using the same emr_encounter_id, clinicians can continue recording, re-ambient, review, edit, or retrieve the same note across different products during the patient visit.

​

Headless and Headed products

Ambient interoperability works across all Suki products that support ambient workflows. Because every product references the same note, you can combine headless and headed integrations within the same patient encounter.

​

How to implement interoperable Ambient sessions

To create interoperable ambient sessions, provide the same emr_encounter_id whenever sessions belong to the same patient visit. During the ambient workflow for the same patient visit, you need to:

​

Common integration patterns and use cases

Design your application interoperability around the clinician’s journey, not around a specific Suki product. A clinician may begin documentation on one device and finish it somewhere else during the same patient encounter. The following patterns show common ways to build interoperable ambient workflows using a shared emr_encounter_id.

​

Design principles for interoperable Ambient workflows

Interoperable ambient sessions let multiple Suki products participate in the same clinical documentation workflow. Instead of treating each SDK as an isolated system, design your application around the patient encounter and the shared clinical note. Keep the following principles in mind when building your integration:

• Use the encounter as the source of truth. Associate every ambient session for a patient visit with the same emr_encounter_id. This allows Suki to identify all sessions that belong to the same encounter.
• Choose products based on workflow, not data ownership. Mobile SDK, Headless Web SDK, Web SDK, and the Ambient APIs all provide different user experiences, but they can contribute to the same clinical note.
• Build for handoffs between products. Clinicians can begin recording on one device, continue from another, or review later in a different interface without creating separate notes.
• Always retrieve the latest composition. After additional recordings or clinician edits, use the Ambient APIs and the returned composition_id to retrieve the latest version of the shared note before writing back to your EHR or downstream systems.

Designing around these principles keeps every ambient product synchronized throughout the patient encounter while eliminating the need to merge notes or reconcile multiple versions yourself.

​

Related topics