Skip to main content
Quick summary
Ambient interoperability lets clinicians continue the same clinical note between the Mobile SDK, Web SDK, and Ambient APIs. Each product uses its own fields for the shared encounter values. In the Mobile SDK, use SukiAmbientConstant.kEmrEncounterId and, for re-ambient workflows, SukiAmbientConstant.kSessionId.
  • Interoperability applies only to Ambient workflows. It is not supported for Dictation or Form filling.
  • Only versions v2.7.0 and later support interoperability for the Mobile 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 Ambient APIs, Mobile SDK, and Web SDK for the same patient encounter. The EMR encounter identifier makes the note interoperable. For re-ambient workflows, pass SukiAmbientConstant.kSessionId (maps to Ambient API encounter_id) and reuse it for every session on that note. In the Mobile SDK, you can:
  • Start an interoperable ambient session by passing SukiAmbientConstant.kEmrEncounterId.
  • Continue in the Mobile SDK a clinical note that started in the Web SDK or Ambient APIs.
  • Continue in the Web SDK or Ambient APIs a clinical note that started in the Mobile SDK.
  • Clear a blocking session on another Suki product, then retry create.
  • React when another Suki product cancels or ends the live session.
  • List and read shared notes for an EMR encounter.

How Ambient interoperability works in the Mobile SDK

When you call createSession, pass SukiAmbientConstant.kEmrEncounterId to identify the patient’s EMR or EHR encounter and make the note interoperable. For re-ambient workflows, pass SukiAmbientConstant.kSessionId (maps to Ambient API encounter_id) and reuse the same value for every session on that note. The table below shows how Mobile SDK identifiers map to the corresponding Ambient API fields.
Keep these identifiers separate:
  • Create response sessionId: Maps to Ambient API ambient_session_id. Use it for recording and session-level APIs. It is not the encounter_id you pass as kSessionId.
  • kSessionId / encounter_id: Required for re-ambient workflows. Reuse the same value for every session on the note and as encounterId for encounterContent.
  • compositionId: The note id. Use it for note-level read APIs. It is not encounter_id.
Ambient interoperability shares the clinical note, not the audio recording. Each ambient session adds content to the same note. The audio for each session stays tied to that session’s sessionId.
If you omit SukiAmbientConstant.kEmrEncounterId on createSession, the Mobile SDK still creates an ambient session, but the clinical note is not shared with other Suki products.

Common integration patterns

Below are some common integration patterns for ambient interoperability that you can use as a reference for your implementation while building your ambient workflows using the Mobile SDK.

Capture on Mobile, Review on Web

Start the clinical note in the Mobile SDK, then open it in the Web SDK for review, edit, and submission. Use the shared encounter value through each product’s corresponding field.

Capture on Web, Continue on Mobile

Start the clinical note in the Web SDK, then continue it in the Mobile SDK. Use the shared encounter value through each product’s corresponding field.

Capture on Mobile, Continue with APIs

Start the clinical note in the Mobile SDK, then continue or retrieve it through Ambient APIs. Use the shared encounter values through each product’s corresponding fields.

Capture with APIs, Continue on Mobile

Start the clinical note through Ambient APIs, then continue it in the Mobile SDK. Use the shared encounter values through each product’s corresponding fields.

Resolve a Cross-Device Conflict

On remoteSessionConflict, cancel or end the blocking session with blockingSessionId, then retry create.

Keep the UI in Sync on Peer End

Handle sessionTerminatedByPeer to clear recording UI when another product ends the live session.

List Notes for the Visit

Call listEncounterNotes with the EMR encounter id, then call getNoteContent(noteId:) (or context / structured data) with compositionId as noteId.

How to enable interoperability in the Mobile SDK

Pass a stable EMR encounter UUID to make the note interoperable. For re-ambient workflows, pass SukiAmbientConstant.kSessionId (Ambient API encounter_id) and reuse the same value for every session on that note.
1

Pass the EMR Encounter ID

Set SukiAmbientConstant.kEmrEncounterId to the emr_encounter_id returned by the Ambient API.
2

Pass encounter_id

Set SukiAmbientConstant.kSessionId to the Ambient API encounter_id on the first session in a re-ambient workflow. Store and reuse the same value for every session on that note and for encounterContent. Do not use compositionId as this value.
3

Store the Create Response

On success, store sessionId and compositionId when present. Use sessionId for recording controls and session-level content APIs. Use compositionId as noteId for note-level read APIs.
4

