StartOptions Type

These are the settings you pass each time you open Form filling with client.start() in JavaScript. Prefer forms for the medical forms in this run. Pass correlation_id so results map to the correct encounter.

JavaScript

await client.start({
  rootElement,
  forms: [{ form_template_id: "YOUR_TEMPLATE_ID" }],
  correlation_id: "YOUR_ENCOUNTER_ID",
  onSubmit: (result) => {
    console.log(result.structured_data);
  },
});

Properties

Hide start() options

HTMLElement

required

Container for the Form filling UI. JavaScript only. Give this element explicit height before start(). React passes the container automatically through FormFilling. Refer to Container sizing.

MedicalFormMetadata[]

Preferred list of medical forms for this Form filling run. Each entry is either { form_template_id } or a dynamic entry with required schema and optional id, name, and type. When forms is provided, it is the sole source of Context. Supply at least one valid entry. Refer to Dynamic and static medical forms and Dynamic Form filling.

string[]

DEPRECATED List of Suki template IDs as strings. This option still works when you omit forms. Prefer forms: [{ form_template_id }], because we will remove this option in a future major release. The SDK maps each ID to { form_template_id }. Unsupported IDs are dropped, and if no valid forms remain the SDK emits SUKI_FF_001.

string

Optional. Your encounter or appointment ID from your system. Echoed on callbacks and webhook payloads. Strongly recommended so structured data maps to the correct record. When omitted, the hosted UI supplies a UUID when it creates the session. Refer to Encounter ID (correlation_id).

function

required

Called when structured results are ready (after processing), not when the clinician taps submit. Receives a FormFillingResult with structured_data. For dynamic forms, correlate with partner_form_id. The iframe is removed after this runs for the active session. Refer to Callbacks.

function

Optional. Called when the hosted UI is loaded and ready. Runs after start() resolves the iframe handshake.

function

Optional. Called when the clinician cancels during form selection or recording.

For callback behavior and event payloads, refer to Callbacks and Events.

Next steps

FormFillingProps - Same session fields as React props. Configuration - How to set forms, correlation_id, and container height. FormFillingClientOptions - authManager and onError on the client. JavaScript integration - End-to-end start() wiring.

Get Started

Integration Guides

Concepts & Feature Guides

API Reference

Resources

StartOptions Type

Properties

Next steps

​Properties

​Next steps

Properties

Next steps