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

# Form Filling Workflows - Integration Decision Guide

> Compare Form Filling APIs to select the right integration method for Form filling workflows in your healthcare application

Suki for Partners provides different integration paths for adding Form filling capabilities to your application.
Currently we offer the Form Filling APIs integration path which is designed for custom 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](/documentation/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.

<CardGroup cols={2}>
  <Card title="Recommended for:" icon="server">
    • Backend systems and server integrations\
    • Custom user interfaces on any stack\
    • Multi-platform applications
  </Card>

  <Card title="What you build:" icon="gear">
    • Complete user interface\
    • Authentication flow\
    • Audio handling and API/WebSocket usage
  </Card>
</CardGroup>

## How to choose

<Tabs>
  <Tab title="By Project Type">
    <AccordionGroup>
      <Accordion title="Web-based Healthcare Application">
        **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
      </Accordion>

      <Accordion title="Mobile Healthcare Application">
        **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
      </Accordion>

      <Accordion title="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
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="By Team Skills">
    <CardGroup cols={2}>
      <Card title="Frontend Experience">
        **Recommended: Form Filling APIs**

        Build your web or mobile UI and call Form filling REST endpoints and the Partner WebSocket from your client or backend-for-frontend layer.
      </Card>

      <Card title="Backend/API Experience">
        **Recommended: Form Filling APIs**

        Full control and leverages existing API development skills
      </Card>

      <Card title="iOS/Swift Experience">
        **Recommended: Form Filling APIs**

        Native iOS integration against the same Partner APIs with your own UI and device audio handling
      </Card>

      <Card title="Limited Development Resources">
        **Recommended: Form Filling APIs**

        A single API path across platforms; scope UI to the minimum workflow your product needs for template capture and review
      </Card>
    </CardGroup>
  </Tab>

  <Tab title="By Requirements">
    | Your Need                                    | Recommended Choice | Why                                                                              |
    | -------------------------------------------- | ------------------ | -------------------------------------------------------------------------------- |
    | **Structured forms from visit conversation** | Form Filling APIs  | Template-driven output with **generated\_values** and **non\_generated\_values** |
    | **Custom UI/UX on web or mobile**            | Form Filling APIs  | Use your stack and patterns against the API                                      |
    | **Multi-platform support**                   | Form Filling APIs  | Same API surface 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 APIs  | One session workflow; you own the capture experience                             |
    | **Template catalog and session context**     | Form Filling APIs  | List templates and bind **form\_template\_id** in context                        |
  </Tab>
</Tabs>

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

## 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](/documentation/partner-onboarding)
* 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](/form-filling-api-reference/form-filling-sessions/create) on Form filling REST calls and on **GET /ws/stream** (refer to [Ambient audio streaming](/documentation/ambient-audio-streaming) for WebSocket wire format)

## Integration scenarios

<Tabs>
  <Tab title="Web Applications">
    <AccordionGroup>
      <Accordion title="EHR Integration">
        **Scenario:** Existing web-based Electronic Health Record system needing structured medical form capture during visits

        **Recommended: Form Filling APIs**

        • Integrates into your existing web application\
        • Supports template selection and structured form output for nursing and clinical workflows\
        • You manage session lifecycle, audio streaming, and save logic in your EHR
      </Accordion>

      <Accordion title="Patient Portal">
        **Scenario:** Healthcare patient portal where providers complete intake or assessment forms during telehealth visits

        **Recommended: Form Filling APIs**

        • Capture visit conversation in the browser\
        • Retrieve structured form data when processing completes\
        • Seamless integration with existing patient management systems
      </Accordion>

      <Accordion title="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
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Mobile Applications">
    <AccordionGroup>
      <Accordion title="iOS Telehealth App">
        **Scenario:** Native iOS application for remote patient consultations with structured form capture during video calls

        **Recommended: Form Filling APIs**

        • Native iOS performance and device integration\
        • Works with your existing iOS app architecture\
        • You implement REST, WebSocket, and form review UI in your app
      </Accordion>

      <Accordion title="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
      </Accordion>
    </AccordionGroup>
  </Tab>

  <Tab title="Backend Systems">
    <AccordionGroup>
      <Accordion title="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
      </Accordion>

      <Accordion title="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
      </Accordion>
    </AccordionGroup>
  </Tab>
</Tabs>

## Next steps

To begin your integration, review the documentation for your chosen approach:

<CardGroup cols={2}>
  <Card title="Form Filling Basic Usage" href="/documentation/form-filling-basic-usage" arrow={true} icon="list">
    Step-by-step Partner API workflow for Form filling
  </Card>

  <Card title="Form Filling API Overview" href="/form-filling-api-reference/overview" arrow={true} icon="list">
    Build custom Form filling integrations with maximum flexibility
  </Card>

  <Card title="Form Filling API Quickstart" href="/form-filling-api-reference/quickstart" arrow={true} icon="list">
    Get started with authentication and core API calls
  </Card>

  <Card title="Form Filling" href="/documentation/form-filling" arrow={true} icon="list">
    Capabilities, use cases, and how Form filling works
  </Card>

  <Card title="Partner Onboarding" href="/documentation/partner-onboarding" arrow={true} icon="list">
    Start your integration journey with Suki
  </Card>
</CardGroup>

## 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](https://www.suki.ai/suki-partners/)
* **Development support**: [support@suki.ai](mailto:support@suki.ai)
* **Community discussions**: [Contact us for community access](https://www.suki.ai/contact-us/)