Form Filling - Integration Decision Guide

Compare Form filling APIs, Form filling SDK, Web SDK Form filling, and Mobile SDK Form filling to select the right integration path

Suki for Partners provides different integration paths for adding Form filling capabilities to your application. Each integration path is designed for different product requirements, implementation approaches, and levels of UI ownership.

This guide explains the available integration options for Form filling workflows and helps you select the approach that best fits your application architecture, technology stack, and user experience goals. Use this guide to understand the tradeoffs between each integration path, including how much workflow logic, audio handling, and UI customization your team manages.

For Ambient clinical documentation and Dictation workflows, refer to the Ambient & Dictation integration decision guide. For Patient Summary workflows, refer to the Patient Summary integration decision guide.

Integration options

Form filling APIs

Form filling APIs are the most flexible integration option and allow you to build your own user interface and authentication flow for your application.

Recommended For:

• Backend systems and server integrations.
• Custom user interfaces on any stack.
• Multi-platform applications.

What You Build:

• Complete user interface.
• Authentication flow.
• Audio handling and API/WebSocket usage.

Form filling SDK

The Form filling SDK embeds hosted Form filling in your web application via iframe and JavaScript or React packages.

Recommended For:

• React or JavaScript web applications.
• Teams that want a hosted Form filling UI in the browser.
• Faster browser implementation without building the full REST and WebSocket workflow.

What's Provided:

• Hosted iframe for Form filling.
• SDK callbacks and Partner webhook delivery.
• JavaScript and React packages.

Mobile SDK Form filling (iOS)

The Mobile SDK runs a headless Form filling session on the same SukiAmbientCore stack as Ambient. You own the recorder and form review UI.

Recommended For:

• Native iOS apps that already use the Mobile SDK.
• Teams that want Form filling without a hosted iframe.
• Visits that also use Ambient on the same device (one after the other).

What's Provided:

• sessionType: .formFilling on create.
• setFormFillingContext, recording controls, and structured-data retrieve.
• Same XOR template / schema contract as Form filling APIs.

How to choose

By Project Type

Web-Based Healthcare Application

Choose Form filling SDK if:

• You want a hosted Form filling UI in a React or JavaScript web application.
• You prefer SDK callbacks and Partner webhooks over building REST and WebSocket workflow yourself.
• You need the fastest path to Form filling in the browser.

Choose Form filling APIs if:

• You need structured medical form output from visit conversation.
• You will build your own UI for template selection, recording, and form review.
• You want full control at the REST and WebSocket level in the browser.

Mobile Healthcare Application

For iOS Applications:

• Choose Mobile SDK Form filling when you already use SukiAmbientCore and want a headless Form filling session on device (sessionType: .formFilling). You own the recorder and form review UI. Refer to Form filling on Mobile SDK.
• Choose Form filling APIs when you want REST and WebSocket control from your native app or backend without the Mobile SDK Form filling APIs.

For Android Applications:

• Choose Form filling APIs - same APIs with your Android client and audio capture. Mobile SDK Form filling is iOS only.

Backend System or Server Integration

Choose Form filling APIs

• This is your primary option for server-to-server integrations.
• Provides complete control over session lifecycle, structured data, and system integration.

By Team Skills

Frontend Experience

Recommended: Form filling SDK or Form filling APIs.

Use Form filling SDK for a hosted browser UI and SDK-managed session flow. Use Form filling APIs when you build your own UI and call Form filling REST endpoints and the Partner WebSocket from your client or backend-for-frontend layer.

Backend/API Experience

Recommended: Form filling APIs.

Full control and leverages existing API development skills.

iOS/Swift Experience

Recommended: Mobile SDK Form filling or Form filling APIs.

Use Mobile SDK Form filling on iOS with SukiAmbientCore when you want headless session and recording APIs. Use Form filling APIs when you call Partner REST and WebSocket yourself.

Limited Development Resources

Recommended: Form filling SDK.

Requires minimal custom UI work with a hosted Form filling interface in the browser.

By Requirements

Your Need	Recommended Choice	Why
Quick integration in the browser	Form filling SDK	Hosted UI, SDK callbacks, and Partner webhooks
Headless Form filling on iOS	Mobile SDK Form filling	sessionType: .formFilling on SukiAmbientCore; you own recorder and review UI
Structured forms from visit conversation	Form filling APIs, Form filling SDK, or Mobile SDK	Template and schema output with generated_values / generatedValues
Custom UI/UX on web or Android	Form filling APIs	Use your stack and patterns against the API
Multi-platform support	Form filling APIs	Same APIs across web, mobile, and backend
Complete UX control (any client)	Form filling APIs	Build exactly what you need at the protocol level
In-person or telehealth form capture	Form filling SDK, Mobile SDK, or Form filling APIs	Hosted browser, headless iOS, or full API control
Template catalog and session context	Form filling APIs	List templates and bind form_template_id in context
Encounter mapping and server delivery	Form filling SDK	Pass correlation_id; receive structured results in callbacks and Partner webhooks

