> ## Documentation Index
> Fetch the complete documentation index at: https://developer.suki.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Ambient Interoperability

> Share one clinical note across Ambient APIs, Mobile SDK, Headless Web SDK, and Web SDK using `emr_encounter_id`, `encounter_id`, and `note_id`

<div className="quick-summary-wrapper">
  <div className="quick-summary-header">
    <span className="quick-summary-icon" aria-hidden="true" />

    <span className="quick-summary-title">Quick summary</span>
  </div>

  <div className="quick-summary-content">
    Ambient interoperability allows multiple Suki ambient products to work on the same clinical note for a patient visit. To enable interoperability, provide an `emr_encounter_id` when you create the first ambient session. Suki creates a shared clinical note and associates all ambient sessions for that patient visit with that note.

    <br />

    <br />

    If you create additional ambient sessions for the same note, use the same `encounter_id`. This lets clinicians start recording in one Suki product, continue or re-ambient in another, and review or edit the same note across supported products instead of creating separate notes. To retrieve the latest version of the shared clinical note through the Ambient APIs, use the note's `note_id`.
  </div>

  <div className="quick-summary-footer">
    <span className="quick-summary-footer-icon" aria-hidden="true" />

    <span className="quick-summary-footer-text">Last updated:</span>
    <span className="quick-summary-footer-date">August 2026</span>
  </div>
</div>

<Info>
  **Supported interoperable modalities:** Ambient APIs, Mobile SDK, Headless Web SDK(coming soon), and Web SDK.
</Info>

<Warning>
  Interoperability applies only to **Ambient workflows**. It is not supported for Dictation or Form filling workflows.
</Warning>

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 using the `note_id`.

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. A session created through the Ambient APIs could only be managed through the APIs.

With <Tooltip tip="Interoperability is the ability of different systems, devices, or software applications to communicate, exchange data, and use that information seamlessly." cta="View in Glossary" href="/Glossary/i">interoperability</Tooltip>, you can now create and access ambient sessions across different Suki products for the same patient encounter.
When supported Suki products create or access ambient sessions using the same `emr_encounter_id`, the note is interoperable across those products. An `emr_encounter_id` **can contain multiple notes**. Use the same `encounter_id` for every re-ambient session on a note.

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 `note_id`.

## How interoperability works

The core of ambient interoperability is a **shared clinical note**.

When you create the first ambient session, provide **`emr_encounter_id`**. That value identifies the patient visit and makes the note interoperable. Suki creates a shared clinical note and associates ambient sessions for that visit with that note.

When you create additional ambient sessions for the same note, reuse the same **`encounter_id`**. That keeps re-ambient sessions on the same note, whether the clinician continues in the Mobile SDK, Web SDK, or Ambient APIs. Each product uses that shared value through its own fields.

The products do not share audio recordings. Each ambient session adds content to the shared clinical note. To retrieve the latest version of that note through the Ambient APIs, use the note's **`note_id`**.

```mermaid actions={false} theme={"theme":{"light":"github-dark","dark":"material-theme-darker"}}
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#FFF394','primaryTextColor':'#111827','primaryBorderColor':'#FFE148','lineColor':'#FFE148','secondaryColor':'#FFF394','tertiaryColor':'#FFFADE','mainBkg':'#FFF394','secondBkg':'#FFFADE','tertiaryBorderColor':'#FFE148','border1':'#FFE148','border2':'#FFE148','arrowheadColor':'#FFE148','fontFamily':'Inter, system-ui, sans-serif','fontSize':'14px','nodeBorder':'#FFE148','edgeLabelBackground':'#FFE148','clusterBkg':'#FFFADE','clusterBorder':'#FFE148','defaultLinkColor':'#FFE148','titleColor':'#111827','nodeTextColor':'#111827'}}}%%
flowchart LR
    A[Create Ambient session<br/>with EMR Encounter ID] --> B[Suki links sessions<br/>to a shared clinical note]
    B --> C[Ambient session 1]
    B --> D[Ambient session 2]
    B --> E[Ambient session 3]
    C --> F[Retrieve latest note<br/>with Note ID]
    D --> F
    E --> F

    style A fill:#FFF394,stroke:#FFE148,stroke-width:2px,color:#111827
    style B fill:#FFF394,stroke:#FFE148,stroke-width:2px,color:#111827
    style C fill:#FFF394,stroke:#FFE148,stroke-width:2px,color:#111827
    style D fill:#FFF394,stroke:#FFE148,stroke-width:2px,color:#111827
    style E fill:#FFF394,stroke:#FFE148,stroke-width:2px,color:#111827
    style F fill:#FFF394,stroke:#FFE148,stroke-width:2px,color:#111827
```

## Headless and Headed products

Ambient interoperability works across all Suki products that support ambient workflows.

| Product type | Products                                   | Purpose                                                                                |
| ------------ | ------------------------------------------ | -------------------------------------------------------------------------------------- |
| **Headless** | Ambient APIs, Mobile SDK, Headless Web SDK | Capture audio and integrate ambient into your own application experience               |
| **Headed**   | Web SDK                                    | Capture audio and provide the complete Suki review, editing, and submission experience |

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 an interoperable ambient session, provide `emr_encounter_id`. Provide `encounter_id` when the session will be part of a re-ambient workflow, then reuse the same value for each re-ambient session.

