What’s new
New Features
New features
Headless Web SDK v0.3.1Embedded Forms: You can now send the custom fields already embedded in your note templates, plus optional prior section text, on the ambient session you run in Headless. Seed withsetSessionContext or updateSessionContext using sections[].precharted_content. For mid-visit updates, pass updateMask such as ["sections"] or "sections", and replace the full sections list in that call. After the note is ready, read filled values from section_structured_values with getAmbientSessionSectionStructuredData, getAmbientSessionStructuredData, the matching encounter helpers, or React hooks such as useUpdateAmbientSessionContext and useAmbientSessionSectionStructuredData. Filled values use the shape { id?, context?, key, value }.- Your app decides when to refetch. The SDK does not poll in the background.
- Note structured data still returns diagnoses and orders only in this release.
- Headed Web SDK UI and Form filling are out of scope for V1.
- Prefer
setSessionContextfirst when you need offline upload of context.
API v1.7.0Embedded Forms for Ambient APIs: You can now send the fill-in-the-blank fields from your existing note templates with an ambient session, plus optional prior section text, and read the answers back as separate values for voice-driven fills in partner UIs. Add
precharted_content to each section in session context, with type: "structured" entries for templates and type: "string" entries for prior section text. After the note is ready, read the filled values from the new section structured data endpoints or from section_structured_values in session and encounter structured data.- GET /api/v1/ambient/session//structured-data/section-structured-data.
- GET /api/v1/ambient/encounter//structured-data/section-structured-data.
- GET /api/v1/info/structured-data-field-types.
- Send templates after you create the session and before you end the session. You can seed or update after streaming has started. Note structured data does not include Embedded Form values.
Dictation SDK v0.1.0-beta.3Content Rewrite in hosted Dictation: Clinicians can now rewrite selected text in the hosted Dictation editor when backend enablement allows it. With the microphone off and at least two words selected, they choose Concise, Verbose, or Patient Friendly. The UI shows Rewriting…, then replaces the selection on success, or shows Rewrite failed. Please try again. so the clinician can retry.
- Partner apps keep the existing
ShowOptionsandonSubmit/onDraft/onCancelcontract. - There are no new SDK methods or callbacks, and there is no new package to install. Keep v0.1.0-beta.3.
- Web SDK Dictation uses the same iframe. The SDK does not expose an org or user switch for enablement.
API v1.7.0Content Rewrite for Dictation APIs: You can now rewrite a selected span of clinical text after Dictation, or any plain text your application owns. Send the selection, surrounding context, and one instruction (
CONCISE, VERBOSE, or PATIENT_FRIENDLY). The API returns the rewritten text and selection offsets so your UI can replace the span. Your application owns apply and save.- POST /api/v1/content/rewrite.
- Keep
selected_textandsurrounding_contentwithin 5,000 Unicode code points each. Free-form custom instructions are not supported.