@omniloy/sofia-sdk 1.0.5 → 1.0.7

package/dist/legacy/webcomponents.d.ts

@@ -19,13 +19,27 @@ declare enum LanguageCode {
 export declare interface OmniscribeProps {
     /** API base URL for backend communication */
     baseurl: string;
-    /** WebSocket URL for real-time transcription */
-    wssurl: string;
+    /**
+     * @deprecated This prop has no effect. The transcriber WebSocket URL is
+     * resolved from the settings API (GET /profiles/settings → transcriberUrl).
+     * This prop will be removed in v2.0.
+     */
+    wssurl?: string;
     /** API key for authentication */
     apikey: string;
-    /** Unique identifier of the healthcare professional */
+    /**
+     * Unique identifier of the healthcare professional.
+     * SECURITY: Must be an INTERNAL system / surrogate id, never an MRN,
+     * national id, or other directly-identifying value. It is sent to the
+     * backend (and used as LLM context) without anonymization.
+     */
     userid: string;
-    /** Unique identifier of the patient */
+    /**
+     * Unique identifier of the patient.
+     * SECURITY: Must be an INTERNAL system / surrogate id, never an MRN,
+     * national id, or other directly-identifying value. It is sent to the
+     * backend (and used as LLM context) without anonymization.
+     */
     patientid: string;
     /** Template ID - enables report generation when provided with template */
     templateid?: string;
@@ -90,6 +104,8 @@ export declare interface OmniscribeProps {
     disablegenerate?: boolean;
     /** Enable debug logging */
     debug?: boolean;
+    /** Doctor's medical specialty at the time of the event. Optional. When provided, it is attached to every tracked event for analytics segmentation. */
+    userMedicalSpecialty?: string;
     /** Expose function to get last generated report */
     setGetLastReport?: (fn: () => Promise<object | undefined>) => void;
 }