Skip to main content
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 workflows 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

​
How to choose

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
For iOS Applications:
  • Choose Form filling APIs - implement REST and WebSocket in your native app or through your backend
For Android Applications:
  • Choose Form filling APIs - same API surface with your Android client and audio capture
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
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 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)

​
Integration scenarios

Scenario: Existing web-based Electronic Health Record system needing structured medical form capture during visitsRecommended: 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 webhooksChoose Form filling APIs when you need full control over recording controls, status, and form presentation.
Scenario: Healthcare patient portal where providers complete intake or assessment forms during telehealth visitsRecommended: 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
Scenario: Web clinician workflow where Form filling must match your design system, layout, and interaction patternsRecommended: 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

​
Next steps

To begin your integration, review the documentation for your chosen approach: Form filling SDK quickstart - Install packages, create the client, and open your first Form filling session. Form filling SDK overview - Hosted UI, packages, session workflow, and when to use the SDK. Form filling basic usage - Step-by-step Partner API workflow for Form filling. Form filling API overview - Build custom Form filling integrations with maximum flexibility. Form filling API quickstart - Get started with authentication and core API calls. Form filling - Capabilities, use cases, and how Form filling works. Partner onboarding - Start 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:
Last modified on July 24, 2026