Quick summary
Form filling converts visit conversation into structured medical form output using Suki templates. Instead of typing values into forms during or after a visit, providers can speak naturally while Suki maps the conversation into template fields your application can review, edit, and save.
- An encounter is the patient visit. A Form filling session is one capture instance for that visit. One encounter can include one or more Form filling sessions. Do not reuse an Ambient clinical note session ID for Form filling sessions.
- Form filling is template-driven structured output. It is not ambient note generation. Use it for nursing workflows, intake and assessments, medication reviews, and other form-based documentation where you need field values, not a full clinical note.
- Complete structured medical forms through natural conversation during the visit.
- Review generated field values while the visit context is still fresh.
- Edit, validate, or manually complete fields before saving.
- Approve or submit form data into the EHR or downstream workflow.
- Select the Medical form templates in scope for the patient encounter.
- Create a Form filling session for that encounter, then capture the patient-provider or patient-nurse conversation with Form filling APIs, Web SDK, or Form filling SDK modalities.
- Receive structured form output for the selected templates.
- Let the provider or nurse review, edit, and save the form data in your application.
Choose your path to build Form filling workflows
Suki provides three integration options for Form filling workflows. Pick the one that matches how much UI and session control you want Suki to own, and how much you want to own, then open the matching quickstart to get started.Form Filling APIs
If you need: full control over session lifecycle, audio streaming, review UI, and EHR handoff.Your application owns create session, template context, WebSocket audio, status checks, structured data retrieval, and save logic.
Web SDK
If you need: Form filling inside an app that already uses
@suki-sdk/js or @suki-sdk/react.From Web SDK v3.2.0 or later, import the Form filling client and components from the Web SDK package. You do not need a standalone Form filling SDK install.Form Filling SDK
If you need: a hosted browser UI for Form filling without the rest of the Web SDK.Suki provides the Form filling experience. Your application opens the SDK, passes encounter context and templates, then handles submitted structured results in callbacks or webhooks.
Web SDK and Form filling SDK both embed Suki’s hosted Form filling UI. Use the Web SDK path when you already use
@suki-sdk/js or @suki-sdk/react. Use the standalone packages (@suki-sdk/form-filling or @suki-sdk/form-filling-react) when you want Form filling without the rest of the Web SDK. Refer to Form filling SDK installation for setup details.Verify your first Form filling workflow
Before you design the full production workflow, confirm that your staging integration can complete the Form filling path for the product you chose:- Authenticate successfully for your chosen product.
- Start Form filling for a visit with at least one Medical form template in scope.
- Capture visit conversation.
- Receive structured form output after processing.
- Show generated values in your review UI, or confirm they appear in the Form filling SDK experience.
- Let a provider edit or confirm values, then save them in your application.
How Form filling workflows work
Across both modalities, the clinician workflow for Form filling is the same. The only difference is who owns each step. Refer to the table below to see who owns each step for each modality.
If you are building with our Partner APIs, follow Form filling basic usage for how to create a session, stream audio, end the session, and retrieve structured data.
For Form filling APIs, the Form filling session ID is not the same value as an Ambient clinical note session. Use only the ID returned from Create Form filling session API.
Decide before you build your workflow
Before you pick Form filling APIs, Web SDK Form filling, or Form filling SDK for production, align on a few product decisions. Agree which Medical form templates are in scope, who owns capture and review UI, how results reach your server, and how Form filling relates to Ambient or Dictation if you offer more than one product. Those choices shape UX, integration timeline, and which Suki products you combine for a best-fit solution. Use the following sections to align your team.Define Your Form Use Case
Define Your Form Use Case
Be clear about which forms the visit must complete and who completes them. Common examples include nursing assessments, vitals, intake, medication review, and other template-bound workflows.Form filling returns structured values from Suki Medical form templates. It does not generate an ambient clinical note. If you need a full clinical note from the visit conversation, use Ambient clinical documentation. If you need exact wording in a free-text field, use Dictation.Start with one or two templates for the pilot. Binding every available template in one session makes review harder and slows your first success path.
Decide When Structured Results Are Ready
Decide When Structured Results Are Ready
With Suki Form filling, you capture conversation during the session and retrieve structured form output after the session ends. Submit does not return completed form values immediately. Suki processes the audio, then your app receives structured data through status and retrieval APIs, SDK callbacks, or partner webhooks.Providers review generated field values when processing completes. Plan how you show uploading, processing, and timeout states in hosted UI or in your own review screens.For Form filling SDK offline submit, the hosted UI can show an uploading state until audio reaches Suki. Refer to Session workflow.
Choose APIs, Web SDK, or Form Filling SDK
Choose APIs, Web SDK, or Form Filling SDK
Product choice depends on how much UI you want Suki to own:
- Form filling APIs: Your app owns session create, context,
/ws/streamaudio, status, structured data retrieval, review UI, and EHR save. Start with the Form filling API quickstart. - Web SDK Form filling: Use this when you already use
@suki-sdk/jsor@suki-sdk/reactat v3.2.0 or later. Form filling comes from the Web SDK package. See Web SDK Form filling. - Form filling SDK: Use the standalone hosted UI packages when you want Form filling without the rest of the Web SDK. See Form filling SDK quickstart.
Plan Single-Form vs Multi-Form Sessions
Plan Single-Form vs Multi-Form Sessions
Decide whether each session binds one template or more than one.
- Single-form: One
form_template_idfor a focused assessment. - Multi-form: More than one template in the same session. Hosted UI can show template selection when multiple templates are configured.
Plan Review, Save, and Production Delivery
Plan Review, Save, and Production Delivery
Clinicians remain the final authority on form values. Define how providers review generated fields, edit or complete empty fields, and approve the save.Decide:
- Whether review happens in your EHR or custom UI after APIs return structured data, or after Form filling SDK / Web SDK callbacks.
- What happens when a template returns no values: retry, enter fields manually, or leave them empty.
- How you map results to the encounter. Pass a partner
correlation_idso callbacks and webhooks can match the correct record. - How production delivery works. For Form filling SDK, register a partner webhook. Do not rely on browser
onSubmitalone if the tab can close before processing finishes.
generated_values and non_generated_values. Plan review UX for both. You can also submit Form filling feedback with entity AMBIENT_GENERATED_MEDICAL_FORM when you collect ratings on generated forms.Design the clinician workflow
After those decisions are clear, turn them into a Form filling workflow your team can build. Use this table to align on the answers.
Across products, the path stays the same: select templates, start Form filling, capture conversation, process after the session ends, review structured values, then save to the EHR. See How Form filling workflows work.
How to implement Form filling
Next, align on the following implementation choices. These choices decide which Form filling product you use, which templates you bind, and how structured results reach your systems.1. Map the end-to-end Form filling workflow
Walk the visit from template selection to saved form data. For each step, name who owns it: your app, Suki hosted UI, or your backend. Typical stages:- Select the Medical form templates for the encounter.
- Create or open a Form filling session with those templates in context.
- Capture the visit conversation.
- End the Form filling session when that recording is finished, then wait for processing.
- Retrieve or receive structured form output.
- Let the provider review, edit, and save values into the EHR.
2. Choose your audio capture strategy
Form filling quality depends on clear visit conversation and the correct session path. Pick the product that matches who should own the capture UI.
For Form filling APIs, stream visit audio on
GET /ws/stream with the Form filling session ID. Use mono LINEAR16 PCM at 16 kHz. Refer to Audio capture best practices and Form filling basic usage.
Design for clean Form filling audio
Good audio is critical for Form filling quality. Capture clear visit conversation so Suki can map speech to template fields. Design your Form filling workflow so providers can:- Confirm that recording has started and stopped.
- Know which templates are in scope for the session.
- Review structured values while visit context is still fresh.
- Retry or manually complete fields when a template returns no output.
3. Choose your template strategy
Decide how many templates the first pilot needs and how you bind them.
List available templates with Suki Medical form templates. Understand field definitions before you build review UI. Refer to Form filling templates.
After processing, structured data can include
generated_values and non_generated_values. Design review screens for both.
4. Pull context in and push structured results out
Send the right encounter and template context into Suki, then send approved form values back into your clinical systems. Pull context into the session Seed session context with the templates and encounter details you need. Common inputs include:- One or more
form_template_idvalues. - Patient and provider context your workflow requires.
- Partner
correlation_idso results map to the correct encounter record.
- Retrieve structured data with Form filling APIs, or handle SDK
onSubmit/ background submit callbacks. - Register a partner webhook for production delivery when using Form filling SDK or when your backend must receive results if the browser closes.
- Optionally retrieve session recordings when your workflow needs them.
- Save approved values into the EHR or downstream system after provider review.
- Deep embedding: Hosted Form filling inside your web workflow, then server-side save.
- API write-back: Your server retrieves structured data or webhook payloads and writes to the EHR.
- Lightweight handoff: Provider confirms values in your UI while you validate template quality, then deepen write-back.
Common integration patterns and use cases
Design your Form filling integration around template-bound sessions and how structured values move into your clinical systems after processing. The following patterns show common ways to build Form filling workflows:In-Person Form Capture
Capture visit conversation during in-person encounters and retrieve structured form output for nursing and clinical workflows.
Virtual Visit Form Capture
Capture conversation in browser or API workflows used during virtual visits, then return structured form data into your documentation workflow.
Template-Driven Sessions
List templates, bind
form_template_id values in session context, and retrieve generated_values after processing.Custom Form Filling Pipeline
Own session lifecycle, audio streaming, structured data retrieval, and EHR handoff end to end with Partner APIs.
Measure success for Form filling
Treat measurement as something you own. Define what better and worse means for your Form filling workflow, track it where the work happens (your app + EHR), and use the findings before and after you deploy Form filling in production.
Start with a small set of metrics, for example time to saved form, percent of templates with generated values, and later add more metrics as you deploy Form filling in production.
Next steps
Form filling basic usage - Create a session, stream audio, end the session, and retrieve structured data. Form filling API quickstart - Build Form filling with Partner APIs when you own the full pipeline. Web SDK installation - Import Form filling from@suki-sdk/js or @suki-sdk/react when you already use the Web SDK.
Form filling SDK quickstart - Embed the hosted Form filling experience without the rest of the Web SDK.
Form filling templates - Choose the Medical form templates for your workflow.
Partner authentication - Get an sdp_suki_token for API and SDK calls.