Quick summary
Suki medical form templates are predefined clinical assessment schemas. You list them with the Form Filling Info API, bind form_template_id values in session context, stream visit audio, and retrieve structured JSON when processing completes.
This guide covers: Suki-defined templates used for Form filling workflows.
How templates work
Each template represents one clinical assessment category (for example vitals, neuro, or skin). When you list templates through the Form Filling Info API, Suki returns a stabletemplate_id, a type label, and the schema for that assessment.
Every template you receive from the API includes:
| Property | What it tells you |
|---|---|
template_id | UUID you pass as form_template_id in session context |
type | Template type code from the API (for example VITALS_ASSESSMENT) |
name | Human-readable template name |
description | Short summary of the template purpose |
schema | Field definitions, types, and allowed values for structured output |
Templates are Suki-defined. Your integration selects which templates are in scope for a session. You do not upload custom schemas through the Form Filling APIs. In the future, we may support custom templates.
Supported templates
Suki supports the following medical form templates for Form filling. Each one focuses on a specific clinical assessment area, such as vitals, neuro, or skin.Vitals
VITALS_ASSESSMENT: Standard vital signs: temperature, heart rate, blood pressure, SpO₂, oxygen delivery, respiratory rate, and pain score with location and comments.Neuro
NEURO_ASSESSMENT: Neurological status: level of consciousness, orientation, speech, pupils, Glasgow Coma Scale, extremity strength, and sensation.Skin
SKIN_ASSESSMENT: Skin integrity and wound care: color, temperature, moisture, pressure injuries, incision or surgical sites, dressings, and interventions.Respiratory
RESPIRATORY_ASSESSMENT: Respiratory system: breath sounds by lung lobe, work of breathing, cough and sputum, oxygen device and flow rate, SpO₂, and distress signs.Cardiac
CARDIAC_ASSESSMENT: Cardiovascular status: heart rate and rhythm, auscultation, edema, perfusion, chest pain, peripheral pulses, and vascular access.GI
GASTRO_INTESTINAL_ASSESSMENT: Gastrointestinal status: abdomen exam, bowel sounds, diet tolerance, bowel movements, nausea or vomiting, ostomy or tubes, and GI symptoms.GU
GENITO_URINARY_ASSESSMENT: Genitourinary findings: urine output, voiding, dysuria, catheter care, incontinence, bladder distention, and related symptoms.MSK
MSK_ASSESSMENT: Musculoskeletal assessment: range of motion, strength, gait, mobility aids, and joint findings.Intake and output
IO_ASSESSMENT: Intake and output tracking: fluid intake (oral, IV, tube feeding) and output (urine, drainage, emesis) for fluid balance monitoring.template_id and the full schema, including field names and allowed values.
Use cases
List available templates
Call Suki medical form templates to discover
template_id values and review each schema before you build your UI.Bind templates to a session
Seed or update session context with one or more
form_template_id values so Suki knows which assessments are in scope for the visit.Capture conversation as structure
Stream visit audio on
/ws/stream. Suki maps spoken assessment details into schema fields for the templates you selected.Retrieve and hand off output
Poll structured data and use
generated_values in your review UI, validation rules, or EHR save path.- Nursing head-to-toe and focused system assessments
- Intake and reassessment workflows where structured fields matter more than narrative notes
- Telehealth or in-person visits where clinicians speak findings and your app stores structured results
How Form Filling APIs use templates
Templates connect to the standard Form filling session lifecycle. You do not send template schemas on every audio chunk. You declare which templates apply, stream audio once, then read structured output when processing finishes.List templates
Call GET Suki medical form templates. Save the
template_id for each assessment you support in your product.Create a Form filling session
Call POST Create Form Filling session and store the returned
ambient_session_id.Seed session context
Call POST Seed Form Filling session context with
form_filling.values[].form_template_id set to the UUIDs from step 1. To change templates mid-visit, use Update Form Filling session context.Stream visit audio
Connect to
/ws/stream with your Form filling ambient_session_id. Refer to Ambient audio streaming for handshake, PCM format, and EVENT messages.End the session and retrieve output
Call End Form Filling session, poll status, then call structured data. Review
generated_values for populated templates and non_generated_values for templates without output.JSON