Where Do I Get form_template_ids?
Where Do I Get form_template_ids?
Refer to Form filling templates for supported template types (for example vitals, neuro, skin).Prefer
forms: [{ form_template_id }]. form_template_ids is an array of template_id UUID strings (36 characters). Contact your Suki support team to get the UUIDs enabled for your partner account. Do not guess template IDs. IDs differ between staging and production.The Form filling API lists template_id values at Suki Medical form templates. SDK partners should still use static IDs from Suki support.Refer to Prerequisites and Partner onboarding.Can I Use Partner-Defined Schemas (Dynamic Forms)?
Can I Use Partner-Defined Schemas (Dynamic Forms)?
Yes, from Form filling SDK v0.1.0-beta.3 (and Web SDK v3.3.1). Pass
forms entries with a schema object (optional id, name, type), alone or mixed with static form_template_id entries. Correlate results with partner_form_id.Refer to Dynamic Form filling and Configuration.Do I Need Webhooks If I Use the SDK?
Do I Need Webhooks If I Use the SDK?
Yes, for production. After the clinician submits, Suki processes the session and sends a webhook when structured data is ready.Use
onSubmit for in-app UX. Use the webhook to save results on your server.Refer to Prerequisites and Webhook handler example.What Is correlation_id?
What Is correlation_id?
In the SDK,
correlation_id is your encounter or appointment ID from your system. Pass it when you start a session with forms.It links the Form filling session to a specific patient encounter. The same value is returned on onSubmit, emitter events, and webhook payloads so you can map structured_data to the correct record in your backend.Strongly recommended for production. If you omit it, the hosted UI generates a UUID that will not match your encounter ID.Use correlation_id with a partner webhook so results reach your server even when the user closes the browser. Refer to Configuration and the Quickstart.Can I Pass Multiple Forms in One Session?
Can I Pass Multiple Forms in One Session?
Yes. Pass multiple entries in
forms (static, dynamic, or mixed). The hosted UI lets the clinician select one or more forms. At least one form must stay selected. form_template_ids with multiple UUIDs still works when forms is omitted.Do I Still Need Form Filling APIs If I Use the SDK?
Do I Still Need Form Filling APIs If I Use the SDK?
For browser capture with the hosted UI, use the SDK. Use the Form filling API when you need a fully custom UI or server-side audio capture.