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

# Mobile SDK Overview

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

<Callout title="Updates" color="orange" icon="bell">
  **New**

  The Mobile SDK is now <Tooltip tip="Interoperability lets different Suki ambient products contribute to the same clinical note for a patient visit. Pass a shared EMR encounter ID so clinicians can start, continue, or re-ambient across Ambient APIs, Mobile SDK, Headless Web SDK, and Web SDK." cta="Learn more" href="/documentation/concepts/ambient-clinical-notes/ambient-interoperability">interoperable</Tooltip> 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, and Web SDK.

  Refer to [Ambient interoperability](/mobile-sdk/ambient-guides/ambient-interoperability) for Mobile SDK setup.
</Callout>

Suki Mobile SDK is a headless SDK for iOS applications. It provides <Tooltip tip="Ambient documentation captures clinical conversations and generates notes automatically." cta="View in Glossary" href="/Glossary/a">ambient</Tooltip> intelligence capabilities that you can integrate directly into your native iOS app.

Use the mobile SDK to capture clinical conversations, generate notes automatically, and streamline documentation workflows.

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

* **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](/mobile-sdk/features) 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.

<CardGroup cols={2}>
  <Card title="Capture Ambient Notes on iOS" icon="mobile">
    Create an ambient session, record audio using the device microphone, and retrieve the generated clinical note when processing completes.
  </Card>

  <Card title="Record Offline" icon="wifi">
    Enable offline mode to buffer audio locally during temporary network interruptions and automatically sync recordings when connectivity is restored.
  </Card>

  <Card title="Capture Problem Context" icon="list-check">
    Pass diagnosis context with **`setSessionContext`**, then retrieve structured diagnosis data using **`getStructuredData`** after the session completes.
  </Card>

  <Card title="Capture Medication Orders" icon="pills">
    After medication orders are enabled for your organization, pass **`kOrdersInfo`** in the session context and retrieve structured medication orders when the session completes.
  </Card>

  <Card title="Continue on Another Suki Product" icon="arrows-rotate" href="/mobile-sdk/ambient-guides/ambient-interoperability">
    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.
  </Card>

  <Card title="Build a Custom iOS Experience" icon="paint-brush">
    Build your own native iOS interface while using the Mobile SDK for ambient session management, audio capture, and note generation.
  </Card>
</CardGroup>

## Guide navigation

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

| Guide                                                                                                     | Purpose                                     | Key capabilities                                                                               |
| --------------------------------------------------------------------------------------------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| **[Create session](/mobile-sdk/ambient-guides/create-session)**                                           | Session initialization and context setup    | Patient info, clinical sections, multilingual support, EMR encounter id, PBC diagnosis context |
| **[Ambient interoperability](/mobile-sdk/ambient-guides/ambient-interoperability)**                       | Shared notes across products                | `kEmrEncounterId`, remote conflict, peer terminate, note read APIs                             |
| **[Recording controls](/mobile-sdk/ambient-guides/recording)**                                            | Recording lifecycle management              | Start, pause, resume, end, cancel operations                                                   |
| **[Session status & content retrieval](/mobile-sdk/ambient-guides/session-status-and-content-retrieval)** | Content generation monitoring and retrieval | Status checking, session and note content fetching                                             |
| **[Offline mode](/mobile-sdk/ambient-guides/offline-mode)**                                               | Network resilience and offline capabilities | 15-second buffer, local storage, auto-sync                                                     |
| **[Session events & delegates](/mobile-sdk/ambient-guides/events-and-delegates)**                         | Real-time event handling                    | Delegate pattern, peer terminate, UI integration                                               |
| **[Clearing sessions](/mobile-sdk/ambient-guides/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.

```mermaid theme={"theme":{"light":"github-dark","dark":"material-theme-darker"}}
sequenceDiagram
    actor User
    participant SDK as Mobile SDK
    participant Backend as Suki Backend

    Note over User,Backend: 1. Initialize & create session
    User->>SDK: Initialize SDK
    SDK->>Backend: Create new session
    Backend-->>SDK: Session created

    Note over User,Backend: 2. Start recording
    User->>SDK: Start recording
    SDK->>Backend: Begin audio capture

    Note over User,Backend: 3. Recording controls
    User->>SDK: Pause/Resume/Stop
    SDK->>Backend: Update recording state

    Note over User,Backend: 4. Offline mode
    SDK->>SDK: Network Lost - Buffer locally
    SDK->>Backend: Network Restored - Auto-Sync

    Note over User,Backend: 5. Complete session
    User->>SDK: End session
    SDK->>Backend: Finalize recording
    Backend-->>SDK: Generate Clinical notes
    SDK-->>User: Return notes

    Note over User,Backend: 6. Cleanup
    User->>SDK: Cancel/Clear session
    SDK->>Backend: Delete session data
```

## Next steps

<Icon icon="file-lines" iconType="solid" /> To begin the integration, follow our [Installation guide](/mobile-sdk/installation).

<Icon icon="file-lines" iconType="solid" /> If you need access to the SDK, contact our [Partnership team](https://www.suki.ai/suki-partners/).

<Icon icon="file-lines" iconType="solid" /> Once you have installed the SDK, start with [Create session](/mobile-sdk/ambient-guides/create-session) to begin implementing the ambient session workflow, then follow the guides in sequence to build a complete integration.