FormFillingProps Type

In React, pass the same session options as client.start() as props on FormFilling. You do not pass rootElement. The component renders the hosted UI in .suki-form-filling for you.

React

<FormFilling
  forms={[{ form_template_id: "YOUR_TEMPLATE_ID" }]}
  correlation_id="YOUR_ENCOUNTER_ID"
  onSubmit={(result) => {
    console.log(result.structured_data);
  }}
/>

Properties

Hide FormFilling props

MedicalFormMetadata[]

Same as start(). Preferred static, dynamic, or mixed form list. Refer to Dynamic and static medical forms.

string[]

DEPRECATED Same as start(). This option still works when you omit forms. Prefer forms, because we will remove this option in a future major release.

string

Same as start(). Your encounter or appointment ID. Strongly recommended. Refer to Encounter ID (correlation_id).

function

required

Same as start(). Required handler for structured results after processing completes. Refer to Callbacks.

function

Same as start().

function

Same as start().

function

React only. Called for form-filling:background-submitted when results arrive for a session that is no longer the active one while the iframe is open. Same payload shape as onSubmit.

Set height on .suki-form-filling before the hosted UI opens. Refer to Container sizing.

Next steps

StartOptions - Matching fields for JavaScript client.start(). Configuration - How to set forms, correlation_id, and container height. React integration - Provider and FormFilling wiring. Callbacks - When onSubmit, onReady, and onCancel run.

Get Started

Integration Guides

Concepts & Feature Guides

API Reference

Resources

FormFillingProps Type

Properties

Next steps

​Properties

​Next steps

Properties

Next steps