+163
-4
lines changedFilter options
+163
-4
lines changed Original file line number Diff line number Diff line change
@@ -86,6 +86,7 @@ export interface GetMedicalScribeStreamCommandOutput extends GetMedicalScribeStr
86 86
* // FailureReason: "STRING_VALUE",
87 87
* // },
88 88
* // },
89 +
* // MedicalScribeContextProvided: true || false,
89 90
* // },
90 91
* // };
91 92
*
@@ -44,7 +44,7 @@ export interface StartMedicalScribeStreamCommandOutput extends StartMedicalScrib
44 44
* Amazon Web Services HealthScribe
45 45
* and the transcription results are streamed to your application.</p>
46 46
* <p>When you start a stream, you first specify the stream configuration in a <code>MedicalScribeConfigurationEvent</code>.
47 -
* This event includes channel definitions, encryption settings, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional
47 +
* This event includes channel definitions, encryption settings, medical scribe context, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional
48 48
* streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session,
49 49
* your first event must be a <code>MedicalScribeConfigurationEvent</code>. </p>
50 50
* <p>
@@ -121,6 +121,11 @@ export interface StartMedicalScribeStreamCommandOutput extends StartMedicalScrib
121 121
* NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP" || "DAP" || "SIRP" || "BIRP" || "BEHAVIORAL_SOAP" || "PHYSICAL_SOAP",
122 122
* },
123 123
* },
124 +
* MedicalScribeContext: { // MedicalScribeContext
125 +
* PatientContext: { // MedicalScribePatientContext
126 +
* Pronouns: "HE_HIM" || "SHE_HER" || "THEY_THEM",
127 +
* },
128 +
* },
124 129
* },
125 130
* },
126 131
* };
@@ -1,5 +1,5 @@
1 1
// smithy-typescript generated code
2 -
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2 +
import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client";
3 3 4 4
import { TranscribeStreamingServiceException as __BaseException } from "./TranscribeStreamingServiceException";
5 5
@@ -1491,6 +1491,12 @@ export interface MedicalScribeStreamDetails {
1491 1491
* @public
1492 1492
*/
1493 1493
PostStreamAnalyticsResult?: MedicalScribePostStreamAnalyticsResult | undefined;
1494 + 1495 +
/**
1496 +
* <p>Indicates whether the <code>MedicalScribeContext</code> object was provided when the stream was started.</p>
1497 +
* @public
1498 +
*/
1499 +
MedicalScribeContextProvided?: boolean | undefined;
1494 1500
}
1495 1501 1496 1502
/**
@@ -1840,6 +1846,46 @@ export interface MedicalScribeAudioEvent {
1840 1846
AudioChunk: Uint8Array | undefined;
1841 1847
}
1842 1848 1849 +
/**
1850 +
* @public
1851 +
* @enum
1852 +
*/
1853 +
export const Pronouns = {
1854 +
HE_HIM: "HE_HIM",
1855 +
SHE_HER: "SHE_HER",
1856 +
THEY_THEM: "THEY_THEM",
1857 +
} as const;
1858 + 1859 +
/**
1860 +
* @public
1861 +
*/
1862 +
export type Pronouns = (typeof Pronouns)[keyof typeof Pronouns];
1863 + 1864 +
/**
1865 +
* <p>Contains patient-specific information. </p>
1866 +
* @public
1867 +
*/
1868 +
export interface MedicalScribePatientContext {
1869 +
/**
1870 +
* <p>The patient's preferred pronouns that the user wants to provide as a context for clinical note generation .</p>
1871 +
* @public
1872 +
*/
1873 +
Pronouns?: Pronouns | undefined;
1874 +
}
1875 + 1876 +
/**
1877 +
* <p>The <code>MedicalScribeContext</code> object that contains contextual information which is used during clinical note generation
1878 +
* to add relevant context to the note.</p>
1879 +
* @public
1880 +
*/
1881 +
export interface MedicalScribeContext {
1882 +
/**
1883 +
* <p>Contains patient-specific information used to customize the clinical note generation.</p>
1884 +
* @public
1885 +
*/
1886 +
PatientContext?: MedicalScribePatientContext | undefined;
1887 +
}
1888 + 1843 1889
/**
1844 1890
* <p>Specify details to configure the streaming session, including channel definitions, encryption settings, post-stream analytics
1845 1891
* settings, resource access role ARN and vocabulary settings.
@@ -1914,6 +1960,13 @@ export interface MedicalScribeConfigurationEvent {
1914 1960
* @public
1915 1961
*/
1916 1962
PostStreamAnalyticsSettings: MedicalScribePostStreamAnalyticsSettings | undefined;
1963 + 1964 +
/**
1965 +
* <p>The <code>MedicalScribeContext</code> object that contains contextual information used to generate
1966 +
* customized clinical notes.</p>
1967 +
* @public
1968 +
*/
1969 +
MedicalScribeContext?: MedicalScribeContext | undefined;
1917 1970
}
1918 1971 1919 1972
/**
@@ -3875,13 +3928,40 @@ export const CallAnalyticsTranscriptResultStreamFilterSensitiveLog = (
3875 3928
if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
3876 3929
};
3877 3930 3931 +
/**
3932 +
* @internal
3933 +
*/
3934 +
export const MedicalScribePatientContextFilterSensitiveLog = (obj: MedicalScribePatientContext): any => ({
3935 +
...obj,
3936 +
...(obj.Pronouns && { Pronouns: SENSITIVE_STRING }),
3937 +
});
3938 + 3939 +
/**
3940 +
* @internal
3941 +
*/
3942 +
export const MedicalScribeContextFilterSensitiveLog = (obj: MedicalScribeContext): any => ({
3943 +
...obj,
3944 +
...(obj.PatientContext && { PatientContext: MedicalScribePatientContextFilterSensitiveLog(obj.PatientContext) }),
3945 +
});
3946 + 3947 +
/**
3948 +
* @internal
3949 +
*/
3950 +
export const MedicalScribeConfigurationEventFilterSensitiveLog = (obj: MedicalScribeConfigurationEvent): any => ({
3951 +
...obj,
3952 +
...(obj.MedicalScribeContext && {
3953 +
MedicalScribeContext: MedicalScribeContextFilterSensitiveLog(obj.MedicalScribeContext),
3954 +
}),
3955 +
});
3956 + 3878 3957
/**
3879 3958
* @internal
3880 3959
*/
3881 3960
export const MedicalScribeInputStreamFilterSensitiveLog = (obj: MedicalScribeInputStream): any => {
3882 3961
if (obj.AudioEvent !== undefined) return { AudioEvent: obj.AudioEvent };
3883 3962
if (obj.SessionControlEvent !== undefined) return { SessionControlEvent: obj.SessionControlEvent };
3884 -
if (obj.ConfigurationEvent !== undefined) return { ConfigurationEvent: obj.ConfigurationEvent };
3963 +
if (obj.ConfigurationEvent !== undefined)
3964 +
return { ConfigurationEvent: MedicalScribeConfigurationEventFilterSensitiveLog(obj.ConfigurationEvent) };
3885 3965
if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
3886 3966
};
3887 3967
@@ -77,8 +77,10 @@ import {
77 77
MedicalScribeAudioEvent,
78 78
MedicalScribeChannelDefinition,
79 79
MedicalScribeConfigurationEvent,
80 +
MedicalScribeContext,
80 81
MedicalScribeEncryptionSettings,
81 82
MedicalScribeInputStream,
83 +
MedicalScribePatientContext,
82 84
MedicalScribePostStreamAnalyticsSettings,
83 85
MedicalScribeResultStream,
84 86
MedicalScribeSessionControlEvent,
@@ -911,8 +913,12 @@ const de_UtteranceEvent_event = async (output: any, context: __SerdeContext): Pr
911 913 912 914
// se_MedicalScribeConfigurationEvent omitted.
913 915 916 +
// se_MedicalScribeContext omitted.
917 + 914 918
// se_MedicalScribeEncryptionSettings omitted.
915 919 920 +
// se_MedicalScribePatientContext omitted.
921 + 916 922
// se_MedicalScribePostStreamAnalyticsSettings omitted.
917 923 918 924
// se_MedicalScribeSessionControlEvent omitted.
@@ -1207,6 +1213,7 @@ const de_MedicalScribeStreamDetails = (output: any, context: __SerdeContext): Me
1207 1213
LanguageCode: __expectString,
1208 1214
MediaEncoding: __expectString,
1209 1215
MediaSampleRateHertz: __expectInt32,
1216 +
MedicalScribeContextProvided: __expectBoolean,
1210 1217
PostStreamAnalyticsResult: _json,
1211 1218
PostStreamAnalyticsSettings: _json,
1212 1219
ResourceAccessRoleArn: __expectString,
@@ -1566,12 +1566,32 @@
1566 1566
"smithy.api#documentation": "<p>Specify settings for post-stream analytics.</p>",
1567 1567
"smithy.api#required": {}
1568 1568
}
1569 +
},
1570 +
"MedicalScribeContext": {
1571 +
"target": "com.amazonaws.transcribestreaming#MedicalScribeContext",
1572 +
"traits": {
1573 +
"smithy.api#documentation": "<p>The <code>MedicalScribeContext</code> object that contains contextual information used to generate\n customized clinical notes.</p>"
1574 +
}
1569 1575
}
1570 1576
},
1571 1577
"traits": {
1572 1578
"smithy.api#documentation": "<p>Specify details to configure the streaming session, including channel definitions, encryption settings, post-stream analytics\n settings, resource access role ARN and vocabulary settings.\n </p>\n <p>Whether you are starting a new session or resuming an existing session, \n your first event must be a <code>MedicalScribeConfigurationEvent</code>.\n If you are resuming a session, then this event must have the same configurations that you provided to start the session.\n </p>"
1573 1579
}
1574 1580
},
1581 +
"com.amazonaws.transcribestreaming#MedicalScribeContext": {
1582 +
"type": "structure",
1583 +
"members": {
1584 +
"PatientContext": {
1585 +
"target": "com.amazonaws.transcribestreaming#MedicalScribePatientContext",
1586 +
"traits": {
1587 +
"smithy.api#documentation": "<p>Contains patient-specific information used to customize the clinical note generation.</p>"
1588 +
}
1589 +
}
1590 +
},
1591 +
"traits": {
1592 +
"smithy.api#documentation": "<p>The <code>MedicalScribeContext</code> object that contains contextual information which is used during clinical note generation\n to add relevant context to the note.</p>"
1593 +
}
1594 +
},
1575 1595
"com.amazonaws.transcribestreaming#MedicalScribeEncryptionSettings": {
1576 1596
"type": "structure",
1577 1597
"members": {
@@ -1724,6 +1744,20 @@
1724 1744
}
1725 1745
}
1726 1746
},
1747 +
"com.amazonaws.transcribestreaming#MedicalScribePatientContext": {
1748 +
"type": "structure",
1749 +
"members": {
1750 +
"Pronouns": {
1751 +
"target": "com.amazonaws.transcribestreaming#Pronouns",
1752 +
"traits": {
1753 +
"smithy.api#documentation": "<p>The patient's preferred pronouns that the user wants to provide as a context for clinical note generation .</p>"
1754 +
}
1755 +
}
1756 +
},
1757 +
"traits": {
1758 +
"smithy.api#documentation": "<p>Contains patient-specific information. </p>"
1759 +
}
1760 +
},
1727 1761
"com.amazonaws.transcribestreaming#MedicalScribePostStreamAnalyticsResult": {
1728 1762
"type": "structure",
1729 1763
"members": {
@@ -1901,6 +1935,12 @@
1901 1935
"traits": {
1902 1936
"smithy.api#documentation": "<p>The result of post-stream analytics for the HealthScribe streaming session.</p>"
1903 1937
}
1938 +
},
1939 +
"MedicalScribeContextProvided": {
1940 +
"target": "com.amazonaws.transcribestreaming#NullableBoolean",
1941 +
"traits": {
1942 +
"smithy.api#documentation": "<p>Indicates whether the <code>MedicalScribeContext</code> object was provided when the stream was started.</p>"
1943 +
}
1904 1944
}
1905 1945
},
1906 1946
"traits": {
@@ -2282,6 +2322,32 @@
2282 2322
"smithy.api#documentation": "<p>Allows you to specify additional settings for your Call Analytics post-call request, \n including output locations for your redacted transcript, which IAM role to use, \n and which encryption key to use.</p>\n <p>\n <code>DataAccessRoleArn</code> and <code>OutputLocation</code> are required \n fields.</p>\n <p>\n <code>PostCallAnalyticsSettings</code> provides you with the same insights as a \n Call Analytics post-call transcription. Refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html\">Post-call analytics</a> for more information \n on this feature.</p>"
2283 2323
}
2284 2324
},
2325 +
"com.amazonaws.transcribestreaming#Pronouns": {
2326 +
"type": "enum",
2327 +
"members": {
2328 +
"HE_HIM": {
2329 +
"target": "smithy.api#Unit",
2330 +
"traits": {
2331 +
"smithy.api#enumValue": "HE_HIM"
2332 +
}
2333 +
},
2334 +
"SHE_HER": {
2335 +
"target": "smithy.api#Unit",
2336 +
"traits": {
2337 +
"smithy.api#enumValue": "SHE_HER"
2338 +
}
2339 +
},
2340 +
"THEY_THEM": {
2341 +
"target": "smithy.api#Unit",
2342 +
"traits": {
2343 +
"smithy.api#enumValue": "THEY_THEM"
2344 +
}
2345 +
}
2346 +
},
2347 +
"traits": {
2348 +
"smithy.api#sensitive": {}
2349 +
}
2350 +
},
2285 2351
"com.amazonaws.transcribestreaming#RequestId": {
2286 2352
"type": "string"
2287 2353
},
@@ -2744,7 +2810,7 @@
2744 2810
}
2745 2811
],
2746 2812
"traits": {
2747 -
"smithy.api#documentation": "<p>Starts a bidirectional HTTP/2 stream, where audio is streamed to\n Amazon Web Services HealthScribe\n and the transcription results are streamed to your application.</p>\n <p>When you start a stream, you first specify the stream configuration in a <code>MedicalScribeConfigurationEvent</code>. \n This event includes channel definitions, encryption settings, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional\n streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, \n your first event must be a <code>MedicalScribeConfigurationEvent</code>. </p>\n <p>\n After you send a <code>MedicalScribeConfigurationEvent</code>, you start <code>AudioEvents</code> and Amazon Web Services HealthScribe \n responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a <code>MedicalScribeSessionControlEvent</code> with a <code>Type</code> of \n <code>END_OF_SESSION</code> and Amazon Web Services HealthScribe starts the analytics.\n </p>\n <p>You can pause or resume streaming.\n To pause streaming, complete the input stream without sending the\n <code>MedicalScribeSessionControlEvent</code>.\n To resume streaming, call the <code>StartMedicalScribeStream</code> and specify the same SessionId you used to start the stream.\n </p>\n <p>The following parameters are required:</p>\n <ul>\n <li>\n <p>\n <code>language-code</code>\n </p>\n </li>\n <li>\n <p>\n <code>media-encoding</code>\n </p>\n </li>\n <li>\n <p>\n <code>media-sample-rate-hertz</code>\n </p>\n </li>\n </ul>\n <p></p>\n <p>For more information on streaming with\n Amazon Web Services HealthScribe,\n see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html\">Amazon Web Services HealthScribe</a>.\n </p>",
2813 +
"smithy.api#documentation": "<p>Starts a bidirectional HTTP/2 stream, where audio is streamed to\n Amazon Web Services HealthScribe\n and the transcription results are streamed to your application.</p>\n <p>When you start a stream, you first specify the stream configuration in a <code>MedicalScribeConfigurationEvent</code>. \n This event includes channel definitions, encryption settings, medical scribe context, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional\n streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, \n your first event must be a <code>MedicalScribeConfigurationEvent</code>. </p>\n <p>\n After you send a <code>MedicalScribeConfigurationEvent</code>, you start <code>AudioEvents</code> and Amazon Web Services HealthScribe \n responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a <code>MedicalScribeSessionControlEvent</code> with a <code>Type</code> of \n <code>END_OF_SESSION</code> and Amazon Web Services HealthScribe starts the analytics.\n </p>\n <p>You can pause or resume streaming.\n To pause streaming, complete the input stream without sending the\n <code>MedicalScribeSessionControlEvent</code>.\n To resume streaming, call the <code>StartMedicalScribeStream</code> and specify the same SessionId you used to start the stream.\n </p>\n <p>The following parameters are required:</p>\n <ul>\n <li>\n <p>\n <code>language-code</code>\n </p>\n </li>\n <li>\n <p>\n <code>media-encoding</code>\n </p>\n </li>\n <li>\n <p>\n <code>media-sample-rate-hertz</code>\n </p>\n </li>\n </ul>\n <p></p>\n <p>For more information on streaming with\n Amazon Web Services HealthScribe,\n see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html\">Amazon Web Services HealthScribe</a>.\n </p>",
2748 2814
"smithy.api#http": {
2749 2815
"method": "POST",
2750 2816
"uri": "/medical-scribe-stream",
You can’t perform that action at this time.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4