During the ambient workflow for the same patient visit, you need to:

<Steps>
  <Step title="Create an Ambient Session">
    Create an ambient session with `emr_encounter_id` and `encounter_id` for a re-ambient workflow.
  </Step>

  <Step title="Receive the Shared Note Identifiers">
    Suki creates a shared clinical note and returns identifiers, including the `composition_id`.
  </Step>

  <Step title="Create Additional Sessions for the Same Visit">
    Create re-ambient sessions with the same `emr_encounter_id` and `encounter_id`.
  </Step>

  <Step title="Continue Across Products">
    Continue recording, re-ambient, review, or edit from any supported Suki product that supports ambient workflows.
  </Step>

  <Step title="Retrieve the Latest Note">
    Use the returned `composition_id` as the `note_id` to retrieve the latest note content through the Ambient APIs.
  </Step>
</Steps>

<Note>
  Without **`emr_encounter_id`**, Suki still creates an ambient session, but the note is not interoperable across products.

  For re-ambient workflows, store and reuse the same **`encounter_id`** for every ambient session on that note.
</Note>

## 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`.

<CardGroup cols={2}>
  <Card title="Capture on Mobile, Review on Web" icon="mobile">
    In the Mobile SDK, use the returned `emr_encounter_id` as `SukiAmbientConstant.kEmrEncounterId`. In the Web SDK, use that value as `encounter.identifier` so the clinician can review, edit, and submit the note.
  </Card>

  <Card title="Capture on Web, Continue on Mobile" icon="arrow-right-arrow-left">
    Start ambient in the Web SDK with `encounter.identifier`, then continue or re-ambient in the Mobile SDK with the same value as `SukiAmbientConstant.kEmrEncounterId`.
  </Card>

  <Card title="Capture with APIs, Review in Web SDK" icon="code">
    Use the Ambient APIs to create the session and stream audio from your backend. Open the resulting note in the Web SDK for clinician review and submission.
  </Card>

  <Card title="Resume Later on Another Product" icon="clock-rotate-left">
    If a clinician starts ambient on one product and returns later on another, pass the same `emr_encounter_id` (and `encounter_id` for re-ambient on Mobile SDK or Ambient APIs) so they pick up the same clinical note.
  </Card>

  <Card title="Continue Documentation Across Products" icon="arrows-rotate">
    Use the returned `emr_encounter_id` through each product's corresponding field when clinicians continue documentation across products.
  </Card>

  <Card title="Keep Your Application in Sync" icon="file-pen">
    After clinicians edit the note in the Web SDK, use the `note_id` to retrieve the latest note content through the Ambient APIs.
  </Card>

  <Card title="Headless Capture, Headed Review" icon="paint-brush">
    Capture audio in your own React experience using the Headless Web SDK, then transition to the Web SDK when the clinician is ready to review and submit the note.
  </Card>

  <Card title="One Visit Identifier, Shared Notes" icon="link">
    Use `emr_encounter_id` to make notes interoperable for the patient visit. Reuse `encounter_id` for re-ambient on the same note.
  </Card>
</CardGroup>

## Design principles for interoperable ambient sessions

Interoperable ambient sessions let multiple Suki products participate in the same clinical documentation workflow. Instead of treating each Suki product 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:

* **Store the identifiers you provide.** The `emr_encounter_id` makes the note interoperable. Store and reuse `encounter_id` for every re-ambient session on that note.
* **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 returned `composition_id` as the `note_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

<CardGroup cols={2}>
  <Card title="Identifiers" icon="file-lines" href="/documentation/concepts/ambient-clinical-notes/interoperable-identifiers" cta="Learn more">
    Understand the `emr_encounter_id`, `composition_id`, `note_id`, and related identifiers used by interoperable ambient sessions.
  </Card>

  <Card title="Use Ambient Across Modalities" icon="arrows-rotate" href="/documentation/how-to/ambient-clinical-notes/use-ambient-across-modalities" cta="Learn more">
    Follow a complete workflow that creates, continues, and retrieves interoperable ambient notes.
  </Card>

  <Card title="Best Practices and FAQs" icon="circle-question" href="/documentation/how-to/ambient-clinical-notes/ambient-interoperability-faqs" cta="Learn more">
    Review implementation guidance, conflict handling, offline behavior, and frequently asked questions.
  </Card>

  <Card title="Create Ambient Session API" icon="waveform" href="/api-reference/ambient-sessions/create" cta="View API">
    See the request and response fields required for interoperable ambient sessions.
  </Card>

  <Card title="Mobile SDK Interoperability" icon="mobile" href="/mobile-sdk/ambient-guides/ambient-interoperability" cta="Learn more">
    Pass `kEmrEncounterId`, handle remote conflict and peer terminate, and read shared notes on iOS.
  </Card>
</CardGroup>