What’s new
New Features
New features
Form Filling SDK v0.1.0Form filling SDK Beta: We’re introducing the Suki Form filling SDK (Beta) a JavaScript and React library that lets you embed Suki’s Form filling experience directly in your web application, without building the complete Form filling API workflow yourself. It handles authentication, loads Suki’s hosted Form filling interface, and returns structured form data when a clinician completes an assessment.The Form filling SDK provides the following out of the box:- JavaScript and React SDKs for embedding Form filling in your application.
- Automatic authentication using
SukiAuthManager. - Support for launching a single form directly or letting clinicians choose from multiple forms.
- Session callbacks, including
onSubmit, for receiving structured results in your application. - Support for partner webhooks to deliver results to your backend after processing completes.
@suki-sdk/core and the Form filling SDK package for your framework:FormFillingClient, sign in with your partner credentials, and call start() with your form_template_ids and correlation_id.JavaScript
API v1.6.0Ambient interoperability across Suki products: You can now use ambient interoperability to continue the same clinical note across Suki ambient products, including the Ambient APIs, Mobile SDK, Headless Web SDK, and Headed Web SDK. Start an ambient session in one product and continue, re-ambient, or retrieve the same note from another.To enable ambient interoperability, include
emr_encounter_id when creating an ambient session. The Create ambient session API now also returns a composition_id, which you use as the note_id for note-level Ambient APIs.Use cases of ambient interoperability- You can continue the same ambient note across the Ambient APIs, Mobile SDK, Headless Web SDK, and Headed Web SDK.
- Access the latest accumulated note content, including edits made from headed products.
- Retrieve aggregated note context and structured clinical data across multiple ambient sessions.
- You can list all ambient notes associated with an EMR encounter.
- POST /api/v1/ambient/session/create: Create an ambient session with
emr_encounter_idand receivecomposition_id. - GET /api/v1/ambient/encounter//notes: List all notes associated with an EMR encounter.
- GET /api/v1/ambient/note//content: Retrieve accumulated note content.
- GET /api/v1/ambient/note//context: Retrieve aggregated note context.
- GET /api/v1/ambient/note//structured-data: Retrieve aggregated diagnoses, orders, and other structured clinical data.
What’s enhanced
Enhancements
Enhancements
Mobile SDK v2.7.0Mobile SDK interoperability with other Suki products: From Mobile SDK v2.7.0, the Mobile SDK supports ambient interoperability with Ambient APIs and the Web SDK. PassSukiAmbientConstant.kEmrEncounterId and SukiAmbientConstant.kSessionId (Session Group ID / encounter_id) when you call createSession so the session shares one clinical note for the patient visit.You can now:- Resolve a remote session conflict with
cancelRemoteAmbientSessionorendSessionRemotely, then retrycreateSession. - Handle
SessionEvent.sessionTerminatedByPeerwhen another Suki product ends the live session. Update the UI only. Do not call localend(),cancel(), orclear(). - List and read shared note content with
listEncounterNotes,getNoteContext,getNoteContent,getNoteStructuredData, andencounterContent.
Web SDK v3.2.0Web SDK interoperability with other Suki products: From Web SDK v3.2.0, the Web SDK supports ambient interoperability with Ambient APIs, Mobile SDK, and Headless Web SDK. Pass a stable encounter identifier as
encounter.identifier when you create the ambient session. That value maps to emr_encounter_id and lets the Web SDK share one clinical note for the patient visit.You can now:- Open a clinical note that started on Mobile SDK, Headless Web SDK, or Ambient APIs.
- Review, edit, and submit the shared note in the headed Web SDK UI.
- Start an ambient session in the Web SDK and continue or re-ambient it from another ambient product.
encounter.patient so the Web SDK can show the patient profile. If the note started on a headless product first, seed patient context before you open the Web SDK.Why it matters: Build one ambient workflow across headed and headless products for the same clinical encounter, and finish review and submit in the Web SDK without creating a separate note.Learn more in the Web SDK interoperability guide, Ambient interoperability, and How to use interoperability across Suki products.Web SDK v3.2.0Form filling in the Web SDK: From Web SDK v3.2.0, Form filling is included in
@suki-sdk/js and @suki-sdk/react. If you already use the Web SDK, import FormFillingClient (and, in React, FormFillingProvider, FormFilling, and useFormFilling) from your Web SDK package. You do not need to install @suki-sdk/form-filling or @suki-sdk/form-filling-react separately. Use the standalone Form filling SDK packages only when you want Form filling without the rest of the Web SDK.Why it matters: Add hosted Form filling to an existing Web SDK app without a second package install or a full Form filling API integration.Learn more in the Web SDK Form filling overview, JavaScript integration, and React integration guides.