HIPAA Compliance: All integration methods can be implemented in a HIPAA-compliant manner. Compliance depends on your implementation practices and security measures.

Prerequisites for all integration methods

Before integrating with any Suki Platform method, you must complete the partner onboarding process:

Required for all integration methods

Partner Registration:

• Complete the Partner onboarding process.
• Receive your unique partner_id from Suki.
• Provide your JWKS endpoint URL to Suki for token validation.

Authentication System:

• OAuth 2.0 compliant authentication system.
• JWT token generation with consistent user identifier.
• Publicly accessible JWKS endpoint for token verification.

Additional requirements by method

Form filling APIs:

• WebSocket client implementation capability.
• HTTPS/TLS support for secure API communication.
• Use the Form filling ambient_session_id from Create Form filling session on Form filling REST calls and on GET /ws/stream (refer to Ambient audio streaming and Ambient streaming wire format for WebSocket wire format).

Form filling SDK:

• ES6+ compatible browsers.
• HTTPS, microphone access, and a page container with explicit height for the hosted UI.
• Medical form template IDs from Suki support for form_template_ids.
• Host URLs for your test and production apps provided to Suki for allowlisting (see Form filling SDK prerequisites).

Mobile SDK Form filling (iOS):

• Mobile SDK v2.9.0 or later with SukiAmbientCore configured.
• Microphone permission and your own recorder and form review UI.
• Medical form template IDs and/or partner schema JSON for setFormFillingContext.

Integration scenarios

Web Applications

EHR Integration

Scenario: Existing web-based Electronic Health Record system needing structured medical form capture during visits

Recommended: Form filling SDK

• Embeds hosted Form filling in your existing web application • Supports template-driven structured output for nursing and clinical workflows • SDK manages session flow; you map results to your EHR with correlation_id and Partner webhooks

Choose Form filling APIs when you need full control over recording controls, status, and form presentation.

Patient Portal

Scenario: Healthcare patient portal where providers complete intake or assessment forms during telehealth visits

Recommended: Form filling SDK

• Capture visit conversation in the browser with Suki’s hosted UI • Retrieve structured form data through SDK callbacks and Partner webhooks • Seamless integration with existing patient management systems

Custom-Branded Form Capture Experience

Scenario: Web clinician workflow where Form filling must match your design system, layout, and interaction patterns

Recommended: Form filling APIs

• Full control over recording controls, status, and form presentation • Seed and update session context with form_template_id values • Stream audio on the Partner WebSocket with your Form filling session ID

Mobile Applications

iOS Telehealth App

Scenario: Native iOS application for remote patient consultations with structured form capture during video calls

Recommended: Mobile SDK Form filling

• Headless Form filling on the same SukiAmbientCore stack as Ambient • sessionType: .formFilling, setFormFillingContext, and getFormFillingStructuredData • You own the recorder and form review UI

Choose Form filling APIs when you want REST and WebSocket control from the app or a backend without the Mobile SDK Form filling APIs.

Android Healthcare App

Scenario: Native Android application for structured form capture during clinical visits

Recommended: Form filling APIs

• Custom implementation using Form filling APIs • Full control over Android user experience • Same session and structured-data workflow as web integrations

Backend Systems

Data Processing System

Scenario: Backend orchestration of Form filling sessions, context, and structured output into internal systems or an EHR

Recommended: Form filling APIs

• Server-to-server integration capability • Complete control over data processing workflows • Integration with existing backend systems and databases

Multi-Platform Healthcare Suite

Scenario: Healthcare applications spanning web browsers, mobile devices, and backend systems

Recommended: Form filling APIs

• Single integration approach works across all platforms • Complete control over user experience on each platform • Consistent API interface regardless of client type

Next steps

Form filling on Mobile SDK - Headless Form filling on iOS with SukiAmbientCore.

Form filling SDK quickstart - Install packages, create the client, and open your first Form filling session.

Form filling API quickstart - Authentication and core Form filling API calls.

Form filling - Capabilities, use cases, and how Form filling works.

Partner onboarding - Your integration journey with Suki.

Get personalized integration guidance

If your use case doesn’t clearly match the scenarios above, or you need specific technical advice for your healthcare application, our customer success team provides personalized consultation.

Before contacting support or sales, prepare:

• Description of your healthcare application and Form filling workflows.
• Target platform (web, iOS, Android, backend system).
• Development timeline and resource constraints.
• Specific technical requirements or compliance needs.

Contact options:

• Technical consultation: Schedule a call with our integration team.
• Development support: [e-mail].
• Community discussions: Contact us for community access.