Skip to content

Commit 8a73ce5

Browse files
This release adds support for the Clinical Note Template Customization feature for the AWS HealthScribe APIs within Amazon Transcribe.
1 parent b3f8ccc commit 8a73ce5

12 files changed

+381
-13
lines changed

generator/ServiceModels/transcribe/transcribe-2017-10-26.api.json

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -817,6 +817,12 @@
817817
"max":1,
818818
"min":0
819819
},
820+
"ClinicalNoteGenerationSettings":{
821+
"type":"structure",
822+
"members":{
823+
"NoteTemplate":{"shape":"MedicalScribeNoteTemplate"}
824+
}
825+
},
820826
"ConflictException":{
821827
"type":"structure",
822828
"members":{
@@ -1662,6 +1668,13 @@
16621668
"type":"string",
16631669
"enum":["en-US"]
16641670
},
1671+
"MedicalScribeNoteTemplate":{
1672+
"type":"string",
1673+
"enum":[
1674+
"HISTORY_AND_PHYSICAL",
1675+
"GIRPP"
1676+
]
1677+
},
16651678
"MedicalScribeOutput":{
16661679
"type":"structure",
16671680
"required":[
@@ -1688,7 +1701,8 @@
16881701
"ChannelIdentification":{"shape":"Boolean"},
16891702
"VocabularyName":{"shape":"VocabularyName"},
16901703
"VocabularyFilterName":{"shape":"VocabularyFilterName"},
1691-
"VocabularyFilterMethod":{"shape":"VocabularyFilterMethod"}
1704+
"VocabularyFilterMethod":{"shape":"VocabularyFilterMethod"},
1705+
"ClinicalNoteGenerationSettings":{"shape":"ClinicalNoteGenerationSettings"}
16921706
}
16931707
},
16941708
"MedicalTranscript":{

generator/ServiceModels/transcribe/transcribe-2017-10-26.docs.json

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,12 @@
224224
"ChannelDefinition$ChannelId": "<p>Specify the audio channel you want to define.</p>"
225225
}
226226
},
227+
"ClinicalNoteGenerationSettings": {
228+
"base": "<p>The output configuration for clinical note generation.</p>",
229+
"refs": {
230+
"MedicalScribeSettings$ClinicalNoteGenerationSettings": "<p>Specify settings for the clinical note generation.</p>"
231+
}
232+
},
227233
"ConflictException": {
228234
"base": "<p>A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.</p>",
229235
"refs": {
@@ -596,7 +602,7 @@
596602
"MedicalTranscriptionJob$LanguageCode": "<p>The language code used to create your medical transcription job. US English (<code>en-US</code>) is the only supported language for medical transcriptions.</p>",
597603
"MedicalTranscriptionJobSummary$LanguageCode": "<p>The language code used to create your medical transcription. US English (<code>en-US</code>) is the only supported language for medical transcriptions.</p>",
598604
"StartMedicalTranscriptionJobRequest$LanguageCode": "<p>The language code that represents the language spoken in the input media file. US English (<code>en-US</code>) is the only valid value for medical transcription jobs. Any other value you enter for language code results in a <code>BadRequestException</code> error.</p>",
599-
"StartTranscriptionJobRequest$LanguageCode": "<p>The language code that represents the language spoken in the input media file.</p> <p>If you're unsure of the language spoken in your media file, consider using <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable automatic language identification.</p> <p>Note that you must include one of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your request. If you include more than one of these parameters, your transcription job fails.</p> <p>For a list of supported languages and their associated language codes, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p> <note> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p> </note>",
605+
"StartTranscriptionJobRequest$LanguageCode": "<p>The language code that represents the language spoken in the input media file.</p> <p>If you're unsure of the language spoken in your media file, consider using <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable automatic language identification.</p> <p>Note that you must include one of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your request. If you include more than one of these parameters, your transcription job fails.</p> <p>For a list of supported languages and their associated language codes, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p> <note> <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 must be encoded at a sample rate of 16,000 Hz or higher.</p> </note>",
600606
"TranscriptionJob$LanguageCode": "<p>The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, <code>LanguageCodes</code>.</p>",
601607
"TranscriptionJobSummary$LanguageCode": "<p>The language code used to create your transcription.</p>",
602608
"UpdateMedicalVocabularyRequest$LanguageCode": "<p>The language code that represents the language of the entries in the custom vocabulary you want to update. US English (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</p>",
@@ -645,8 +651,8 @@
645651
"LanguageOptions": {
646652
"base": null,
647653
"refs": {
648-
"CallAnalyticsJobSettings$LanguageOptions": "<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>Including language options can improve the accuracy of language identification.</p> <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 languages</a> table.</p> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p>",
649-
"StartTranscriptionJobRequest$LanguageOptions": "<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p> <p>For more information, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a>.</p> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p>",
654+
"CallAnalyticsJobSettings$LanguageOptions": "<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>Including language options can improve the accuracy of language identification.</p> <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 languages</a> table.</p> <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 must be encoded at a sample rate of 16,000 Hz or higher.</p>",
655+
"StartTranscriptionJobRequest$LanguageOptions": "<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p> <p>For more information, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a>.</p> <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 must be encoded at a sample rate of 16,000 Hz or higher.</p>",
650656
"TranscriptionJob$LanguageOptions": "<p>Provides the language codes you specified in your request.</p>"
651657
}
652658
},
@@ -884,6 +890,12 @@
884890
"MedicalScribeJobSummary$LanguageCode": "<p>The language code used to create your Medical Scribe job. US English (<code>en-US</code>) is the only supported language for Medical Scribe jobs. </p>"
885891
}
886892
},
893+
"MedicalScribeNoteTemplate": {
894+
"base": null,
895+
"refs": {
896+
"ClinicalNoteGenerationSettings$NoteTemplate": "<p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p> <ul> <li> <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p> </li> <li> <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p> </li> </ul>"
897+
}
898+
},
887899
"MedicalScribeOutput": {
888900
"base": "<p>The location of the output of your Medical Scribe job. <code>ClinicalDocumentUri</code> holds the Amazon S3 URI for the Clinical Document and <code>TranscriptFileUri</code> holds the Amazon S3 URI for the Transcript.</p>",
889901
"refs": {

generator/ServiceModels/transcribe/transcribe-2017-10-26.normal.json

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -852,7 +852,7 @@
852852
"ContentRedaction":{"shape":"ContentRedaction"},
853853
"LanguageOptions":{
854854
"shape":"LanguageOptions",
855-
"documentation":"<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>Including language options can improve the accuracy of language identification.</p> <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 languages</a> table.</p> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p>"
855+
"documentation":"<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>Including language options can improve the accuracy of language identification.</p> <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 languages</a> table.</p> <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 must be encoded at a sample rate of 16,000 Hz or higher.</p>"
856856
},
857857
"LanguageIdSettings":{
858858
"shape":"LanguageIdSettingsMap",
@@ -1010,6 +1010,16 @@
10101010
"max":1,
10111011
"min":0
10121012
},
1013+
"ClinicalNoteGenerationSettings":{
1014+
"type":"structure",
1015+
"members":{
1016+
"NoteTemplate":{
1017+
"shape":"MedicalScribeNoteTemplate",
1018+
"documentation":"<p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p> <ul> <li> <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p> </li> <li> <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p> </li> </ul>"
1019+
}
1020+
},
1021+
"documentation":"<p>The output configuration for clinical note generation.</p>"
1022+
},
10131023
"ConflictException":{
10141024
"type":"structure",
10151025
"members":{
@@ -2451,6 +2461,13 @@
24512461
"type":"string",
24522462
"enum":["en-US"]
24532463
},
2464+
"MedicalScribeNoteTemplate":{
2465+
"type":"string",
2466+
"enum":[
2467+
"HISTORY_AND_PHYSICAL",
2468+
"GIRPP"
2469+
]
2470+
},
24542471
"MedicalScribeOutput":{
24552472
"type":"structure",
24562473
"required":[
@@ -2502,6 +2519,10 @@
25022519
"VocabularyFilterMethod":{
25032520
"shape":"VocabularyFilterMethod",
25042521
"documentation":"<p>Specify how you want your custom vocabulary filter applied to your transcript.</p> <p>To replace words with <code>***</code>, choose <code>mask</code>.</p> <p>To delete words, choose <code>remove</code>.</p> <p>To flag words without changing them, choose <code>tag</code>.</p>"
2522+
},
2523+
"ClinicalNoteGenerationSettings":{
2524+
"shape":"ClinicalNoteGenerationSettings",
2525+
"documentation":"<p>Specify settings for the clinical note generation.</p>"
25052526
}
25062527
},
25072528
"documentation":"<p>Makes it possible to control how your Medical Scribe job is processed using a <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code> and <code>ChannelDefinitions</code> are not set. One and only one of <code>ChannelIdentification</code> and <code>ShowSpeakerLabels</code> must be set. If <code>ShowSpeakerLabels</code> is set, <code>MaxSpeakerLabels</code> must also be set. Use <code>Settings</code> to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>. <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set. </p>"
@@ -3137,7 +3158,7 @@
31373158
},
31383159
"LanguageCode":{
31393160
"shape":"LanguageCode",
3140-
"documentation":"<p>The language code that represents the language spoken in the input media file.</p> <p>If you're unsure of the language spoken in your media file, consider using <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable automatic language identification.</p> <p>Note that you must include one of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your request. If you include more than one of these parameters, your transcription job fails.</p> <p>For a list of supported languages and their associated language codes, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p> <note> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p> </note>"
3161+
"documentation":"<p>The language code that represents the language spoken in the input media file.</p> <p>If you're unsure of the language spoken in your media file, consider using <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable automatic language identification.</p> <p>Note that you must include one of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your request. If you include more than one of these parameters, your transcription job fails.</p> <p>For a list of supported languages and their associated language codes, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p> <note> <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 must be encoded at a sample rate of 16,000 Hz or higher.</p> </note>"
31413162
},
31423163
"MediaSampleRateHertz":{
31433164
"shape":"MediaSampleRateHertz",
@@ -3193,7 +3214,7 @@
31933214
},
31943215
"LanguageOptions":{
31953216
"shape":"LanguageOptions",
3196-
"documentation":"<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p> <p>For more information, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a>.</p> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p>"
3217+
"documentation":"<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p> <p>For more information, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a>.</p> <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 must be encoded at a sample rate of 16,000 Hz or higher.</p>"
31973218
},
31983219
"Subtitles":{
31993220
"shape":"Subtitles",

sdk/src/Services/TranscribeService/Generated/Model/CallAnalyticsJobSettings.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,10 @@ internal bool IsSetLanguageModelName()
157157
/// </para>
158158
///
159159
/// <para>
160-
/// To transcribe speech in Modern Standard Arabic (<c>ar-SA</c>), your media file must
161-
/// be encoded at a sample rate of 16,000 Hz or higher.
160+
/// To transcribe speech in Modern Standard Arabic (<c>ar-SA</c>) in Amazon Web Services
161+
/// GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East,
162+
/// us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your
163+
/// media file must be encoded at a sample rate of 16,000 Hz or higher.
162164
/// </para>
163165
/// </summary>
164166
[AWSProperty(Min=1)]

0 commit comments

Comments
 (0)