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

​

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 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:

​

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 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