@aws-sdk/client-connecthealth 3.1003.0

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.
Files changed (134) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +313 -0
  3. package/dist-cjs/auth/httpAuthSchemeProvider.js +46 -0
  4. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  5. package/dist-cjs/endpoint/ruleset.js +7 -0
  6. package/dist-cjs/index.js +483 -0
  7. package/dist-cjs/models/ConnectHealthServiceException.js +12 -0
  8. package/dist-cjs/models/errors.js +99 -0
  9. package/dist-cjs/runtimeConfig.browser.js +43 -0
  10. package/dist-cjs/runtimeConfig.js +60 -0
  11. package/dist-cjs/runtimeConfig.native.js +19 -0
  12. package/dist-cjs/runtimeConfig.shared.js +43 -0
  13. package/dist-cjs/schemas/schemas_0.js +691 -0
  14. package/dist-es/ConnectHealth.js +45 -0
  15. package/dist-es/ConnectHealthClient.js +54 -0
  16. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  17. package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
  18. package/dist-es/commands/ActivateSubscriptionCommand.js +16 -0
  19. package/dist-es/commands/CreateDomainCommand.js +16 -0
  20. package/dist-es/commands/CreateSubscriptionCommand.js +16 -0
  21. package/dist-es/commands/DeactivateSubscriptionCommand.js +16 -0
  22. package/dist-es/commands/DeleteDomainCommand.js +16 -0
  23. package/dist-es/commands/GetDomainCommand.js +16 -0
  24. package/dist-es/commands/GetMedicalScribeListeningSessionCommand.js +16 -0
  25. package/dist-es/commands/GetPatientInsightsJobCommand.js +16 -0
  26. package/dist-es/commands/GetSubscriptionCommand.js +16 -0
  27. package/dist-es/commands/ListDomainsCommand.js +16 -0
  28. package/dist-es/commands/ListSubscriptionsCommand.js +16 -0
  29. package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
  30. package/dist-es/commands/StartMedicalScribeListeningSessionCommand.js +25 -0
  31. package/dist-es/commands/StartPatientInsightsJobCommand.js +16 -0
  32. package/dist-es/commands/TagResourceCommand.js +16 -0
  33. package/dist-es/commands/UntagResourceCommand.js +16 -0
  34. package/dist-es/commands/index.js +16 -0
  35. package/dist-es/endpoint/EndpointParameters.js +11 -0
  36. package/dist-es/endpoint/endpointResolver.js +14 -0
  37. package/dist-es/endpoint/ruleset.js +4 -0
  38. package/dist-es/extensionConfiguration.js +1 -0
  39. package/dist-es/index.js +9 -0
  40. package/dist-es/models/ConnectHealthServiceException.js +8 -0
  41. package/dist-es/models/enums.js +76 -0
  42. package/dist-es/models/errors.js +89 -0
  43. package/dist-es/models/models_0.js +1 -0
  44. package/dist-es/pagination/Interfaces.js +1 -0
  45. package/dist-es/pagination/ListDomainsPaginator.js +4 -0
  46. package/dist-es/pagination/ListSubscriptionsPaginator.js +4 -0
  47. package/dist-es/pagination/index.js +3 -0
  48. package/dist-es/runtimeConfig.browser.js +38 -0
  49. package/dist-es/runtimeConfig.js +55 -0
  50. package/dist-es/runtimeConfig.native.js +15 -0
  51. package/dist-es/runtimeConfig.shared.js +39 -0
  52. package/dist-es/runtimeExtensions.js +9 -0
  53. package/dist-es/schemas/schemas_0.js +687 -0
  54. package/dist-types/ConnectHealth.d.ts +137 -0
  55. package/dist-types/ConnectHealthClient.d.ts +215 -0
  56. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  57. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  58. package/dist-types/commands/ActivateSubscriptionCommand.d.ts +96 -0
  59. package/dist-types/commands/CreateDomainCommand.d.ts +101 -0
  60. package/dist-types/commands/CreateSubscriptionCommand.d.ts +96 -0
  61. package/dist-types/commands/DeactivateSubscriptionCommand.d.ts +96 -0
  62. package/dist-types/commands/DeleteDomainCommand.d.ts +79 -0
  63. package/dist-types/commands/GetDomainCommand.d.ts +95 -0
  64. package/dist-types/commands/GetMedicalScribeListeningSessionCommand.d.ts +140 -0
  65. package/dist-types/commands/GetPatientInsightsJobCommand.d.ts +128 -0
  66. package/dist-types/commands/GetSubscriptionCommand.d.ts +96 -0
  67. package/dist-types/commands/ListDomainsCommand.d.ts +85 -0
  68. package/dist-types/commands/ListSubscriptionsCommand.d.ts +100 -0
  69. package/dist-types/commands/ListTagsForResourceCommand.d.ts +76 -0
  70. package/dist-types/commands/StartMedicalScribeListeningSessionCommand.d.ts +159 -0
  71. package/dist-types/commands/StartPatientInsightsJobCommand.d.ts +125 -0
  72. package/dist-types/commands/TagResourceCommand.d.ts +75 -0
  73. package/dist-types/commands/UntagResourceCommand.d.ts +75 -0
  74. package/dist-types/commands/index.d.ts +16 -0
  75. package/dist-types/endpoint/EndpointParameters.d.ts +44 -0
  76. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  77. package/dist-types/endpoint/ruleset.d.ts +2 -0
  78. package/dist-types/extensionConfiguration.d.ts +9 -0
  79. package/dist-types/index.d.ts +17 -0
  80. package/dist-types/models/ConnectHealthServiceException.d.ts +14 -0
  81. package/dist-types/models/enums.d.ts +204 -0
  82. package/dist-types/models/errors.d.ts +90 -0
  83. package/dist-types/models/models_0.d.ts +1519 -0
  84. package/dist-types/pagination/Interfaces.d.ts +8 -0
  85. package/dist-types/pagination/ListDomainsPaginator.d.ts +7 -0
  86. package/dist-types/pagination/ListSubscriptionsPaginator.d.ts +7 -0
  87. package/dist-types/pagination/index.d.ts +3 -0
  88. package/dist-types/runtimeConfig.browser.d.ts +57 -0
  89. package/dist-types/runtimeConfig.d.ts +57 -0
  90. package/dist-types/runtimeConfig.native.d.ts +56 -0
  91. package/dist-types/runtimeConfig.shared.d.ts +27 -0
  92. package/dist-types/runtimeExtensions.d.ts +17 -0
  93. package/dist-types/schemas/schemas_0.d.ts +100 -0
  94. package/dist-types/ts3.4/ConnectHealth.d.ts +304 -0
  95. package/dist-types/ts3.4/ConnectHealthClient.d.ts +232 -0
  96. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  97. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
  98. package/dist-types/ts3.4/commands/ActivateSubscriptionCommand.d.ts +51 -0
  99. package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +47 -0
  100. package/dist-types/ts3.4/commands/CreateSubscriptionCommand.d.ts +51 -0
  101. package/dist-types/ts3.4/commands/DeactivateSubscriptionCommand.d.ts +51 -0
  102. package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +47 -0
  103. package/dist-types/ts3.4/commands/GetDomainCommand.d.ts +47 -0
  104. package/dist-types/ts3.4/commands/GetMedicalScribeListeningSessionCommand.d.ts +51 -0
  105. package/dist-types/ts3.4/commands/GetPatientInsightsJobCommand.d.ts +51 -0
  106. package/dist-types/ts3.4/commands/GetSubscriptionCommand.d.ts +50 -0
  107. package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +47 -0
  108. package/dist-types/ts3.4/commands/ListSubscriptionsCommand.d.ts +50 -0
  109. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  110. package/dist-types/ts3.4/commands/StartMedicalScribeListeningSessionCommand.d.ts +51 -0
  111. package/dist-types/ts3.4/commands/StartPatientInsightsJobCommand.d.ts +51 -0
  112. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
  113. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
  114. package/dist-types/ts3.4/commands/index.d.ts +16 -0
  115. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
  116. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  117. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  118. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  119. package/dist-types/ts3.4/index.d.ts +12 -0
  120. package/dist-types/ts3.4/models/ConnectHealthServiceException.d.ts +9 -0
  121. package/dist-types/ts3.4/models/enums.d.ts +102 -0
  122. package/dist-types/ts3.4/models/errors.d.ts +53 -0
  123. package/dist-types/ts3.4/models/models_0.d.ts +470 -0
  124. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  125. package/dist-types/ts3.4/pagination/ListDomainsPaginator.d.ts +11 -0
  126. package/dist-types/ts3.4/pagination/ListSubscriptionsPaginator.d.ts +11 -0
  127. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  128. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +101 -0
  129. package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
  130. package/dist-types/ts3.4/runtimeConfig.native.d.ts +105 -0
  131. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
  132. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  133. package/dist-types/ts3.4/schemas/schemas_0.d.ts +100 -0
  134. package/package.json +105 -0
