Skip to content

Commit 91fce74

Browse files
author
awstools
committed
feat(client-transcribe): This release adds support for the Clinical Note Template Customization feature for the AWS HealthScribe APIs within Amazon Transcribe.
1 parent d338b70 commit 91fce74

File tree

5 files changed

+98
-6
lines changed

5 files changed

+98
-6
lines changed

clients/client-transcribe/src/commands/GetMedicalScribeJobCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ export interface GetMedicalScribeJobCommandOutput extends GetMedicalScribeJobRes
7171
* // VocabularyName: "STRING_VALUE",
7272
* // VocabularyFilterName: "STRING_VALUE",
7373
* // VocabularyFilterMethod: "remove" || "mask" || "tag",
74+
* // ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
75+
* // NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP",
76+
* // },
7477
* // },
7578
* // DataAccessRoleArn: "STRING_VALUE",
7679
* // ChannelDefinitions: [ // MedicalScribeChannelDefinitions

clients/client-transcribe/src/commands/StartMedicalScribeJobCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,9 @@ export interface StartMedicalScribeJobCommandOutput extends StartMedicalScribeJo
9999
* VocabularyName: "STRING_VALUE",
100100
* VocabularyFilterName: "STRING_VALUE",
101101
* VocabularyFilterMethod: "remove" || "mask" || "tag",
102+
* ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
103+
* NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP",
104+
* },
102105
* },
103106
* ChannelDefinitions: [ // MedicalScribeChannelDefinitions
104107
* { // MedicalScribeChannelDefinition
@@ -139,6 +142,9 @@ export interface StartMedicalScribeJobCommandOutput extends StartMedicalScribeJo
139142
* // VocabularyName: "STRING_VALUE",
140143
* // VocabularyFilterName: "STRING_VALUE",
141144
* // VocabularyFilterMethod: "remove" || "mask" || "tag",
145+
* // ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
146+
* // NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP",
147+
* // },
142148
* // },
143149
* // DataAccessRoleArn: "STRING_VALUE",
144150
* // ChannelDefinitions: [ // MedicalScribeChannelDefinitions

clients/client-transcribe/src/models/models_0.ts

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@ export interface CallAnalyticsJobSettings {
657657
* <p>Including language options can improve the accuracy of language identification.</p>
658658
* <p>For a list of languages supported with Call Analytics, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
659659
* languages</a> table.</p>
660-
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
660+
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file
661661
* must be encoded at a sample rate of 16,000 Hz or higher.</p>
662662
* @public
663663
*/
@@ -1529,6 +1529,41 @@ export interface CategoryProperties {
15291529
InputType?: InputType | undefined;
15301530
}
15311531

1532+
/**
1533+
* @public
1534+
* @enum
1535+
*/
1536+
export const MedicalScribeNoteTemplate = {
1537+
GIRPP: "GIRPP",
1538+
HISTORY_AND_PHYSICAL: "HISTORY_AND_PHYSICAL",
1539+
} as const;
1540+
1541+
/**
1542+
* @public
1543+
*/
1544+
export type MedicalScribeNoteTemplate = (typeof MedicalScribeNoteTemplate)[keyof typeof MedicalScribeNoteTemplate];
1545+
1546+
/**
1547+
* <p>The output configuration for clinical note generation.</p>
1548+
* @public
1549+
*/
1550+
export interface ClinicalNoteGenerationSettings {
1551+
/**
1552+
* <p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p>
1553+
* <ul>
1554+
* <li>
1555+
* <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint,
1556+
* History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p>
1557+
* </li>
1558+
* <li>
1559+
* <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p>
1560+
* </li>
1561+
* </ul>
1562+
* @public
1563+
*/
1564+
NoteTemplate?: MedicalScribeNoteTemplate | undefined;
1565+
}
1566+
15321567
/**
15331568
* @public
15341569
* @enum
@@ -2663,6 +2698,12 @@ export interface MedicalScribeSettings {
26632698
* @public
26642699
*/
26652700
VocabularyFilterMethod?: VocabularyFilterMethod | undefined;
2701+
2702+
/**
2703+
* <p>Specify settings for the clinical note generation.</p>
2704+
* @public
2705+
*/
2706+
ClinicalNoteGenerationSettings?: ClinicalNoteGenerationSettings | undefined;
26662707
}
26672708

26682709
/**
@@ -5421,7 +5462,7 @@ export interface StartTranscriptionJobRequest {
54215462
* <p>For a list of supported languages and their associated language codes, refer to the
54225463
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
54235464
* <note>
5424-
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media
5465+
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary, ca-west-1) and Africa (Cape Town, af-south-1), your media
54255466
* file must be encoded at a sample rate of 16,000 Hz or higher.</p>
54265467
* </note>
54275468
* @public
@@ -5666,7 +5707,7 @@ export interface StartTranscriptionJobRequest {
56665707
* <code>IdentifyLanguage</code>.</p>
56675708
* <p>For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
56685709
* languages</a>.</p>
5669-
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
5710+
* <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>)in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), in Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file
56705711
* must be encoded at a sample rate of 16,000 Hz or higher.</p>
56715712
* @public
56725713
*/

clients/client-transcribe/src/protocols/Aws_json1_1.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@ import {
178178
CallAnalyticsJobSummary,
179179
CategoryProperties,
180180
ChannelDefinition,
181+
ClinicalNoteGenerationSettings,
181182
ConflictException,
182183
ContentRedaction,
183184
CreateCallAnalyticsCategoryRequest,
@@ -1805,6 +1806,8 @@ const de_NotFoundExceptionRes = async (parsedOutput: any, context: __SerdeContex
18051806

18061807
// se_ChannelDefinitions omitted.
18071808

1809+
// se_ClinicalNoteGenerationSettings omitted.
1810+
18081811
// se_ContentRedaction omitted.
18091812

18101813
// se_CreateCallAnalyticsCategoryRequest omitted.
@@ -2056,6 +2059,8 @@ const de_CategoryPropertiesList = (output: any, context: __SerdeContext): Catego
20562059

20572060
// de_ChannelDefinitions omitted.
20582061

2062+
// de_ClinicalNoteGenerationSettings omitted.
2063+
20592064
// de_ConflictException omitted.
20602065

20612066
// de_ContentRedaction omitted.

codegen/sdk-codegen/aws-models/transcribe.json

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@
316316
"LanguageOptions": {
317317
"target": "com.amazonaws.transcribe#LanguageOptions",
318318
"traits": {
319-
"smithy.api#documentation": "<p>You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.</p>\n <p>Including language options can improve the accuracy of language identification.</p>\n <p>For a list of languages supported with Call Analytics, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported\n languages</a> table.</p>\n <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.</p>"
319+
"smithy.api#documentation": "<p>You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.</p>\n <p>Including language options can improve the accuracy of language identification.</p>\n <p>For a list of languages supported with Call Analytics, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported\n languages</a> table.</p>\n <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file\n must be encoded at a sample rate of 16,000 Hz or higher.</p>"
320320
}
321321
},
322322
"LanguageIdSettings": {
@@ -579,6 +579,20 @@
579579
}
580580
}
581581
},
582+
"com.amazonaws.transcribe#ClinicalNoteGenerationSettings": {
583+
"type": "structure",
584+
"members": {
585+
"NoteTemplate": {
586+
"target": "com.amazonaws.transcribe#MedicalScribeNoteTemplate",
587+
"traits": {
588+
"smithy.api#documentation": "<p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p>\n <ul>\n <li>\n <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint, \n History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p>\n </li>\n <li>\n <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p>\n </li>\n </ul>"
589+
}
590+
}
591+
},
592+
"traits": {
593+
"smithy.api#documentation": "<p>The output configuration for clinical note generation.</p>"
594+
}
595+
},
582596
"com.amazonaws.transcribe#ConflictException": {
583597
"type": "structure",
584598
"members": {
@@ -4361,6 +4375,23 @@
43614375
}
43624376
}
43634377
},
4378+
"com.amazonaws.transcribe#MedicalScribeNoteTemplate": {
4379+
"type": "enum",
4380+
"members": {
4381+
"HISTORY_AND_PHYSICAL": {
4382+
"target": "smithy.api#Unit",
4383+
"traits": {
4384+
"smithy.api#enumValue": "HISTORY_AND_PHYSICAL"
4385+
}
4386+
},
4387+
"GIRPP": {
4388+
"target": "smithy.api#Unit",
4389+
"traits": {
4390+
"smithy.api#enumValue": "GIRPP"
4391+
}
4392+
}
4393+
}
4394+
},
43644395
"com.amazonaws.transcribe#MedicalScribeOutput": {
43654396
"type": "structure",
43664397
"members": {
@@ -4438,6 +4469,12 @@
44384469
"traits": {
44394470
"smithy.api#documentation": "<p>Specify how you want your custom vocabulary filter applied to your transcript.</p>\n <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>\n <p>To delete words, choose <code>remove</code>.</p>\n <p>To flag words without changing them, choose <code>tag</code>.</p>"
44404471
}
4472+
},
4473+
"ClinicalNoteGenerationSettings": {
4474+
"target": "com.amazonaws.transcribe#ClinicalNoteGenerationSettings",
4475+
"traits": {
4476+
"smithy.api#documentation": "<p>Specify settings for the clinical note generation.</p>"
4477+
}
44414478
}
44424479
},
44434480
"traits": {
@@ -5624,7 +5661,7 @@
56245661
"LanguageCode": {
56255662
"target": "com.amazonaws.transcribe#LanguageCode",
56265663
"traits": {
5627-
"smithy.api#documentation": "<p>The language code that represents the language spoken in the input media file.</p>\n <p>If you're unsure of the language spoken in your media file, consider using\n <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable\n automatic language identification.</p>\n <p>Note that you must include one of <code>LanguageCode</code>,\n <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your\n request. If you include more than one of these parameters, your transcription job\n fails.</p>\n <p>For a list of supported languages and their associated language codes, refer to the\n <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p>\n <note>\n <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media\n file must be encoded at a sample rate of 16,000 Hz or higher.</p>\n </note>"
5664+
"smithy.api#documentation": "<p>The language code that represents the language spoken in the input media file.</p>\n <p>If you're unsure of the language spoken in your media file, consider using\n <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable\n automatic language identification.</p>\n <p>Note that you must include one of <code>LanguageCode</code>,\n <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your\n request. If you include more than one of these parameters, your transcription job\n fails.</p>\n <p>For a list of supported languages and their associated language codes, refer to the\n <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p>\n <note>\n <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary, ca-west-1) and Africa (Cape Town, af-south-1), your media\n file must be encoded at a sample rate of 16,000 Hz or higher.</p>\n </note>"
56285665
}
56295666
},
56305667
"MediaSampleRateHertz": {
@@ -5709,7 +5746,7 @@
57095746
"LanguageOptions": {
57105747
"target": "com.amazonaws.transcribe#LanguageOptions",
57115748
"traits": {
5712-
"smithy.api#documentation": "<p>You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.</p>\n <p>If you include <code>LanguageOptions</code> in your request, you must also include\n <code>IdentifyLanguage</code>.</p>\n <p>For more information, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported\n languages</a>.</p>\n <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.</p>"
5749+
"smithy.api#documentation": "<p>You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.</p>\n <p>If you include <code>LanguageOptions</code> in your request, you must also include\n <code>IdentifyLanguage</code>.</p>\n <p>For more information, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported\n languages</a>.</p>\n <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>)in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), in Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file\n must be encoded at a sample rate of 16,000 Hz or higher.</p>"
57135750
}
57145751
},
57155752
"Subtitles": {

0 commit comments

Comments
 (0)