Explore the most popular use cases, workflows, and integrations for Suki for Partners. Review each use case to understand how to use Suki for Partners in your product and accelerate your AI roadmap.
Start with paths many clinical and operational partners implement first.
Draft clinical notes from encounter audio while you control capture and authentication.
Capture encounter audio in your product and generate draft clinical documentation using the Suki developer platform.
You control authentication, session lifecycle, and audio capture. The Suki Platform processes approved audio and structured clinical data to return draft clinical notes.
Use this integration when you want clinicians to stay inside your EHR, telehealth product, or care workflow while your backend orchestrates note generation using APIs, streaming endpoints, and webhooks.
Start with Ambient clinical documentation, then explore the Ambient API overview and your selected SDK documentation for deeper integration patterns.
Turn visit conversation into template-driven form output for your workflow.
Capture visit audio and retrieve structured medical form output through Form filling APIs, the Form filling SDK, or Web SDK Form filling.
You choose how much UI and session control you own. Form filling APIs give you full control over capture, review, and save. The Form filling SDK and Web SDK Form filling embed Suki's hosted form UI and return structured results through callbacks and webhooks.
Use this integration when clinicians complete nursing forms, intake forms, assessments, medication reviews, or other template-based workflows where the output must land in defined fields instead of free-text note sections.
@suki-sdk/js or @suki-sdk/react when you already use the headed Web SDK.Start with the Form filling overview, then open Form filling SDK, Web SDK Form filling, or Form filling basic usage for the path you selected.
Prepare pre-visit summaries for every appointment on a provider's schedule before clinic begins.
Ingest FHIR data into CKG, then generate summaries with Patient Summary APIs or show them on the headed Web SDK patient profile.
Your backend owns CKG ingestion. Patient Summary APIs trigger scheduled generation and status polling. Web SDK shows the pre-visit snippet and full summary on the patient profile after you pass matching encounter identifiers.
Use this integration when partners need morning clinic preparation or provider sign-in flows that preload summaries for every qualifying appointment on a provider's schedule.
encounter.identifier and encounter.practitionerFhirId when you initialize and when you mount.COMPLETED.fhir_practitioner_id.Start with Generate patient summaries, then open the scheduled-appointments API reference and Retrieve patient summaries for display guidance.
Bind Suki Medical form templates to a session and retrieve structured output.
Select Suki Medical form templates, bind them to a session, and retrieve generated form values when processing completes.
You decide which forms are in scope for the visit by sending template metadata in session context. Suki uses the visit audio and selected templates to return structured values for the forms your workflow needs.
Use this integration when your product must support known form types, such as intake, nursing, assessment, or medication review forms, and each workflow needs a predictable set of returned fields.
form_template_id values.form_template_ids when you start hosted Form filling.ambient_session_id.form_template_id values selected for the visit.Read Form filling basic usage, then open the template and session context references while you design template selection in your product.
Retrieve generated form values and route them into review, save, or handoff flows.
Retrieve generated form values through APIs, SDK callbacks, or webhooks, then route them into review, save, or EHR handoff flows.
You control what happens after capture ends. Suki returns structured form output, and your product decides how clinicians review, edit, approve, save, or hand off the values.
Use this integration when your main product requirement is reliable downstream routing, for example saving fields into an EHR, handing off data to care management tools, or showing a review screen before final submission.
generated_values and non_generated_values.onSubmit callbacks and partner webhooks.generated_values into your review or persistence model.non_generated_values in your UI or downstream workflow.Use the status and structured data references while you design your review state, error handling, and EHR handoff behavior.
Align generated notes to problems, sections, and chart-aware titles.
Send problem-oriented structure so generated notes match diagnoses, sections, and visit-aware titles in your chart.
You supply diagnoses, visit-aware titles, sections, and related structure. Ambient capture still feeds the Suki Platform; returned documentation follows how clinicians chart in your product.
Use this integration when a plain transcript is not enough. Enable PBC through Ambient APIs, Web SDK, or Mobile SDK, then read structured diagnosis output after the session completes.
ambientOptions and review problem-oriented notes in the headed UI.setSessionContext and returns structured output with getStructuredData.Stay with the problem-based charting guide until your payloads match the capability reference, then use the Ambient API overview and webhooks or content retrieval docs as needed for your rollout.
Enrich sessions so drafts reflect medication orders and chart context.
Attach medication orders and EMR metadata to sessions so drafts align with the chart clinicians already use.
You send medication orders and related metadata with the ambient session. Generated notes reflect the same clinical frame as the live chart.
Use this integration when ordering context must ride alongside ambient capture. Ambient APIs and Mobile SDK accept medication context and return structured orders. Web SDK lets clinicians review generated orders in the headed UI before note submission.
orders on note submit.kOrdersInfo in session context and returns structured medication orders when the session completes.Finish the medication orders guide, then open the Web SDK, Mobile SDK, or API path that matches your capture product.
Request short-lived recording access for replay or archival jobs.
Request time-limited access to session audio for replay, audit, or archival jobs on the server, using the Suki developer platform.
You run authenticated backend services that request short-lived access to session recordings. Your organization replays, audits, or archives audio that matches generated Ambient documentation.
Use this integration when retrieval must stay on the server. Follow Ambient APIs as described in the audio streaming and download guide. Do not expose long-lived media URLs to the browser.
Follow the audio streaming and download guide into the cited endpoints, then finish security review with your internal compliance stakeholders.
Receive HTTPS callbacks when Ambient or Form filling sessions complete or fail.
Receive HTTPS callbacks when Ambient or Form filling sessions complete or fail so your servers update state without polling clients.
You register a callback URL. The platform posts to your endpoint when sessions finish or error so downstream jobs run on your timeline.
Use this integration when you want push-driven completion instead of polling. The webhook guide covers POST delivery, signature verification with your partner secret, and how Ambient, Form filling, and SDK sessions still use the same partner webhook callbacks.
generated-at and X-API-Key for HMAC validation.Finish the webhook guide, then align payloads with the ambient session objects your integration stores.
Add hosted speech-to-text to web fields or scratchpad workflows.
Add hosted speech-to-text to a browser application with in-field and scratchpad modes while your product controls launch points, callbacks, and where transcript text goes.
You use Dictation SDK or Web SDK Dictation for browser speech-to-text. Suki hosts the Dictation UI, and your application decides when to open it, which field or region it belongs to, and how submitted text updates your workflow.
Use this integration when clinicians need to dictate into a note field, form field, or scratchpad without your team managing REST sessions and WebSocket streaming directly. This path is separate from Headless Web SDK ambient hooks and from direct Dictation API integrations.
Start with the Dictation SDK introduction, then read in-field mode or scratchpad mode based on the browser experience you want to ship.
Create transcription sessions, stream audio, and handle partial and final transcripts.
Build speech-to-text into your own client or backend flow by creating transcription sessions with REST APIs and streaming audio over the Dictation WebSocket.
You own session creation, audio capture, transcript handling, and downstream text placement. Dictation APIs provide the REST session lifecycle and WebSocket streaming contract instead of a hosted browser UI.
Use this integration when capture runs in a backend service, desktop shell, device gateway, or custom client where your team needs direct control over audio streaming and transcript handling.
audioData payloads, AUDIO_END, and inbound transcript frames you must handle after a session exists.transcription_session_id./ws/transcribe only when the session is ready to accept speech, then send JSON AUDIO messages with Base64-encoded PCM audio.AUDIO_END, and end the session through the REST API.Start with Dictation Basic Usage, then use Dictation Audio Streaming and the API reference while you implement the WebSocket and transcript handling path.
Capture ambient audio inside browser telehealth and shared-audio setups.
Capture ambient audio in browser telehealth and shared-audio setups with Web SDK guidance on permissions and UX, using the Suki developer platform.
You keep clinicians in browser-based telehealth while the Web SDK handles capture patterns for that environment, including shared tab audio where supported.
Use this integration when vendor portals, browser prompts, and recovery flows interact tightly. Follow the telehealth and session recovery guides instead of assuming desktop microphone behavior.
Finish the telehealth guide checklist, then run vendor-specific QA on browser policies.
Build a fully custom ambient React UI with Headless Web SDK hooks (beta).
Compose ambient flows in React 18+ with @suki-sdk/platform-react hooks while you own the full UI, using the Suki developer platform.
You use hooks for authentication, ambient sessions, recording lifecycle, and related behaviors. You implement prompts, accessibility, and error handling that the headed Web SDK widget otherwise provides.
Use this integration when you cannot embed headed Web SDK UI but still need ambient in the browser. This beta surface is separate from the headed Web SDK. Plan staffing for offline and connectivity UX described in the Headless guides.
Complete quickstart, read each hook you plan to ship, then compare gaps with the headed Web SDK feature list and your solutions consultant.
Shape generated notes into predictable sections for downstream systems.
Shape generated notes into sections, headings, and structured fields so downstream systems receive predictable layouts, using the Suki developer platform.
You configure how ambient output splits so EHR or specialty workflows consume repeatable structure instead of a single unstructured block.
Use this integration when downstream systems need predictable note shape. The note sections documentation explains how to reason about outputs during ambient integration. Specialties and multilingual material linked from Core workflows add constraints some programs must apply.
Read note sections and specialties first, then schedule engineering work against the ambient SDK or API you already selected.
Compare API, Web SDK, and Dictation SDK options for speech-to-text.
Compare the supported speech-to-text paths: direct Dictation APIs, Web SDK browser Dictation, and Dictation SDK hosted iframe workflows.
You use the Audio Dictation guide to decide who owns capture, session lifecycle, transcript handling, and user experience. The guide separates direct REST and WebSocket integrations from browser SDK options.
Use this integration when product and engineering teams need to choose between full API control, Web SDK browser components, or Dictation SDK in-field and scratchpad modes before implementation begins.
Use the Audio Dictation guide as the decision point, then continue to the API, Web SDK, or Dictation SDK path that matches your product.
Send JSON audio messages and receive partial and final transcript frames.
Stream Dictation audio as JSON text frames on GET /ws/transcribe after you create a transcription session with REST.
You follow a protocol that uses UTF-8 JSON frames, one object per frame, Base64-encoded PCM_S16LE in audioData, and an EVENT message with AUDIO_END when audio completes. Treat these rules as part of the integration contract.
Use this integration when you implement a custom WebSocket client and need to render or store partial and final transcripts yourself. Follow the handshake and message ordering rules before you ship a custom client.
transcription_session_id.audioData, and finish each stream with AUDIO_END.Keep Dictation Audio Streaming open while you implement transport behavior, then cross-check the endpoint reference for code examples and connection details.
Plan ambient capture for brief connectivity loss in React.
Plan for brief connectivity loss so clinicians recover or sync ambient sessions without data loss in Headless React apps, using the Suki developer platform.
You own prompts, retries, and reconciliation. Headless integrations expose hooks; the offline-mode and online and offline behavior guides describe what your team must implement.
Use this integration when you deploy on unreliable Wi-Fi or cellular networks. Offline support is not automatic. Read the guides before you promise uninterrupted capture on poor networks.
Prototype offline scenarios in staging with the guides above, then document recovery copy for compliance review.
Run ambient capture in a compact Web SDK footprint when space is tight.
Run ambient capture in a compact Web SDK footprint when space or vendor overlays block full chrome, using the Suki developer platform.
You keep the headed Web SDK with a smaller surface through minimized layout. Documentation lists embedding constraints, dialogs, and implementation notes for the compact UI.
Use this integration when EHR frames or overlays leave little room for full chrome. Authentication and session responsibilities match the broader Web SDK guides.
Finish the minimized layout checklist, then review UX against real vendor iframe dimensions.
Send personalization payloads so generation honors provider and organization settings.
Save provider personalization preferences so ambient generation honors verbosity and section format across future notes.
You save personalization preferences once per provider. Suki applies verbosity and section format to that provider's future ambient notes. You do not send personalization fields on every session.
Use this integration when end-user or org-level tuning must reach server-side generation. Set preferences with Ambient APIs or Mobile SDK, then run ambient capture in Ambient APIs, Web SDK, or Mobile SDK.
sdp_provider_id.ambientOptions.Keep the capability reference open during implementation. Clinical governance owns business-specific tuning policies.
Confirm Form filling API ownership across web, mobile, and backend teams.
Confirm how your team will own UI, audio handling, session lifecycle, and structured-data handoff before you choose Form filling APIs, Form filling SDK, or Web SDK Form filling.
You use the integration decision guide to map your product type, team skills, and technical requirements to Form filling APIs, Form filling SDK, or Web SDK Form filling.
Use this integration when architecture, product, and delivery teams need to align before implementation. The guide explains how each Form filling path applies across web applications, backend systems, and multi-platform products.
Share the decision guide with product, engineering, and security stakeholders, then move into Basic usage when the API path is confirmed.
Generate a pre-visit summary when a clinician opens one chart or a late appointment is added.
Trigger generation for one upcoming visit with fhir_encounter_id and fhir_practitioner_id, then poll until the job completes.
Use encounter generation when you need one summary for one patient. Your backend returns a patient_summary_id, monitors job status, and retrieves the completed summary for chart review.
Use this integration for chart open, late schedule additions, or regenerating a summary after meaningful CKG updates for a single visit.
fhir_encounter_id and fhir_practitioner_id pair.COMPLETED, FAILED, or ABORTED.patient_summary_id when needed.Follow Generate patient summaries for the encounter path, then Retrieve patient summaries for display and empty-state guidance.
Load full or pre-visit summaries into schedule and chart UI, including empty clinical states.
Retrieve summaries through Patient Summary APIs for your own UI, or show them in the headed Web SDK patient profile.
Retrieval is separate from generation. Patient Summary APIs return full or pre-visit summaries for your own schedule and chart UI. Web SDK displays the snippet and full summary in the headed patient profile. You do not call retrieve APIs for that headed workflow.
Use this integration when clinicians need About this visit, Summary, Previous visits, and Problems in schedule cards, appointment details, or patient profiles.
patient_summary_id or partner identifiers.COMPLETED before retrieval.Start with Retrieve patient summaries, then use the Patient Summaries API reference while you map sections into schedule and chart UI.
No scenarios match your filters or search. Choose All or another workflow, or try a different keyword.