@@ -0,0 +1,1519 @@
1
+ import { CustomTemplateBase, DomainStatus, EncryptionType, InsightsType, JobStatus, ManagedNoteTemplate, MedicalScribeLanguageCode, MedicalScribeMediaEncoding, MedicalScribeParticipantRole, MedicalScribeSessionControlEventType, MedicalScribeStreamStatus, PostStreamArtifactGenerationStatus, Pronouns, ProviderRole, Specialty, SubscriptionStatus } from "./enums";
2
+ import { InternalServerException, ValidationException } from "./errors";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface ActivateSubscriptionInput {
7
+ /**
8
+ * <p>The unique identifier of the parent Domain.</p>
9
+ * @public
10
+ */
11
+ domainId: string | undefined;
12
+ /**
13
+ * <p>The unique identifier of the Subscription.</p>
14
+ * @public
15
+ */
16
+ subscriptionId: string | undefined;
17
+ }
18
+ /**
19
+ * <p>Complete subscription resource data.</p>
20
+ * @public
21
+ */
22
+ export interface SubscriptionDescription {
23
+ /**
24
+ * <p/>
25
+ * @public
26
+ */
27
+ domainId: string | undefined;
28
+ /**
29
+ * <p/>
30
+ * @public
31
+ */
32
+ subscriptionId: string | undefined;
33
+ /**
34
+ * <p/>
35
+ * @public
36
+ */
37
+ arn: string | undefined;
38
+ /**
39
+ * <p/>
40
+ * @public
41
+ */
42
+ status: SubscriptionStatus | undefined;
43
+ /**
44
+ * <p/>
45
+ * @public
46
+ */
47
+ createdAt: Date | undefined;
48
+ /**
49
+ * <p/>
50
+ * @public
51
+ */
52
+ lastUpdatedAt: Date | undefined;
53
+ /**
54
+ * <p/>
55
+ * @public
56
+ */
57
+ activatedAt?: Date | undefined;
58
+ /**
59
+ * <p/>
60
+ * @public
61
+ */
62
+ deactivatedAt?: Date | undefined;
63
+ }
64
+ /**
65
+ * @public
66
+ */
67
+ export interface ActivateSubscriptionOutput {
68
+ /**
69
+ * <p/>
70
+ * @public
71
+ */
72
+ subscription?: SubscriptionDescription | undefined;
73
+ }
74
+ /**
75
+ * <p>Details about a generated artifact including location and status</p>
76
+ * @public
77
+ */
78
+ export interface ArtifactDetails {
79
+ /**
80
+ * <p/>
81
+ * @public
82
+ */
83
+ outputLocation?: string | undefined;
84
+ /**
85
+ * <p>The generation status of the artifact</p>
86
+ * @public
87
+ */
88
+ status?: PostStreamArtifactGenerationStatus | undefined;
89
+ /**
90
+ * <p>The reason for failure if the artifact generation failed</p>
91
+ * @public
92
+ */
93
+ failureReason?: string | undefined;
94
+ }
95
+ /**
96
+ * <p>Results of clinical note generation including note, transcript, and summary</p>
97
+ * @public
98
+ */
99
+ export interface ClinicalNoteGenerationResult {
100
+ /**
101
+ * <p>Details about the generated clinical note</p>
102
+ * @public
103
+ */
104
+ noteResult?: ArtifactDetails | undefined;
105
+ /**
106
+ * <p>Details about the generated transcript</p>
107
+ * @public
108
+ */
109
+ transcriptResult?: ArtifactDetails | undefined;
110
+ /**
111
+ * <p>Details about the generated after visit summary</p>
112
+ * @public
113
+ */
114
+ afterVisitSummaryResult?: ArtifactDetails | undefined;
115
+ }
116
+ /**
117
+ * <p>Instructions for generating a specific section of a clinical note</p>
118
+ * @public
119
+ */
120
+ export interface TemplateSectionInstruction {
121
+ /**
122
+ * <p>The header for this section of the template</p>
123
+ * @public
124
+ */
125
+ sectionHeader: string | undefined;
126
+ /**
127
+ * <p>The instruction for generating this section</p>
128
+ * @public
129
+ */
130
+ sectionInstruction: string | undefined;
131
+ }
132
+ /**
133
+ * <p>Configuration for using a custom note template with specific instructions</p>
134
+ * @public
135
+ */
136
+ export interface CustomTemplate {
137
+ /**
138
+ * <p>The base template type to customize</p>
139
+ * @public
140
+ */
141
+ templateType: CustomTemplateBase | undefined;
142
+ /**
143
+ * <p>Custom instructions for each section of the template</p>
144
+ * @public
145
+ */
146
+ templateInstructions: TemplateSectionInstruction[] | undefined;
147
+ }
148
+ /**
149
+ * <p>Configuration for using a managed note template</p>
150
+ * @public
151
+ */
152
+ export interface ManagedTemplate {
153
+ /**
154
+ * <p>The type of managed template to use</p>
155
+ * @public
156
+ */
157
+ templateType: ManagedNoteTemplate | undefined;
158
+ }
159
+ /**
160
+ * <p>Settings for the note template to use for clinical note generation</p>
161
+ * @public
162
+ */
163
+ export type NoteTemplateSettings = NoteTemplateSettings.CustomTemplateMember | NoteTemplateSettings.ManagedTemplateMember | NoteTemplateSettings.$UnknownMember;
164
+ /**
165
+ * @public
166
+ */
167
+ export declare namespace NoteTemplateSettings {
168
+ /**
169
+ * <p/>
170
+ * @public
171
+ */
172
+ interface ManagedTemplateMember {
173
+ managedTemplate: ManagedTemplate;
174
+ customTemplate?: never;
175
+ $unknown?: never;
176
+ }
177
+ /**
178
+ * <p/>
179
+ * @public
180
+ */
181
+ interface CustomTemplateMember {
182
+ managedTemplate?: never;
183
+ customTemplate: CustomTemplate;
184
+ $unknown?: never;
185
+ }
186
+ /**
187
+ * @public
188
+ */
189
+ interface $UnknownMember {
190
+ managedTemplate?: never;
191
+ customTemplate?: never;
192
+ $unknown: [string, any];
193
+ }
194
+ /**
195
+ * @deprecated unused in schema-serde mode.
196
+ *
197
+ */
198
+ interface Visitor<T> {
199
+ managedTemplate: (value: ManagedTemplate) => T;
200
+ customTemplate: (value: CustomTemplate) => T;
201
+ _: (name: string, value: any) => T;
202
+ }
203
+ }
204
+ /**
205
+ * <p>Settings for generating clinical notes from the audio stream</p>
206
+ * @public
207
+ */
208
+ export interface ClinicalNoteGenerationSettings {
209
+ /**
210
+ * <p>Settings for the note template to use</p>
211
+ * @public
212
+ */
213
+ noteTemplateSettings: NoteTemplateSettings | undefined;
214
+ }
215
+ /**
216
+ * <p>Response containing custom template information</p>
217
+ * @public
218
+ */
219
+ export interface CustomTemplateResponse {
220
+ /**
221
+ * <p>The base template type that was customized</p>
222
+ * @public
223
+ */
224
+ templateType?: CustomTemplateBase | undefined;
225
+ }
226
+ /**
227
+ * <p>Response containing managed template information</p>
228
+ * @public
229
+ */
230
+ export interface ManagedTemplateResponse {
231
+ /**
232
+ * <p>The type of managed template used</p>
233
+ * @public
234
+ */
235
+ templateType?: ManagedNoteTemplate | undefined;
236
+ }
237
+ /**
238
+ * <p>Response containing note template settings</p>
239
+ * @public
240
+ */
241
+ export type NoteTemplateSettingsResponse = NoteTemplateSettingsResponse.CustomTemplateMember | NoteTemplateSettingsResponse.ManagedTemplateMember | NoteTemplateSettingsResponse.$UnknownMember;
242
+ /**
243
+ * @public
244
+ */
245
+ export declare namespace NoteTemplateSettingsResponse {
246
+ /**
247
+ * <p/>
248
+ * @public
249
+ */
250
+ interface ManagedTemplateMember {
251
+ managedTemplate: ManagedTemplateResponse;
252
+ customTemplate?: never;
253
+ $unknown?: never;
254
+ }
255
+ /**
256
+ * <p/>
257
+ * @public
258
+ */
259
+ interface CustomTemplateMember {
260
+ managedTemplate?: never;
261
+ customTemplate: CustomTemplateResponse;
262
+ $unknown?: never;
263
+ }
264
+ /**
265
+ * @public
266
+ */
267
+ interface $UnknownMember {
268
+ managedTemplate?: never;
269
+ customTemplate?: never;
270
+ $unknown: [string, any];
271
+ }
272
+ /**
273
+ * @deprecated unused in schema-serde mode.
274
+ *
275
+ */
276
+ interface Visitor<T> {
277
+ managedTemplate: (value: ManagedTemplateResponse) => T;
278
+ customTemplate: (value: CustomTemplateResponse) => T;
279
+ _: (name: string, value: any) => T;
280
+ }
281
+ }
282
+ /**
283
+ * <p>Response containing settings for clinical note generation</p>
284
+ * @public
285
+ */
286
+ export interface ClinicalNoteGenerationSettingsResponse {
287
+ /**
288
+ * <p>Settings for the note template used</p>
289
+ * @public
290
+ */
291
+ noteTemplateSettings?: NoteTemplateSettingsResponse | undefined;
292
+ }
293
+ /**
294
+ * <p>Input configuration for creating a Pulse web application. Used only in CreateDomain operation input.</p>
295
+ * @public
296
+ */
297
+ export interface CreateWebAppConfiguration {
298
+ /**
299
+ * <p>ARN of the IAM role used for EHR operations.</p>
300
+ * @public
301
+ */
302
+ ehrRole: string | undefined;
303
+ /**
304
+ * <p>The Identity Center instance ID to use for creating the application.</p>
305
+ * @public
306
+ */
307
+ idcInstanceId: string | undefined;
308
+ /**
309
+ * <p>The AWS region where Identity Center is configured.</p>
310
+ * @public
311
+ */
312
+ idcRegion: string | undefined;
313
+ }
314
+ /**
315
+ * @public
316
+ */
317
+ export interface CreateDomainInput {
318
+ /**
319
+ * <p>The name for the new Domain.</p>
320
+ * @public
321
+ */
322
+ name: string | undefined;
323
+ /**
324
+ * <p>The ARN of the KMS key to use for encrypting data in this Domain.</p>
325
+ * @public
326
+ */
327
+ kmsKeyArn?: string | undefined;
328
+ /**
329
+ * <p>Configuration for the Domain web application. Optional, but if provided all fields are required.</p>
330
+ * @public
331
+ */
332
+ webAppSetupConfiguration?: CreateWebAppConfiguration | undefined;
333
+ /**
334
+ * <p>Tags to associate with the Domain.</p>
335
+ * @public
336
+ */
337
+ tags?: Record<string, string> | undefined;
338
+ }
339
+ /**
340
+ * <p>Encryption context for a Domain.</p>
341
+ * @public
342
+ */
343
+ export interface EncryptionContext {
344
+ /**
345
+ * <p>The type of encryption key used.</p>
346
+ * @public
347
+ */
348
+ encryptionType: EncryptionType | undefined;
349
+ /**
350
+ * <p>The ARN of the KMS key. Only present when encryptionType is CUSTOMER_MANAGED_KEY.</p>
351
+ * @public
352
+ */
353
+ kmsKeyArn?: string | undefined;
354
+ }
355
+ /**
356
+ * <p>Configuration for the Domain web application, including Identity Center settings. If provided, all fields are required.</p>
357
+ * @public
358
+ */
359
+ export interface WebAppConfiguration {
360
+ /**
361
+ * <p>ARN of the IAM role used for EHR operations.</p>
362
+ * @public
363
+ */
364
+ ehrRole: string | undefined;
365
+ /**
366
+ * <p>The Identity Center application ID associated with this Domain.</p>
367
+ * @public
368
+ */
369
+ idcApplicationId: string | undefined;
370
+ /**
371
+ * <p>The AWS region where Identity Center is configured.</p>
372
+ * @public
373
+ */
374
+ idcRegion: string | undefined;
375
+ }
376
+ /**
377
+ * @public
378
+ */
379
+ export interface CreateDomainOutput {
380
+ /**
381
+ * <p/>
382
+ * @public
383
+ */
384
+ domainId: string | undefined;
385
+ /**
386
+ * <p/>
387
+ * @public
388
+ */
389
+ arn: string | undefined;
390
+ /**
391
+ * <p/>
392
+ * @public
393
+ */
394
+ name: string | undefined;
395
+ /**
396
+ * <p/>
397
+ * @public
398
+ */
399
+ kmsKeyArn?: string | undefined;
400
+ /**
401
+ * <p/>
402
+ * @public
403
+ */
404
+ encryptionContext?: EncryptionContext | undefined;
405
+ /**
406
+ * <p/>
407
+ * @public
408
+ */
409
+ status: DomainStatus | undefined;
410
+ /**
411
+ * <p/>
412
+ * @public
413
+ */
414
+ webAppUrl?: string | undefined;
415
+ /**
416
+ * <p/>
417
+ * @public
418
+ */
419
+ webAppConfiguration?: WebAppConfiguration | undefined;
420
+ /**
421
+ * <p/>
422
+ * @public
423
+ */
424
+ createdAt: Date | undefined;
425
+ }
426
+ /**
427
+ * @public
428
+ */
429
+ export interface CreateSubscriptionInput {
430
+ /**
431
+ * <p>The unique identifier of the parent Domain.</p>
432
+ * @public
433
+ */
434
+ domainId: string | undefined;
435
+ }
436
+ /**
437
+ * @public
438
+ */
439
+ export interface CreateSubscriptionOutput {
440
+ /**
441
+ * <p/>
442
+ * @public
443
+ */
444
+ domainId: string | undefined;
445
+ /**
446
+ * <p/>
447
+ * @public
448
+ */
449
+ subscriptionId: string | undefined;
450
+ /**
451
+ * <p/>
452
+ * @public
453
+ */
454
+ arn: string | undefined;
455
+ /**
456
+ * <p/>
457
+ * @public
458
+ */
459
+ status: SubscriptionStatus | undefined;
460
+ /**
461
+ * <p/>
462
+ * @public
463
+ */
464
+ createdAt: Date | undefined;
465
+ /**
466
+ * <p/>
467
+ * @public
468
+ */
469
+ lastUpdatedAt: Date | undefined;
470
+ /**
471
+ * <p/>
472
+ * @public
473
+ */
474
+ activatedAt?: Date | undefined;
475
+ /**
476
+ * <p/>
477
+ * @public
478
+ */
479
+ deactivatedAt?: Date | undefined;
480
+ }
481
+ /**
482
+ * @public
483
+ */
484
+ export interface DeactivateSubscriptionInput {
485
+ /**
486
+ * <p>The unique identifier of the parent Domain.</p>
487
+ * @public
488
+ */
489
+ domainId: string | undefined;
490
+ /**
491
+ * <p>The unique identifier of the Subscription.</p>
492
+ * @public
493
+ */
494
+ subscriptionId: string | undefined;
495
+ }
496
+ /**
497
+ * @public
498
+ */
499
+ export interface DeactivateSubscriptionOutput {
500
+ /**
501
+ * <p/>
502
+ * @public
503
+ */
504
+ subscription?: SubscriptionDescription | undefined;
505
+ }
506
+ /**
507
+ * @public
508
+ */
509
+ export interface DeleteDomainInput {
510
+ /**
511
+ * <p>The id of the Domain to delete</p>
512
+ * @public
513
+ */
514
+ domainId: string | undefined;
515
+ }
516
+ /**
517
+ * @public
518
+ */
519
+ export interface DeleteDomainOutput {
520
+ /**
521
+ * <p>The id of the Domain requested for deletion</p>
522
+ * @public
523
+ */
524
+ domainId: string | undefined;
525
+ /**
526
+ * <p>The ARN of the Domain that was requested for deletion</p>
527
+ * @public
528
+ */
529
+ arn: string | undefined;
530
+ /**
531
+ * <p>Current status of Domain</p>
532
+ * @public
533
+ */
534
+ status: DomainStatus | undefined;
535
+ }
536
+ /**
537
+ * @public
538
+ */
539
+ export interface GetDomainInput {
540
+ /**
541
+ * <p>The id of the Domain to get</p>
542
+ * @public
543
+ */
544
+ domainId: string | undefined;
545
+ }
546
+ /**
547
+ * @public
548
+ */
549
+ export interface GetDomainOutput {
550
+ /**
551
+ * <p/>
552
+ * @public
553
+ */
554
+ domainId: string | undefined;
555
+ /**
556
+ * <p/>
557
+ * @public
558
+ */
559
+ arn: string | undefined;
560
+ /**
561
+ * <p/>
562
+ * @public
563
+ */
564
+ name: string | undefined;
565
+ /**
566
+ * <p/>
567
+ * @public
568
+ */
569
+ kmsKeyArn?: string | undefined;
570
+ /**
571
+ * <p/>
572
+ * @public
573
+ */
574
+ encryptionContext?: EncryptionContext | undefined;
575
+ /**
576
+ * <p/>
577
+ * @public
578
+ */
579
+ status: DomainStatus | undefined;
580
+ /**
581
+ * <p/>
582
+ * @public
583
+ */
584
+ webAppUrl?: string | undefined;
585
+ /**
586
+ * <p/>
587
+ * @public
588
+ */
589
+ webAppConfiguration?: WebAppConfiguration | undefined;
590
+ /**
591
+ * <p/>
592
+ * @public
593
+ */
594
+ createdAt: Date | undefined;
595
+ /**
596
+ * <p>Tags associated with the Domain</p>
597
+ * @public
598
+ */
599
+ tags?: Record<string, string> | undefined;
600
+ }
601
+ /**
602
+ * @public
603
+ */
604
+ export interface GetMedicalScribeListeningSessionInput {
605
+ /**
606
+ * <p>The Session identifier</p>
607
+ * @public
608
+ */
609
+ sessionId: string | undefined;
610
+ /**
611
+ * <p>The Domain identifier</p>
612
+ * @public
613
+ */
614
+ domainId: string | undefined;
615
+ /**
616
+ * <p>The Subscription identifier</p>
617
+ * @public
618
+ */
619
+ subscriptionId: string | undefined;
620
+ }
621
+ /**
622
+ * <p>Defines a channel in the audio stream</p>
623
+ * @public
624
+ */
625
+ export interface MedicalScribeChannelDefinition {
626
+ /**
627
+ * <p>The channel identifier</p>
628
+ * @public
629
+ */
630
+ channelId: number | undefined;
631
+ /**
632
+ * <p>The role of the participant on this channel</p>
633
+ * @public
634
+ */
635
+ participantRole: MedicalScribeParticipantRole | undefined;
636
+ }
637
+ /**
638
+ * <p>Results of post-stream actions performed after the audio stream ended</p>
639
+ * @public
640
+ */
641
+ export interface MedicalScribePostStreamActionsResult {
642
+ /**
643
+ * <p>Results of clinical note generation</p>
644
+ * @public
645
+ */
646
+ clinicalNoteGenerationResult?: ClinicalNoteGenerationResult | undefined;
647
+ }
648
+ /**
649
+ * <p>Response containing settings for post-stream actions</p>
650
+ * @public
651
+ */
652
+ export interface MedicalScribePostStreamActionSettingsResponse {
653
+ /**
654
+ * <p/>
655
+ * @public
656
+ */
657
+ outputS3Uri: string | undefined;
658
+ /**
659
+ * <p>Settings for clinical note generation</p>
660
+ * @public
661
+ */
662
+ clinicalNoteGenerationSettings: ClinicalNoteGenerationSettingsResponse | undefined;
663
+ }
664
+ /**
665
+ * <p>Detailed information about a Medical Scribe listening session</p>
666
+ * @public
667
+ */
668
+ export interface MedicalScribeListeningSessionDetails {
669
+ /**
670
+ * <p>The Session identifier</p>
671
+ * @public
672
+ */
673
+ sessionId?: string | undefined;
674
+ /**
675
+ * <p>The Domain identifier</p>
676
+ * @public
677
+ */
678
+ domainId?: string | undefined;
679
+ /**
680
+ * <p>The Subscription identifier</p>
681
+ * @public
682
+ */
683
+ subscriptionId?: string | undefined;
684
+ /**
685
+ * <p>The Language Code for the audio in the session</p>
686
+ * @public
687
+ */
688
+ languageCode?: MedicalScribeLanguageCode | undefined;
689
+ /**
690
+ * <p>The sample rate of the input audio</p>
691
+ * @public
692
+ */
693
+ mediaSampleRateHertz?: number | undefined;
694
+ /**
695
+ * <p>The encoding for the input audio</p>
696
+ * @public
697
+ */
698
+ mediaEncoding?: MedicalScribeMediaEncoding | undefined;
699
+ /**
700
+ * <p>Channel definitions for the audio stream</p>
701
+ * @public
702
+ */
703
+ channelDefinitions?: MedicalScribeChannelDefinition[] | undefined;
704
+ /**
705
+ * <p>Settings for post-stream actions</p>
706
+ * @public
707
+ */
708
+ postStreamActionSettings?: MedicalScribePostStreamActionSettingsResponse | undefined;
709
+ /**
710
+ * <p>Results of post-stream actions</p>
711
+ * @public
712
+ */
713
+ postStreamActionResult?: MedicalScribePostStreamActionsResult | undefined;
714
+ /**
715
+ * <p>Indicates whether encounter context was provided</p>
716
+ * @public
717
+ */
718
+ encounterContextProvided?: boolean | undefined;
719
+ /**
720
+ * <p>The current status of the stream</p>
721
+ * @public
722
+ */
723
+ streamStatus?: MedicalScribeStreamStatus | undefined;
724
+ /**
725
+ * <p>The timestamp when the stream was created</p>
726
+ * @public
727
+ */
728
+ streamCreationTime?: Date | undefined;
729
+ /**
730
+ * <p>The timestamp when the stream ended</p>
731
+ * @public
732
+ */
733
+ streamEndTime?: Date | undefined;
734
+ }
735
+ /**
736
+ * @public
737
+ */
738
+ export interface GetMedicalScribeListeningSessionOutput {
739
+ /**
740
+ * <p>Details about the Medical Scribe listening session</p>
741
+ * @public
742
+ */
743
+ medicalScribeListeningSessionDetails?: MedicalScribeListeningSessionDetails | undefined;
744
+ }
745
+ /**
746
+ * @public
747
+ */
748
+ export interface GetPatientInsightsJobRequest {
749
+ /**
750
+ * <p/>
751
+ * @public
752
+ */
753
+ domainId: string | undefined;
754
+ /**
755
+ * <p/>
756
+ * @public
757
+ */
758
+ jobId: string | undefined;
759
+ }
760
+ /**
761
+ * <p>Details for an encounter</p>
762
+ * @public
763
+ */
764
+ export interface PatientInsightsEncounterContext {
765
+ /**
766
+ * <p>Chief complaint for the visit</p>
767
+ * @public
768
+ */
769
+ encounterReason: string | undefined;
770
+ }
771
+ /**
772
+ * <p>FHIR server configuration for input data source</p>
773
+ * @public
774
+ */
775
+ export interface FHIRServer {
776
+ /**
777
+ * <p>FHIR server endpoint URL for accessing patient data.</p>
778
+ * @public
779
+ */
780
+ fhirEndpoint: string | undefined;
781
+ /**
782
+ * <p>OAuth token for authenticating with the FHIR server.</p>
783
+ * @public
784
+ */
785
+ oauthToken?: string | undefined;
786
+ }
787
+ /**
788
+ * <p>S3 uri for input data source</p>
789
+ * @public
790
+ */
791
+ export interface S3Source {
792
+ /**
793
+ * <p>The S3 URI.</p>
794
+ * @public
795
+ */
796
+ uri: string | undefined;
797
+ }
798
+ /**
799
+ * <p>Configuration details for input patient data</p>
800
+ * @public
801
+ */
802
+ export interface InputDataConfig {
803
+ /**
804
+ * <p>FHIR server configuration to retrieve patient data.</p>
805
+ * @public
806
+ */
807
+ fhirServer?: FHIRServer | undefined;
808
+ /**
809
+ * <p>List of S3 sources containing patient data.</p>
810
+ * @public
811
+ */
812
+ s3Sources?: S3Source[] | undefined;
813
+ }
814
+ /**
815
+ * <p>Details for insights that user wants to generate</p>
816
+ * @public
817
+ */
818
+ export interface InsightsContext {
819
+ /**
820
+ * <p/>
821
+ * @public
822
+ */
823
+ insightsType: InsightsType | undefined;
824
+ }
825
+ /**
826
+ * <p>Output of patient insights job</p>
827
+ * @public
828
+ */
829
+ export interface InsightsOutput {
830
+ /**
831
+ * <p/>
832
+ * @public
833
+ */
834
+ uri: string | undefined;
835
+ }
836
+ /**
837
+ * <p>Configuration details for insights output.</p>
838
+ * @public
839
+ */
840
+ export interface OutputDataConfig {
841
+ /**
842
+ * <p>S3 URI where the insights output will be stored.</p>
843
+ * @public
844
+ */
845
+ s3OutputPath: string | undefined;
846
+ }
847
+ /**
848
+ * <p>Details for a patient</p>
849
+ * @public
850
+ */
851
+ export interface PatientInsightsPatientContext {
852
+ /**
853
+ * <p>Unique identifier of the patient</p>
854
+ * @public
855
+ */
856
+ patientId: string | undefined;
857
+ /**
858
+ * <p>Date of birth of the patient.</p>
859
+ * @public
860
+ */
861
+ dateOfBirth?: string | undefined;
862
+ /**
863
+ * <p>Pronouns preferred by the patient.</p>
864
+ * @public
865
+ */
866
+ pronouns?: Pronouns | undefined;
867
+ }
868
+ /**
869
+ * <p>Details for user initiating insights job</p>
870
+ * @public
871
+ */
872
+ export interface UserContext {
873
+ /**
874
+ * <p/>
875
+ * @public
876
+ */
877
+ role: ProviderRole | undefined;
878
+ /**
879
+ * <p>Unique identifier of the user</p>
880
+ * @public
881
+ */
882
+ userId: string | undefined;
883
+ /**
884
+ * <p/>
885
+ * @public
886
+ */
887
+ specialty?: Specialty | undefined;
888
+ }
889
+ /**
890
+ * @public
891
+ */
892
+ export interface GetPatientInsightsJobResponse {
893
+ /**
894
+ * <p/>
895
+ * @public
896
+ */
897
+ jobId: string | undefined;
898
+ /**
899
+ * <p/>
900
+ * @public
901
+ */
902
+ jobArn: string | undefined;
903
+ /**
904
+ * <p/>
905
+ * @public
906
+ */
907
+ jobStatus: JobStatus | undefined;
908
+ /**
909
+ * <p>Date and time the patient insights job was submitted.</p>
910
+ * @public
911
+ */
912
+ creationTime?: Date | undefined;
913
+ /**
914
+ * <p>Date and time the patient insights job was last updated.</p>
915
+ * @public
916
+ */
917
+ updatedTime?: Date | undefined;
918
+ /**
919
+ * <p/>
920
+ * @public
921
+ */
922
+ insightsOutput?: InsightsOutput | undefined;
923
+ /**
924
+ * <p>Contains information about the status of a job.</p>
925
+ * @public
926
+ */
927
+ statusDetails?: string | undefined;
928
+ /**
929
+ * <p/>
930
+ * @public
931
+ */
932
+ patientContext: PatientInsightsPatientContext | undefined;
933
+ /**
934
+ * <p/>
935
+ * @public
936
+ */
937
+ insightsContext: InsightsContext | undefined;
938
+ /**
939
+ * <p/>
940
+ * @public
941
+ */
942
+ encounterContext: PatientInsightsEncounterContext | undefined;
943
+ /**
944
+ * <p/>
945
+ * @public
946
+ */
947
+ userContext: UserContext | undefined;
948
+ /**
949
+ * <p/>
950
+ * @public
951
+ */
952
+ inputDataConfig: InputDataConfig | undefined;
953
+ /**
954
+ * <p/>
955
+ * @public
956
+ */
957
+ outputDataConfig: OutputDataConfig | undefined;
958
+ }
959
+ /**
960
+ * @public
961
+ */
962
+ export interface GetSubscriptionInput {
963
+ /**
964
+ * <p>The unique identifier of the parent Domain.</p>
965
+ * @public
966
+ */
967
+ domainId: string | undefined;
968
+ /**
969
+ * <p>The unique identifier of the Subscription.</p>
970
+ * @public
971
+ */
972
+ subscriptionId: string | undefined;
973
+ }
974
+ /**
975
+ * @public
976
+ */
977
+ export interface GetSubscriptionOutput {
978
+ /**
979
+ * <p/>
980
+ * @public
981
+ */
982
+ subscription?: SubscriptionDescription | undefined;
983
+ }
984
+ /**
985
+ * @public
986
+ */
987
+ export interface ListDomainsInput {
988
+ /**
989
+ * <p>Filter by Domain status.</p>
990
+ * @public
991
+ */
992
+ status?: DomainStatus | undefined;
993
+ /**
994
+ * <p>Maximum number of results to return.</p>
995
+ * @public
996
+ */
997
+ maxResults?: number | undefined;
998
+ /**
999
+ * <p>Token for pagination.</p>
1000
+ * @public
1001
+ */
1002
+ nextToken?: string | undefined;
1003
+ }
1004
+ /**
1005
+ * <p>Summary information about a Domain.</p>
1006
+ * @public
1007
+ */
1008
+ export interface DomainSummary {
1009
+ /**
1010
+ * <p>The unique identifier of the Domain.</p>
1011
+ * @public
1012
+ */
1013
+ domainId: string | undefined;
1014
+ /**
1015
+ * <p/>
1016
+ * @public
1017
+ */
1018
+ arn: string | undefined;
1019
+ /**
1020
+ * <p/>
1021
+ * @public
1022
+ */
1023
+ name: string | undefined;
1024
+ /**
1025
+ * <p/>
1026
+ * @public
1027
+ */
1028
+ status: DomainStatus | undefined;
1029
+ /**
1030
+ * <p>The timestamp when the Domain was created.</p>
1031
+ * @public
1032
+ */
1033
+ createdAt: Date | undefined;
1034
+ }
1035
+ /**
1036
+ * @public
1037
+ */
1038
+ export interface ListDomainsOutput {
1039
+ /**
1040
+ * <p>List of Domains.</p>
1041
+ * @public
1042
+ */
1043
+ domains: DomainSummary[] | undefined;
1044
+ /**
1045
+ * <p>Token for the next page of results.</p>
1046
+ * @public
1047
+ */
1048
+ nextToken?: string | undefined;
1049
+ }
1050
+ /**
1051
+ * @public
1052
+ */
1053
+ export interface ListSubscriptionsInput {
1054
+ /**
1055
+ * <p>The unique identifier of the parent Domain.</p>
1056
+ * @public
1057
+ */
1058
+ domainId: string | undefined;
1059
+ /**
1060
+ * <p>Maximum number of results to return.</p>
1061
+ * @public
1062
+ */
1063
+ maxResults?: number | undefined;
1064
+ /**
1065
+ * <p>Token for pagination.</p>
1066
+ * @public
1067
+ */
1068
+ nextToken?: string | undefined;
1069
+ }
1070
+ /**
1071
+ * @public
1072
+ */
1073
+ export interface ListSubscriptionsOutput {
1074
+ /**
1075
+ * <p>List of Subscriptions.</p>
1076
+ * @public
1077
+ */
1078
+ subscriptions: SubscriptionDescription[] | undefined;
1079
+ /**
1080
+ * <p>Token for the next page of results.</p>
1081
+ * @public
1082
+ */
1083
+ nextToken?: string | undefined;
1084
+ }
1085
+ /**
1086
+ * @public
1087
+ */
1088
+ export interface ListTagsForResourceInput {
1089
+ /**
1090
+ * <p>The ARN of the resource to list tags for</p>
1091
+ * @public
1092
+ */
1093
+ resourceArn: string | undefined;
1094
+ }
1095
+ /**
1096
+ * @public
1097
+ */
1098
+ export interface ListTagsForResourceOutput {
1099
+ /**
1100
+ * <p>The tags associated with the resource</p>
1101
+ * @public
1102
+ */
1103
+ tags?: Record<string, string> | undefined;
1104
+ }
1105
+ /**
1106
+ * <p>An event containing audio data for the Medical Scribe stream</p>
1107
+ * @public
1108
+ */
1109
+ export interface MedicalScribeAudioEvent {
1110
+ /**
1111
+ * <p>The audio data chunk</p>
1112
+ * @public
1113
+ */
1114
+ audioChunk: Uint8Array | undefined;
1115
+ }
1116
+ /**
1117
+ * <p>Context information about the clinical encounter</p>
1118
+ * @public
1119
+ */
1120
+ export interface EncounterContext {
1121
+ /**
1122
+ * <p>Unstructured context information in markdown format</p>
1123
+ * @public
1124
+ */
1125
+ unstructuredContext?: string | undefined;
1126
+ }
1127
+ /**
1128
+ * <p>Settings for actions to perform after the audio stream ends</p>
1129
+ * @public
1130
+ */
1131
+ export interface MedicalScribePostStreamActionSettings {
1132
+ /**
1133
+ * <p/>
1134
+ * @public
1135
+ */
1136
+ outputS3Uri: string | undefined;
1137
+ /**
1138
+ * <p>Settings for clinical note generation</p>
1139
+ * @public
1140
+ */
1141
+ clinicalNoteGenerationSettings: ClinicalNoteGenerationSettings | undefined;
1142
+ }
1143
+ /**
1144
+ * <p>An event containing configuration for the Medical Scribe session</p>
1145
+ * @public
1146
+ */
1147
+ export interface MedicalScribeConfigurationEvent {
1148
+ /**
1149
+ * <p>Settings for actions to perform after the stream ends</p>
1150
+ * @public
1151
+ */
1152
+ postStreamActionSettings: MedicalScribePostStreamActionSettings | undefined;
1153
+ /**
1154
+ * <p>Channel definitions for the audio stream</p>
1155
+ * @public
1156
+ */
1157
+ channelDefinitions?: MedicalScribeChannelDefinition[] | undefined;
1158
+ /**
1159
+ * <p>Context information about the clinical encounter</p>
1160
+ * @public
1161
+ */
1162
+ encounterContext?: EncounterContext | undefined;
1163
+ }
1164
+ /**
1165
+ * <p>An event for controlling the Medical Scribe session</p>
1166
+ * @public
1167
+ */
1168
+ export interface MedicalScribeSessionControlEvent {
1169
+ /**
1170
+ * <p>The type of session control event</p>
1171
+ * @public
1172
+ */
1173
+ type?: MedicalScribeSessionControlEventType | undefined;
1174
+ }
1175
+ /**
1176
+ * <p>Input stream for Medical Scribe containing audio and configuration events</p>
1177
+ * @public
1178
+ */
1179
+ export type MedicalScribeInputStream = MedicalScribeInputStream.AudioEventMember | MedicalScribeInputStream.ConfigurationEventMember | MedicalScribeInputStream.SessionControlEventMember | MedicalScribeInputStream.$UnknownMember;
1180
+ /**
1181
+ * @public
1182
+ */
1183
+ export declare namespace MedicalScribeInputStream {
1184
+ /**
1185
+ * <p/>
1186
+ * @public
1187
+ */
1188
+ interface AudioEventMember {
1189
+ audioEvent: MedicalScribeAudioEvent;
1190
+ sessionControlEvent?: never;
1191
+ configurationEvent?: never;
1192
+ $unknown?: never;
1193
+ }
1194
+ /**
1195
+ * <p/>
1196
+ * @public
1197
+ */
1198
+ interface SessionControlEventMember {
1199
+ audioEvent?: never;
1200
+ sessionControlEvent: MedicalScribeSessionControlEvent;
1201
+ configurationEvent?: never;
1202
+ $unknown?: never;
1203
+ }
1204
+ /**
1205
+ * <p/>
1206
+ * @public
1207
+ */
1208
+ interface ConfigurationEventMember {
1209
+ audioEvent?: never;
1210
+ sessionControlEvent?: never;
1211
+ configurationEvent: MedicalScribeConfigurationEvent;
1212
+ $unknown?: never;
1213
+ }
1214
+ /**
1215
+ * @public
1216
+ */
1217
+ interface $UnknownMember {
1218
+ audioEvent?: never;
1219
+ sessionControlEvent?: never;
1220
+ configurationEvent?: never;
1221
+ $unknown: [string, any];
1222
+ }
1223
+ /**
1224
+ * @deprecated unused in schema-serde mode.
1225
+ *
1226
+ */
1227
+ interface Visitor<T> {
1228
+ audioEvent: (value: MedicalScribeAudioEvent) => T;
1229
+ sessionControlEvent: (value: MedicalScribeSessionControlEvent) => T;
1230
+ configurationEvent: (value: MedicalScribeConfigurationEvent) => T;
1231
+ _: (name: string, value: any) => T;
1232
+ }
1233
+ }
1234
+ /**
1235
+ * @public
1236
+ */
1237
+ export interface StartMedicalScribeListeningSessionInput {
1238
+ /**
1239
+ * <p>The Session identifier</p>
1240
+ * @public
1241
+ */
1242
+ sessionId: string | undefined;
1243
+ /**
1244
+ * <p>The Domain identifier</p>
1245
+ * @public
1246
+ */
1247
+ domainId: string | undefined;
1248
+ /**
1249
+ * <p>The Subscription identifier</p>
1250
+ * @public
1251
+ */
1252
+ subscriptionId: string | undefined;
1253
+ /**
1254
+ * <p>The Language Code for the audio in the session</p>
1255
+ * @public
1256
+ */
1257
+ languageCode: MedicalScribeLanguageCode | undefined;
1258
+ /**
1259
+ * <p>The sample rate of the input audio</p>
1260
+ * @public
1261
+ */
1262
+ mediaSampleRateHertz: number | undefined;
1263
+ /**
1264
+ * <p>The encoding for the input audio</p>
1265
+ * @public
1266
+ */
1267
+ mediaEncoding: MedicalScribeMediaEncoding | undefined;
1268
+ /**
1269
+ * <p/>
1270
+ * @public
1271
+ */
1272
+ inputStream?: AsyncIterable<MedicalScribeInputStream> | undefined;
1273
+ }
1274
+ /**
1275
+ * <p>A segment of transcript text with timing and channel information</p>
1276
+ * @public
1277
+ */
1278
+ export interface MedicalScribeTranscriptSegment {
1279
+ /**
1280
+ * <p>The unique identifier for this segment</p>
1281
+ * @public
1282
+ */
1283
+ segmentId?: string | undefined;
1284
+ /**
1285
+ * <p>The offset from audio start when the audio for this segment begins</p>
1286
+ * @public
1287
+ */
1288
+ audioBeginOffset?: number | undefined;
1289
+ /**
1290
+ * <p>The offset from audio start when the audio for this segment ends</p>
1291
+ * @public
1292
+ */
1293
+ audioEndOffset?: number | undefined;
1294
+ /**
1295
+ * <p>Indicates whether this is a partial or final transcript</p>
1296
+ * @public
1297
+ */
1298
+ isPartial?: boolean | undefined;
1299
+ /**
1300
+ * <p>The channel identifier for this segment</p>
1301
+ * @public
1302
+ */
1303
+ channelId?: string | undefined;
1304
+ /**
1305
+ * <p>The transcript text content</p>
1306
+ * @public
1307
+ */
1308
+ content?: string | undefined;
1309
+ }
1310
+ /**
1311
+ * <p>An event containing transcript data from the Medical Scribe stream</p>
1312
+ * @public
1313
+ */
1314
+ export interface MedicalScribeTranscriptEvent {
1315
+ /**
1316
+ * <p>A segment of the transcript</p>
1317
+ * @public
1318
+ */
1319
+ transcriptSegment?: MedicalScribeTranscriptSegment | undefined;
1320
+ }
1321
+ /**
1322
+ * <p>Output stream from Medical Scribe containing transcript events and errors</p>
1323
+ * @public
1324
+ */
1325
+ export type MedicalScribeOutputStream = MedicalScribeOutputStream.InternalFailureExceptionMember | MedicalScribeOutputStream.TranscriptEventMember | MedicalScribeOutputStream.ValidationExceptionMember | MedicalScribeOutputStream.$UnknownMember;
1326
+ /**
1327
+ * @public
1328
+ */
1329
+ export declare namespace MedicalScribeOutputStream {
1330
+ /**
1331
+ * <p/>
1332
+ * @public
1333
+ */
1334
+ interface TranscriptEventMember {
1335
+ transcriptEvent: MedicalScribeTranscriptEvent;
1336
+ internalFailureException?: never;
1337
+ validationException?: never;
1338
+ $unknown?: never;
1339
+ }
1340
+ /**
1341
+ * <p/>
1342
+ * @public
1343
+ */
1344
+ interface InternalFailureExceptionMember {
1345
+ transcriptEvent?: never;
1346
+ internalFailureException: InternalServerException;
1347
+ validationException?: never;
1348
+ $unknown?: never;
1349
+ }
1350
+ /**
1351
+ * <p/>
1352
+ * @public
1353
+ */
1354
+ interface ValidationExceptionMember {
1355
+ transcriptEvent?: never;
1356
+ internalFailureException?: never;
1357
+ validationException: ValidationException;
1358
+ $unknown?: never;
1359
+ }
1360
+ /**
1361
+ * @public
1362
+ */
1363
+ interface $UnknownMember {
1364
+ transcriptEvent?: never;
1365
+ internalFailureException?: never;
1366
+ validationException?: never;
1367
+ $unknown: [string, any];
1368
+ }
1369
+ /**
1370
+ * @deprecated unused in schema-serde mode.
1371
+ *
1372
+ */
1373
+ interface Visitor<T> {
1374
+ transcriptEvent: (value: MedicalScribeTranscriptEvent) => T;
1375
+ internalFailureException: (value: InternalServerException) => T;
1376
+ validationException: (value: ValidationException) => T;
1377
+ _: (name: string, value: any) => T;
1378
+ }
1379
+ }
1380
+ /**
1381
+ * @public
1382
+ */
1383
+ export interface StartMedicalScribeListeningSessionOutput {
1384
+ /**
1385
+ * <p>The Session identifier</p>
1386
+ * @public
1387
+ */
1388
+ sessionId?: string | undefined;
1389
+ /**
1390
+ * <p>The Domain identifier</p>
1391
+ * @public
1392
+ */
1393
+ domainId?: string | undefined;
1394
+ /**
1395
+ * <p>The Subscription identifier</p>
1396
+ * @public
1397
+ */
1398
+ subscriptionId?: string | undefined;
1399
+ /**
1400
+ * <p>The Request identifier</p>
1401
+ * @public
1402
+ */
1403
+ requestId?: string | undefined;
1404
+ /**
1405
+ * <p>The Language Code for the audio in the session</p>
1406
+ * @public
1407
+ */
1408
+ languageCode?: MedicalScribeLanguageCode | undefined;
1409
+ /**
1410
+ * <p>The sample rate of the input audio</p>
1411
+ * @public
1412
+ */
1413
+ mediaSampleRateHertz?: number | undefined;
1414
+ /**
1415
+ * <p>The encoding for the input audio</p>
1416
+ * @public
1417
+ */
1418
+ mediaEncoding?: MedicalScribeMediaEncoding | undefined;
1419
+ /**
1420
+ * <p>The output stream containing transcript events</p>
1421
+ * @public
1422
+ */
1423
+ responseStream?: AsyncIterable<MedicalScribeOutputStream> | undefined;
1424
+ }
1425
+ /**
1426
+ * @public
1427
+ */
1428
+ export interface StartPatientInsightsJobRequest {
1429
+ /**
1430
+ * <p/>
1431
+ * @public
1432
+ */
1433
+ domainId: string | undefined;
1434
+ /**
1435
+ * <p/>
1436
+ * @public
1437
+ */
1438
+ patientContext: PatientInsightsPatientContext | undefined;
1439
+ /**
1440
+ * <p/>
1441
+ * @public
1442
+ */
1443
+ insightsContext: InsightsContext | undefined;
1444
+ /**
1445
+ * <p/>
1446
+ * @public
1447
+ */
1448
+ encounterContext: PatientInsightsEncounterContext | undefined;
1449
+ /**
1450
+ * <p/>
1451
+ * @public
1452
+ */
1453
+ userContext: UserContext | undefined;
1454
+ /**
1455
+ * <p/>
1456
+ * @public
1457
+ */
1458
+ inputDataConfig: InputDataConfig | undefined;
1459
+ /**
1460
+ * <p/>
1461
+ * @public
1462
+ */
1463
+ outputDataConfig: OutputDataConfig | undefined;
1464
+ /**
1465
+ * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
1466
+ * @public
1467
+ */
1468
+ clientToken?: string | undefined;
1469
+ }
1470
+ /**
1471
+ * @public
1472
+ */
1473
+ export interface StartPatientInsightsJobResponse {
1474
+ /**
1475
+ * <p/>
1476
+ * @public
1477
+ */
1478
+ jobArn: string | undefined;
1479
+ /**
1480
+ * <p/>
1481
+ * @public
1482
+ */
1483
+ jobId: string | undefined;
1484
+ /**
1485
+ * <p>Date and time the patient insights job was submitted.</p>
1486
+ * @public
1487
+ */
1488
+ creationTime?: Date | undefined;
1489
+ }
1490
+ /**
1491
+ * @public
1492
+ */
1493
+ export interface TagResourceInput {
1494
+ /**
1495
+ * <p>The ARN of the resource to tag</p>
1496
+ * @public
1497
+ */
1498
+ resourceArn: string | undefined;
1499
+ /**
1500
+ * <p>The tags to add to the resource</p>
1501
+ * @public
1502
+ */
1503
+ tags: Record<string, string> | undefined;
1504
+ }
1505
+ /**
1506
+ * @public
1507
+ */
1508
+ export interface UntagResourceInput {
1509
+ /**
1510
+ * <p>The ARN of the resource to untag</p>
1511
+ * @public
1512
+ */
1513
+ resourceArn: string | undefined;
1514
+ /**
1515
+ * <p>The tag keys to remove from the resource</p>
1516
+ * @public
1517
+ */
1518
+ tagKeys: string[] | undefined;
1519
+ }