Skip to main content
All notable changes to SofIA SDK are documented on this page. The format follows Keep a Changelog and the project adheres to Semantic Versioning. Internal refactors with no effect on your integration are summarized as “stability and reliability improvements.”

​
v1.0.9 - 2026-07-16

​
Added

  • Clinical Actions (Extras) — extract the actions that come out of a visit (petitions, appointments, tests, referrals) and deliver them to your HIS by category. You define the categories in the new templateExtras prop and receive their items in the handleExtras callback, exactly as your schema produced them (no field renaming). One button per category, the first two inline and the rest in a three-dots menu. See Clinical Actions (Extras).
  • templateExtras prop (object, JSON Schema) — its top-level properties are the categories.
  • handleExtras callback — receives the items of the clicked category, extracted on demand. Reuses the insertion preview modal for curation (same showInsertionPreview flag, enabled by templateExtras).

​
Changed

  • Redesigned transcriber action bar: dedicated record/stop button, audio level meter, and the Generate and Extras buttons split into their own pills.

​
v1.0.8 - 2026-07-09

​
Added

  • Insertion preview modal — review and curate a generated report before it reaches your app. Opt-in per API key (off by default). See Insertion preview.
  • onReportApply prop — receive the curated report from the insertion preview modal.
  • updateTemplate callback — feed your EMR’s existing field values into generation so regeneration produces a revised note instead of an identical copy. See Pre-fill from your EMR.
  • baseurl auto-resolution — newer API keys select the endpoint automatically, so baseurl is now optional for them.

​
v1.0.7 - 2026-06-23

​
Added

  • Audio environment selector in microphone settings: a per-user VAD min-coverage option fetched from the backend and forwarded as vad_min_coverage in the WS record command

​
Deprecated

  • wssurl — deprecated and ignored. The transcription WebSocket URL is now provided by the settings API; just remove the prop.

​
v1.0.6 - 2026-06-11

​
Added

  • Patient-data anonymization — PII in patientdata is masked client-side before every outbound request and restored in the response.

​
Changed

  • Per-field custom description limit raised from 1,000 to 3,000 characters.
  • Stability and reliability improvements.

​
v1.0.5 - 2026-05-13

​
Added

  • Automatic report drafting — a report is drafted in the background as soon as recording ends.
  • Audio-cut detection — audio cuts are flagged inline in the transcription, with a warning before you generate or regenerate.

​
Changed

  • Stability and reliability improvements to recording and note generation.

​
v1.0.4 - 2026-04-17

​
Changed

  • Reliability improvements for audio recording — microphone recovery, connectivity monitoring, and clearer “no microphone available” handling.

​
v1.0.3 - 2026-04-14

​
Added

  • Extended language support.

​
Removed

  • showconsentindicator property.

​
Fixed

  • Security patches for third-party dependencies.

​
v1.0.2 - 2026-03-19

​
Added

  • Extended language support (Czech, French, Swedish; en split into en_GB / en_US).
  • Redesigned template-configuration UI — a general-prompt field and per-field enable/disable toggles.
  • File drag-and-drop and clipboard paste in the chat.

​
Breaking Changes

  • Added the showconsentindicator property; the consent indicator is hidden by default (set it to true to show). (Later removed in 1.0.3.)

​
v1.0.0 — 2025

Release type: Major

​
Added

  • template prop replaces toolsargs for clinical data schema configuration
  • templateid prop required alongside template for report generation
  • isConfigurable field in template properties to control user customization
  • debug="true" mode with structured console logging prefixed with [Sofia SDK]
  • Automatic chat-only mode when template/templateid are omitted

​
Changed

  • Generate button now requires both template and templateid to appear

​
Deprecated

  • toolsargs → use template (will be removed in v2.0)

​
Removed

  • isonlychat — chat-only mode is now automatic
  • disablegenerate — omit template/templateid instead
  • disableactions — don’t mount the component instead
  • sofiatitle — title is always “SofIA”
  • isscreenloading — not available in Chat-based UI
  • transcriptorselectvalues — no effect
  • renderReportContent — custom rendering not available in Chat UI
  • handleFill — not available in Chat UI
  • toast — no effect

​
Migration

See the Migration Guide for step-by-step instructions.

​
v0.0.x — 2024

Early pre-release versions. Highlights:
  • v0.0.10 — file processing support; deprecation warnings for legacy props; isConfigurable support in template fields.
  • v0.0.9 — configurable autosummary of the conversation.
  • v0.0.3 — initial public release: <sofia-sdk> web component with Shadow DOM, real-time audio transcription, report generation, framework support (Vanilla JS, React, Angular), English/Spanish, handleReport/setIsOpen/setGetLastReport callbacks, patientdata, and JSON Schema Draft-07 templates.
Versions v0.0.4–v0.0.8 were internal stability and settings improvements with no user-facing API changes.