Mobile SDK Introduction

A collection of iOS libraries to build native iOS applications on top of Suki Ambient intelligence capabilities

New

The Mobile SDK is now interoperable with other Suki products that support Ambient workflows. Pass SukiAmbientConstant.kEmrEncounterId on createSession so clinicians can continue the same clinical note across Ambient APIs, Mobile SDK, Headless Web SDK, and Web SDK.

Refer to Ambient interoperability for Mobile SDK setup.

The Suki Mobile SDK is a headless Swift library that lets you add ambient documentation and Form filling to your native iOS application. You build the UI, while the SDK manages sessions, audio capture, note generation, and structured form output.

Use the Mobile SDK to capture patient encounters, generate clinical notes, fill medical forms, support offline recording, and continue Ambient notes across supported Suki products.

Mobile SDK capabilities

With just a few lines of code, you can use the SDK to:

• Capture Conversations: Enable hands-free, real-time ambient transcription of clinical conversations.

• Generate Notes: Automatically transform conversations into structured clinical documentation using Suki’s AI.

• Form filling: Fill medical forms from the visit conversation. You build the form review UI.

• Problem-Based Charting (PBC): Support problem-oriented notes and structured diagnoses by passing diagnosis context in setSessionContext and reading structured output when the session completes.

• Manage Sessions: Handle the entire session lifecycle seamlessly within your application.

• Ensure Security: All data processing is handled with HIPAA-grade privacy and security.

• Ambient interoperability: Support interoperability with other Suki products that use ambient workflows.

Refer to the Mobile SDK capabilities page for more details on the capabilities of the Mobile SDK.

Common integration patterns and use cases

The Mobile SDK provides the APIs to create ambient sessions, capture audio, support offline recording, and retrieve generated notes. Your application owns the iOS user experience, workflow, and how clinicians review or continue documentation across Suki products.

The following examples show common ways to integrate the Mobile SDK into your iOS application.

Capture Ambient Notes on iOS

Create an ambient session, record audio using the device microphone, and retrieve the generated clinical note when processing completes.

Fill Medical Forms on iOS

Create a Form filling session, set templates or partner schemas, record the visit, and retrieve structured form data for your form review UI.

Record Offline

Enable offline mode to buffer audio locally during temporary network interruptions and automatically sync recordings when connectivity is restored.

Capture Problem Context

Pass diagnosis context with setSessionContext, then retrieve structured diagnosis data using getStructuredData after the session completes.

Capture Medication Orders

After medication orders are enabled for your organization, retrieve structured medication orders from the ambient visit with getStructuredData. Optionally pass kOrdersInfo when your workflow needs medication order context.

Continue on Another Suki Product

Create the ambient session with SukiAmbientConstant.kEmrEncounterId, then continue the same note in another Suki product, such as the Web SDK, for review, editing, or submission.

Build a Custom iOS Experience

Build your own native iOS interface while using the Mobile SDK for ambient session management, audio capture, and note generation.

Guide navigation

To get started with the Mobile SDK, you can follow the guides in the following order:

Guide	Purpose	Key capabilities
Create session	Ambient session initialization	Patient info, clinical sections, multilingual support, EMR encounter id, PBC diagnosis context
Form filling	Form filling sessions on iOS	Overview, create session, context and results
Ambient interoperability	Shared notes across products	kEmrEncounterId, remote conflict, peer terminate, getEncounterInfo, note read APIs
Recording controls	Recording lifecycle management	Start, pause, resume, end, cancel operations
Session status & content retrieval	Ambient content generation and retrieval	Check status and retrieve content, Shared notes across products, Submit user feedback
Offline mode	Network resilience and offline capabilities	15-second buffer, local storage, auto-sync
Session events & delegates	Real-time event handling	Delegate pattern, peer terminate, UI integration
Clearing sessions	Session cleanup and data privacy	User logout, data clearing, memory management

Mobile SDK workflow

The diagram below shows the complete ambient session workflow and how you can use the Mobile SDK to manage the session lifecycle.

Next steps

Installation guide

Partnership team

Create session - Begin implementing the ambient session workflow, then follow the guides in sequence to build a complete integration.