Continue Across Products

Use the shared encounter values through the target product’s corresponding fields. In the Mobile SDK, continue using SukiAmbientConstant.kEmrEncounterId and SukiAmbientConstant.kSessionId. For more information, see Use ambient across modalities.

Code example for creating an interoperable session

Use the following code example to create an interoperable ambient session in the Mobile SDK.
Swift

How to handle a remote session conflict

A createSession request fails with SukiAmbientCoreError.remoteSessionConflict(blockingSessionId:) when another Suki product already has an active ambient session for the same provider and EMR encounter. To create a new session:
  1. Read the blockingSessionId from the error. This value identifies the active ambient session and maps to ambient_session_id.
  2. Clear the blocking session by calling one of the following APIs with the blockingSessionId:.
    • cancelRemoteAmbientSession(ambientSessionId:onCompletion:) to cancel the remote session and discard it.
    • endSessionRemotely(sessionId:onCompletion:) to end the remote session so any audio already captured can be processed.
  3. After the remote API call succeeds, retry createSession using the same SukiAmbientConstant.kEmrEncounterId.
The SDK does not require a delay between the successful remote operation and retrying createSession.
remoteSessionConflict only applies when create runs online. If the first ambient session is fully offline, another Suki product can still start a session for the same EMR encounter, and you may not receive a conflict error.

Code example for handling a remote session conflict

Use the following code example to handle a remote session conflict in the Mobile SDK.
Swift
  • remoteSessionConflict is a server-side interoperability conflict. It can occur when you pass an EMR encounter id and another Suki product already holds the active ambient session.
  • sessionInProgress is a local conflict only. An ambient session is already active on the current device. End or cancel that session locally before calling createSession again. An EMR encounter id is not required for this case.
  • Use cancelRemoteAmbientSession when you want to discard the blocking session. Use endSessionRemotely when you want the blocking session to end and process any audio already captured.

What happens when a peer terminates the live session

If another Suki product cancels or ends the ambient session that is currently live in your app, the SDK tears down the session locally before it notifies your app. The SDK:
  • Stops the microphone.
  • Deletes local audio for the session.
  • Closes the stream.
  • Clears the local session state.
Then it delivers SessionEvent.sessionTerminatedByPeer(reason:) with .cancelled or .ended. Update your UI only. Do not call local end(), cancel(), or clear(). Teardown is already complete. Do not call cancelRemoteAmbientSession or endSessionRemotely for this direction.

Code example for handling a peer end event

Use the following code example to handle a peer end event in the Mobile SDK.
Swift
For more information, see Session events and delegates.

How to read shared notes

To list or retrieve clinical notes shared across Suki products, use the note read APIs. Depending on the API, pass one of the following:
  • An EMR encounter id.
  • A compositionId as the noteId.
  • The Ambient API encounter_id (the same value you pass as kSessionId) as encounterId for encounterContent.
All of these APIs are asynchronous, and their completion handlers are invoked on the main queue. Errors are returned as generic or gRPC errors, not SukiStatus. These APIs use the same token provider configured for the ambient session APIs.
For encounterContent, pass the Ambient API encounter_id (the same value you pass as kSessionId). Do not pass the EMR encounter id.

Code example for reading shared notes

Use the following code example to read shared notes in the Mobile SDK.
Swift
status(for:), content(for:), transcript(for:), and getStructuredData(for:) still take sessionId and return status or content for a single ambient session. Use the note read APIs above when you list or retrieve clinical notes shared across Suki products. For full method details and signatures, see Session status and content retrieval.

Create errors that do not fall back to offline

These create failures return SukiStatus and do not create an offline session: Other create failures can still follow the existing offline workflow. For more information, see Offline mode.

Available cookbooks

AmbientAPI

Share One Note Across Products

Share one note with emr_encounter_id.

5 min
AmbientWeb SDK

Seed Patient Context for the Web SDK

Seed patient context for Web SDK.

5 min

Next steps

Refer to Create ambient session for session info parameters and create response fields. Refer to Ambient interoperability for the platform overview across ambient products. Refer to Interoperable identifiers for emr_encounter_id, encounter_id, and composition_id. Refer to Use interoperable ambient notes for the end-to-end cross-modality workflow. Refer to Web SDK interoperability when the shared note opens in the headed Web SDK. Refer to Seed patient context for Web SDK if a Mobile or API session will open later in the headed Web SDK.
Last modified on August 13, 2026