@omniloy/sofia-sdk 1.0.5 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -23,9 +23,19 @@ export declare interface OmniscribeProps {
23
23
  wssurl: string;
24
24
  /** API key for authentication */
25
25
  apikey: string;
26
- /** Unique identifier of the healthcare professional */
26
+ /**
27
+ * Unique identifier of the healthcare professional.
28
+ * SECURITY: Must be an INTERNAL system / surrogate id, never an MRN,
29
+ * national id, or other directly-identifying value. It is sent to the
30
+ * backend (and used as LLM context) without anonymization.
31
+ */
27
32
  userid: string;
28
- /** Unique identifier of the patient */
33
+ /**
34
+ * Unique identifier of the patient.
35
+ * SECURITY: Must be an INTERNAL system / surrogate id, never an MRN,
36
+ * national id, or other directly-identifying value. It is sent to the
37
+ * backend (and used as LLM context) without anonymization.
38
+ */
29
39
  patientid: string;
30
40
  /** Template ID - enables report generation when provided with template */
31
41
  templateid?: string;
@@ -90,6 +100,8 @@ export declare interface OmniscribeProps {
90
100
  disablegenerate?: boolean;
91
101
  /** Enable debug logging */
92
102
  debug?: boolean;
103
+ /** Doctor's medical specialty at the time of the event. Optional. When provided, it is attached to every tracked event for analytics segmentation. */
104
+ userMedicalSpecialty?: string;
93
105
  /** Expose function to get last generated report */
94
106
  setGetLastReport?: (fn: () => Promise<object | undefined>) => void;
95
107
  }