Skip to main content
Quick summary
Ambient interoperability lets the Web SDK share one clinical note with Ambient APIs, Mobile SDK, and Headless Web SDK for the same patient visit. Pass a stable encounter identifier when you create the ambient session. That identifier maps to emr_encounter_id. Use the Web SDK to review, edit, and submit the shared note.
Last updated:July 2026
  • Interoperability applies only to ambient workflows. It is not supported for Dictation or Form filling workflows.
  • Only versions v3.2.0 and later will support Interoperability for Web SDK.
Ambient interoperability lets you use multiple Suki products that support ambient workflows with the same clinical note for a patient encounter. 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 Mobile SDK. With , you can 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. In the Web SDK, you can:
  • Open a clinical note that started on Mobile SDK, Headless Web SDK, or Ambient APIs.
  • Review, edit, and submit that shared note in the headed Web SDK UI.
  • Start an ambient session in the Web SDK and continue or re-ambient it from another ambient product.

​
How interoperability works in the Web SDK

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. In the Web SDK, the encounter identifier you supply maps to emr_encounter_id: Every compatible ambient session created with that emr_encounter_id is linked to the same clinical note, regardless of which Suki product that follows the ambient workflows started the session. The products do not share audio recordings. Instead, each ambient session contributes to the same clinical note.
If you do not provide an encounter identifier, Suki creates a normal ambient session in the Web SDK, but it remains independent and cannot participate in interoperability.

​
How to enable interoperability in the Web SDK

To create interoperable ambient sessions in the Web SDK, provide the same encounter identifier whenever sessions belong to the same patient visit.
1

Pass a Stable Encounter Identifier

Set encounter.identifier to your EMR or EHR encounter ID for the visit. Use the same value as emr_encounter_id on Ambient APIs, Mobile SDK, and Headless Web SDK.
2

Provide Patient Details

Include patient fields on encounter.patient so the Web SDK can show the patient profile. If the session started on a headless product first, seed patient context with the Seed ambient session context API before opening the Web SDK.
3

Mount or Set the Encounter

Pass the encounter through mount() or setEncounter() in JavaScript, or through the encounter prop on <SukiAssistant> in React. Refer to Create session for the full session setup.
4

Continue Across Products

To continue or re-ambient the same clinical note from another ambient product, reuse the same emr_encounter_id and encounter_id (Session Group ID). Refer to Use interoperable ambient notes.

​
Example

JavaScript

​
Common integration patterns and use cases

Design Web SDK interoperability around the clinician’s journey for a single patient encounter. Pass the same emr_encounter_id when you open ambient in the Web SDK so the note stays shared with other ambient products. The following patterns show common ways to use the Web SDK in interoperable ambient workflows:

Capture on Mobile, Review on Web

Create the ambient session from the Mobile SDK with the patient’s emr_encounter_id. Later, open the same note in the Web SDK for review, edit, and submit.

Capture with APIs, Review in Web SDK

Create the session and stream audio through Ambient APIs, then open the resulting note in the Web SDK for clinician review and submission.

Continue Documentation Across Products

Start ambient in the Web SDK, then create another ambient session for the same encounter from Mobile SDK, Headless Web SDK, or Ambient APIs using the same emr_encounter_id.

Keep Your Application in Sync

After clinicians edit the note in the Web SDK, retrieve the latest composition through the Ambient APIs so your application displays the current version.

​
Next steps

Refer to Create session to configure the encounter and start an ambient session in the Web SDK. Refer to Ambient interoperability for the platform overview across ambient products. Refer to Interoperable identifiers to understand emr_encounter_id, encounter_id, and composition_id. Refer to Use interoperable ambient notes for the end-to-end cross-modality workflow. Refer to Mobile SDK interoperability when the shared note starts or continues on iOS.
Last modified on July 24, 2026