feat(client-transcribe-streaming): This release adds support for the …

…Clinical Note Template Customization feature for the AWS HealthScribe Streaming APIs within Amazon Transcribe.
aws · Feb 7, 2025 · d338b70 · d338b70
1 parent 94f7ccb
commit d338b70
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 0 deletions.
diff --git a/clients/client-transcribe-streaming/src/commands/GetMedicalScribeStreamCommand.ts b/clients/client-transcribe-streaming/src/commands/GetMedicalScribeStreamCommand.ts
@@ -75,6 +75,7 @@ export interface GetMedicalScribeStreamCommandOutput extends GetMedicalScribeStr
  * //     PostStreamAnalyticsSettings: { // MedicalScribePostStreamAnalyticsSettings
  * //       ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
  * //         OutputBucketName: "STRING_VALUE", // required
+ * //         NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP",
  * //       },
  * //     },
  * //     PostStreamAnalyticsResult: { // MedicalScribePostStreamAnalyticsResult

diff --git a/clients/client-transcribe-streaming/src/commands/StartMedicalScribeStreamCommand.ts b/clients/client-transcribe-streaming/src/commands/StartMedicalScribeStreamCommand.ts
@@ -118,6 +118,7 @@ export interface StartMedicalScribeStreamCommandOutput extends StartMedicalScrib
  *       PostStreamAnalyticsSettings: { // MedicalScribePostStreamAnalyticsSettings
  *         ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
  *           OutputBucketName: "STRING_VALUE", // required
+ *           NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP",
  *         },
  *       },
  *     },

diff --git a/clients/client-transcribe-streaming/src/models/models_0.ts b/clients/client-transcribe-streaming/src/models/models_0.ts
@@ -1075,6 +1075,20 @@ export interface ClinicalNoteGenerationResult {
   FailureReason?: string | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const MedicalScribeNoteTemplate = {
+  GIRPP: "GIRPP",
+  HISTORY_AND_PHYSICAL: "HISTORY_AND_PHYSICAL",
+} as const;
+
+/**
+ * @public
+ */
+export type MedicalScribeNoteTemplate = (typeof MedicalScribeNoteTemplate)[keyof typeof MedicalScribeNoteTemplate];
+
 /**
  * <p>The output configuration for aggregated transcript and clinical note generation.</p>
  * @public
@@ -1092,6 +1106,21 @@ export interface ClinicalNoteGenerationSettings {
    * @public
    */
   OutputBucketName: string | undefined;
+
+  /**
+   * <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>
+   * @public
+   */
+  NoteTemplate?: MedicalScribeNoteTemplate | undefined;
 }
 
 /**

diff --git a/codegen/sdk-codegen/aws-models/transcribe-streaming.json b/codegen/sdk-codegen/aws-models/transcribe-streaming.json
@@ -457,6 +457,12 @@
             "smithy.api#documentation": "<p>The name of the Amazon S3 bucket where you want the output of Amazon Web Services HealthScribe post-stream analytics stored. Don't include the <code>S3://</code> prefix of the specified bucket. </p>\n         <p>HealthScribe outputs transcript and clinical note files under the prefix:\n        <code>S3://$output-bucket-name/healthscribe-streaming/session-id/post-stream-analytics/clinical-notes</code>\n         </p>\n         <p>The role <code>ResourceAccessRoleArn</code> specified in the <code>MedicalScribeConfigurationEvent</code> must have\n      permission to use the specified location. You can change Amazon S3 permissions using the <a href=\"https://console.aws.amazon.com/s3\">\n        Amazon Web Services Management Console\n      </a>. See also <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user\">Permissions Required for IAM User Roles </a> . </p>",
             "smithy.api#required": {}
           }
+        },
+        "NoteTemplate": {
+          "target": "com.amazonaws.transcribestreaming#MedicalScribeNoteTemplate",
+          "traits": {
+            "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>"
+          }
         }
       },
       "traits": {
@@ -1654,6 +1660,23 @@
         }
       }
     },
+    "com.amazonaws.transcribestreaming#MedicalScribeNoteTemplate": {
+      "type": "enum",
+      "members": {
+        "HISTORY_AND_PHYSICAL": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "HISTORY_AND_PHYSICAL"
+          }
+        },
+        "GIRPP": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "GIRPP"
+          }
+        }
+      }
+    },
     "com.amazonaws.transcribestreaming#MedicalScribeParticipantRole": {
       "type": "enum",
       "members": {