Skip to content

Commit de7e46f

Browse files
author
awstools
committed
feat(client-transcribe-streaming): AWS Healthscribe now supports new templates for the clinical note summary: BIRP, SIRP, DAP, BEHAVIORAL_SOAP, and PHYSICAL_SOAP
1 parent bd03227 commit de7e46f

File tree

4 files changed

+81
-30
lines changed

4 files changed

+81
-30
lines changed

‎clients/client-transcribe-streaming/src/commands/GetMedicalScribeStreamCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ export interface GetMedicalScribeStreamCommandOutput extends GetMedicalScribeStr
7575
* // PostStreamAnalyticsSettings: { // MedicalScribePostStreamAnalyticsSettings
7676
* // ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
7777
* // OutputBucketName: "STRING_VALUE", // required
78-
* // NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP",
78+
* // NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP" || "DAP" || "SIRP" || "BIRP" || "BEHAVIORAL_SOAP" || "PHYSICAL_SOAP",
7979
* // },
8080
* // },
8181
* // PostStreamAnalyticsResult: { // MedicalScribePostStreamAnalyticsResult

‎clients/client-transcribe-streaming/src/commands/StartMedicalScribeStreamCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export interface StartMedicalScribeStreamCommandOutput extends StartMedicalScrib
118118
* PostStreamAnalyticsSettings: { // MedicalScribePostStreamAnalyticsSettings
119119
* ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
120120
* OutputBucketName: "STRING_VALUE", // required
121-
* NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP",
121+
* NoteTemplate: "HISTORY_AND_PHYSICAL" || "GIRPP" || "DAP" || "SIRP" || "BIRP" || "BEHAVIORAL_SOAP" || "PHYSICAL_SOAP",
122122
* },
123123
* },
124124
* },

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

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ import { TranscribeStreamingServiceException as __BaseException } from "./Transc
1111
*/
1212
export interface Entity {
1313
/**
14-
* <p>The start time, in milliseconds, of the utterance that was identified as PII.</p>
14+
* <p>The start time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)</p>
1515
* @public
1616
*/
1717
StartTime?: number | undefined;
1818

1919
/**
20-
* <p>The end time, in milliseconds, of the utterance that was identified as PII.</p>
20+
* <p>The end time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)</p>
2121
* @public
2222
*/
2323
EndTime?: number | undefined;
@@ -72,13 +72,13 @@ export type ItemType = (typeof ItemType)[keyof typeof ItemType];
7272
*/
7373
export interface Item {
7474
/**
75-
* <p>The start time, in milliseconds, of the transcribed item.</p>
75+
* <p>The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)</p>
7676
* @public
7777
*/
7878
StartTime?: number | undefined;
7979

8080
/**
81-
* <p>The end time, in milliseconds, of the transcribed item.</p>
81+
* <p>The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)</p>
8282
* @public
8383
*/
8484
EndTime?: number | undefined;
@@ -1080,8 +1080,13 @@ export interface ClinicalNoteGenerationResult {
10801080
* @enum
10811081
*/
10821082
export const MedicalScribeNoteTemplate = {
1083+
BEHAVIORAL_SOAP: "BEHAVIORAL_SOAP",
1084+
BIRP: "BIRP",
1085+
DAP: "DAP",
10831086
GIRPP: "GIRPP",
10841087
HISTORY_AND_PHYSICAL: "HISTORY_AND_PHYSICAL",
1088+
PHYSICAL_SOAP: "PHYSICAL_SOAP",
1089+
SIRP: "SIRP",
10851090
} as const;
10861091

10871092
/**
@@ -1111,11 +1116,27 @@ export interface ClinicalNoteGenerationSettings {
11111116
* <p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p>
11121117
* <ul>
11131118
* <li>
1114-
* <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint,
1115-
* History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p>
1119+
* <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.
1120+
* </p>
1121+
* </li>
1122+
* <li>
1123+
* <p>GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention,
1124+
* Response, Progress, and Plan.</p>
1125+
* </li>
1126+
* <li>
1127+
* <p>BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.</p>
11161128
* </li>
11171129
* <li>
1118-
* <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p>
1130+
* <p>SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.</p>
1131+
* </li>
1132+
* <li>
1133+
* <p>DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.</p>
1134+
* </li>
1135+
* <li>
1136+
* <p>BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.</p>
1137+
* </li>
1138+
* <li>
1139+
* <p>PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.</p>
11191140
* </li>
11201141
* </ul>
11211142
* @public
@@ -1615,13 +1636,13 @@ export type MediaEncoding = (typeof MediaEncoding)[keyof typeof MediaEncoding];
16151636
*/
16161637
export interface MedicalEntity {
16171638
/**
1618-
* <p>The start time, in milliseconds, of the utterance that was identified as PHI.</p>
1639+
* <p>The start time, in seconds, of the utterance that was identified as PHI.</p>
16191640
* @public
16201641
*/
16211642
StartTime?: number | undefined;
16221643

16231644
/**
1624-
* <p>The end time, in milliseconds, of the utterance that was identified as PHI.</p>
1645+
* <p>The end time, in seconds, of the utterance that was identified as PHI.</p>
16251646
* @public
16261647
*/
16271648
EndTime?: number | undefined;
@@ -1655,13 +1676,13 @@ export interface MedicalEntity {
16551676
*/
16561677
export interface MedicalItem {
16571678
/**
1658-
* <p>The start time, in milliseconds, of the transcribed item.</p>
1679+
* <p>The start time, in seconds, of the transcribed item.</p>
16591680
* @public
16601681
*/
16611682
StartTime?: number | undefined;
16621683

16631684
/**
1664-
* <p>The end time, in milliseconds, of the transcribed item.</p>
1685+
* <p>The end time, in seconds, of the transcribed item.</p>
16651686
* @public
16661687
*/
16671688
EndTime?: number | undefined;
@@ -1754,13 +1775,13 @@ export interface MedicalResult {
17541775
ResultId?: string | undefined;
17551776

17561777
/**
1757-
* <p>The start time, in milliseconds, of the <code>Result</code>.</p>
1778+
* <p>The start time, in seconds, of the <code>Result</code>.</p>
17581779
* @public
17591780
*/
17601781
StartTime?: number | undefined;
17611782

17621783
/**
1763-
* <p>The end time, in milliseconds, of the <code>Result</code>.</p>
1784+
* <p>The end time, in seconds, of the <code>Result</code>.</p>
17641785
* @public
17651786
*/
17661787
EndTime?: number | undefined;
@@ -2530,13 +2551,13 @@ export interface Result {
25302551
ResultId?: string | undefined;
25312552

25322553
/**
2533-
* <p>The start time, in milliseconds, of the <code>Result</code>.</p>
2554+
* <p>The start time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>
25342555
* @public
25352556
*/
25362557
StartTime?: number | undefined;
25372558

25382559
/**
2539-
* <p>The end time, in milliseconds, of the <code>Result</code>.</p>
2560+
* <p>The end time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>
25402561
* @public
25412562
*/
25422563
EndTime?: number | undefined;

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

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@
461461
"NoteTemplate": {
462462
"target": "com.amazonaws.transcribestreaming#MedicalScribeNoteTemplate",
463463
"traits": {
464-
"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>"
464+
"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. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.\n </p>\n </li>\n <li>\n <p>GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention,\n Response, Progress, and Plan.</p>\n </li>\n <li>\n <p>BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.</p>\n </li>\n <li>\n <p>SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.</p>\n </li>\n <li>\n <p>DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.</p>\n </li>\n <li>\n <p>BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.</p>\n </li>\n <li>\n <p>PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.</p>\n </li>\n </ul>"
465465
}
466466
}
467467
},
@@ -583,14 +583,14 @@
583583
"target": "com.amazonaws.transcribestreaming#Double",
584584
"traits": {
585585
"smithy.api#default": 0,
586-
"smithy.api#documentation": "<p>The start time, in milliseconds, of the utterance that was identified as PII.</p>"
586+
"smithy.api#documentation": "<p>The start time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)</p>"
587587
}
588588
},
589589
"EndTime": {
590590
"target": "com.amazonaws.transcribestreaming#Double",
591591
"traits": {
592592
"smithy.api#default": 0,
593-
"smithy.api#documentation": "<p>The end time, in milliseconds, of the utterance that was identified as PII.</p>"
593+
"smithy.api#documentation": "<p>The end time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)</p>"
594594
}
595595
},
596596
"Category": {
@@ -742,14 +742,14 @@
742742
"target": "com.amazonaws.transcribestreaming#Double",
743743
"traits": {
744744
"smithy.api#default": 0,
745-
"smithy.api#documentation": "<p>The start time, in milliseconds, of the transcribed item.</p>"
745+
"smithy.api#documentation": "<p>The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)</p>"
746746
}
747747
},
748748
"EndTime": {
749749
"target": "com.amazonaws.transcribestreaming#Double",
750750
"traits": {
751751
"smithy.api#default": 0,
752-
"smithy.api#documentation": "<p>The end time, in milliseconds, of the transcribed item.</p>"
752+
"smithy.api#documentation": "<p>The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)</p>"
753753
}
754754
},
755755
"Type": {
@@ -1315,14 +1315,14 @@
13151315
"target": "com.amazonaws.transcribestreaming#Double",
13161316
"traits": {
13171317
"smithy.api#default": 0,
1318-
"smithy.api#documentation": "<p>The start time, in milliseconds, of the utterance that was identified as PHI.</p>"
1318+
"smithy.api#documentation": "<p>The start time, in seconds, of the utterance that was identified as PHI.</p>"
13191319
}
13201320
},
13211321
"EndTime": {
13221322
"target": "com.amazonaws.transcribestreaming#Double",
13231323
"traits": {
13241324
"smithy.api#default": 0,
1325-
"smithy.api#documentation": "<p>The end time, in milliseconds, of the utterance that was identified as PHI.</p>"
1325+
"smithy.api#documentation": "<p>The end time, in seconds, of the utterance that was identified as PHI.</p>"
13261326
}
13271327
},
13281328
"Category": {
@@ -1361,14 +1361,14 @@
13611361
"target": "com.amazonaws.transcribestreaming#Double",
13621362
"traits": {
13631363
"smithy.api#default": 0,
1364-
"smithy.api#documentation": "<p>The start time, in milliseconds, of the transcribed item.</p>"
1364+
"smithy.api#documentation": "<p>The start time, in seconds, of the transcribed item.</p>"
13651365
}
13661366
},
13671367
"EndTime": {
13681368
"target": "com.amazonaws.transcribestreaming#Double",
13691369
"traits": {
13701370
"smithy.api#default": 0,
1371-
"smithy.api#documentation": "<p>The end time, in milliseconds, of the transcribed item.</p>"
1371+
"smithy.api#documentation": "<p>The end time, in seconds, of the transcribed item.</p>"
13721372
}
13731373
},
13741374
"Type": {
@@ -1419,14 +1419,14 @@
14191419
"target": "com.amazonaws.transcribestreaming#Double",
14201420
"traits": {
14211421
"smithy.api#default": 0,
1422-
"smithy.api#documentation": "<p>The start time, in milliseconds, of the <code>Result</code>.</p>"
1422+
"smithy.api#documentation": "<p>The start time, in seconds, of the <code>Result</code>.</p>"
14231423
}
14241424
},
14251425
"EndTime": {
14261426
"target": "com.amazonaws.transcribestreaming#Double",
14271427
"traits": {
14281428
"smithy.api#default": 0,
1429-
"smithy.api#documentation": "<p>The end time, in milliseconds, of the <code>Result</code>.</p>"
1429+
"smithy.api#documentation": "<p>The end time, in seconds, of the <code>Result</code>.</p>"
14301430
}
14311431
},
14321432
"IsPartial": {
@@ -1674,6 +1674,36 @@
16741674
"traits": {
16751675
"smithy.api#enumValue": "GIRPP"
16761676
}
1677+
},
1678+
"DAP": {
1679+
"target": "smithy.api#Unit",
1680+
"traits": {
1681+
"smithy.api#enumValue": "DAP"
1682+
}
1683+
},
1684+
"SIRP": {
1685+
"target": "smithy.api#Unit",
1686+
"traits": {
1687+
"smithy.api#enumValue": "SIRP"
1688+
}
1689+
},
1690+
"BIRP": {
1691+
"target": "smithy.api#Unit",
1692+
"traits": {
1693+
"smithy.api#enumValue": "BIRP"
1694+
}
1695+
},
1696+
"BEHAVIORAL_SOAP": {
1697+
"target": "smithy.api#Unit",
1698+
"traits": {
1699+
"smithy.api#enumValue": "BEHAVIORAL_SOAP"
1700+
}
1701+
},
1702+
"PHYSICAL_SOAP": {
1703+
"target": "smithy.api#Unit",
1704+
"traits": {
1705+
"smithy.api#enumValue": "PHYSICAL_SOAP"
1706+
}
16771707
}
16781708
}
16791709
},
@@ -2281,14 +2311,14 @@
22812311
"target": "com.amazonaws.transcribestreaming#Double",
22822312
"traits": {
22832313
"smithy.api#default": 0,
2284-
"smithy.api#documentation": "<p>The start time, in milliseconds, of the <code>Result</code>.</p>"
2314+
"smithy.api#documentation": "<p>The start time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>"
22852315
}
22862316
},
22872317
"EndTime": {
22882318
"target": "com.amazonaws.transcribestreaming#Double",
22892319
"traits": {
22902320
"smithy.api#default": 0,
2291-
"smithy.api#documentation": "<p>The end time, in milliseconds, of the <code>Result</code>.</p>"
2321+
"smithy.api#documentation": "<p>The end time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>"
22922322
}
22932323
},
22942324
"IsPartial": {

0 commit comments

Comments
 (0)