Skip to main content
Quick summary
The iOS Mobile SDK (SukiAmbientCore) also supports running a Form filling session, apart from an Ambient note session. Pass sessionType: .formFilling on createSession, set forms with setFormFillingContext, record as usual, end the session, then call getFormFillingStructuredData(for:) with recordingId. You are responsible for building the form review UI as the SDK is headless and does not render forms.
Last updated:September 2026
Form filling lets you fill medical forms from the patient visit conversation. You can use Suki defined medical form templates, your own form schema, or a mix of both. Your application can then review, edit, and save the structured form data. The Mobile SDK (SukiAmbientCore) now supports Form filling sessions in your iOS app. Installation, initialization, Partner Token setup, microphone permissions, and the start, pause, resume, and cancel methods work the same way as they do for Ambient. The main differences are how you create a session, provide form context, end the session, and retrieve the results. You are responsible for building the recorder and form review UI. The SDK manages the Form filling session, audio capture, and structured form output. It does not render forms.
Form filling on Mobile SDK requires Mobile SDK v2.9.0 or later (iOS).

โ€‹
Prerequisites

Before you begin:
  • Install and configure the Mobile SDK. Refer to Installation and Configuration.
  • Initialize the SDK and provide a Partner Token the same way you do for Ambient.
  • Request microphone permission before you call start.
  • Decide which forms to fill: Suki Medical form templates (ask Suki support for template IDs), your own form schema, or both. Refer to Form filling templates and Dynamic Form filling.
  • Have an appointment or encounter id ready if you want to pass kCorrelationId.

โ€‹
Common use cases

Below are common ways to use Form filling in an iOS app with the Mobile SDK.

Fill Suki Medical Form Templates

Record the visit on device and fill Suki Medical form templates, such as a nursing assessment, then review the filled fields in your app.

Fill Hospital-Specific Forms

Fill your own hospital or partner medical forms from the visit conversation, then review and save the structured data in your workflow.

Use Templates and Custom Forms Together

In one visit, fill both Suki Medical form templates and your own partner forms, then review all results in your form UI.

Review Forms in Your Own App

Keep your native recorder and form review experience. Use the SDK for the session, audio, and structured form output only.

Run Ambient and Form Filling Sequentially

For the same appointment, run Ambient and Form filling one after the other in either order. They cannot run at the same time.

Collect Feedback on Filled Forms

After a clinician reviews the filled forms, collect a rating and optional comments so you can track form quality.

โ€‹
Ambient vs Form filling

The following table compares Ambient and Form filling on the Mobile SDK and how they differ.
One appointment can run Ambient and Form filling one after the other. They cannot run at the same time on a device or on another Suki product for the same encounter.
If another session is already in progress, create returns remoteSessionConflict(blockingSessionId:). Resolve with cancelRemoteAmbientSession or endSessionRemotely, then retry. For more information, refer to Ambient interoperability and Create Form filling session.
Ambient interoperability with kEmrEncounterId applies only to Ambient note workflows. It is not supported for Form filling. Passing emrEncounterId does not make Form filling share an Ambient note.

โ€‹
Form filling workflow

The diagram below shows the Form filling session workflow. It follows the same pattern as an Ambient note session, except the create, form context, end, and retrieve steps are Form filling specific. Follow these guides in order to implement Form filling on Mobile SDK.

Create Form Filling Session

Pass sessionType: .formFilling, optional kCorrelationId, and store recordingId from the create response.

Set Context and Retrieve Results

Set templates or partner schemas, record and end the session, retrieve structured data, and submit optional feedback.

โ€‹
Next steps

Start with Create Form filling session. Then continue to Set context and retrieve results. Refer to Form filling templates for Suki catalogue form_template_id values. Refer to Dynamic Form filling for XOR rules and partner schemas. Refer to Recording controls for start, pause, and resume.
Last modified on September 29, 2026