Skip to content

Commit b3da72d

Browse files
AWS Healthscribe now supports new templates for the clinical note summary: BIRP, SIRP, DAP, BEHAVIORAL_SOAP, and PHYSICAL_SOAP
1 parent 65ef3df commit b3da72d

13 files changed

+117
-70
lines changed

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -640,7 +640,12 @@
640640
"type":"string",
641641
"enum":[
642642
"HISTORY_AND_PHYSICAL",
643-
"GIRPP"
643+
"GIRPP",
644+
"DAP",
645+
"SIRP",
646+
"BIRP",
647+
"BEHAVIORAL_SOAP",
648+
"PHYSICAL_SOAP"
644649
]
645650
},
646651
"MedicalScribeParticipantRole":{

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

Lines changed: 24 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -230,23 +230,23 @@
230230
"Double": {
231231
"base": null,
232232
"refs": {
233-
"Entity$StartTime": "<p>The start time, in milliseconds, of the utterance that was identified as PII.</p>",
234-
"Entity$EndTime": "<p>The end time, in milliseconds, of the utterance that was identified as PII.</p>",
235-
"Item$StartTime": "<p>The start time, in milliseconds, of the transcribed item.</p>",
236-
"Item$EndTime": "<p>The end time, in milliseconds, of the transcribed item.</p>",
233+
"Entity$StartTime": "<p>The start time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)</p>",
234+
"Entity$EndTime": "<p>The end time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)</p>",
235+
"Item$StartTime": "<p>The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)</p>",
236+
"Item$EndTime": "<p>The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)</p>",
237237
"LanguageWithScore$Score": "<p>The confidence score associated with the identified language code. Confidence scores are values between zero and one; larger values indicate a higher confidence in the identified language.</p>",
238-
"MedicalEntity$StartTime": "<p>The start time, in milliseconds, of the utterance that was identified as PHI.</p>",
239-
"MedicalEntity$EndTime": "<p>The end time, in milliseconds, of the utterance that was identified as PHI.</p>",
240-
"MedicalItem$StartTime": "<p>The start time, in milliseconds, of the transcribed item.</p>",
241-
"MedicalItem$EndTime": "<p>The end time, in milliseconds, of the transcribed item.</p>",
242-
"MedicalResult$StartTime": "<p>The start time, in milliseconds, of the <code>Result</code>.</p>",
243-
"MedicalResult$EndTime": "<p>The end time, in milliseconds, of the <code>Result</code>.</p>",
238+
"MedicalEntity$StartTime": "<p>The start time, in seconds, of the utterance that was identified as PHI.</p>",
239+
"MedicalEntity$EndTime": "<p>The end time, in seconds, of the utterance that was identified as PHI.</p>",
240+
"MedicalItem$StartTime": "<p>The start time, in seconds, of the transcribed item.</p>",
241+
"MedicalItem$EndTime": "<p>The end time, in seconds, of the transcribed item.</p>",
242+
"MedicalResult$StartTime": "<p>The start time, in seconds, of the <code>Result</code>.</p>",
243+
"MedicalResult$EndTime": "<p>The end time, in seconds, of the <code>Result</code>.</p>",
244244
"MedicalScribeTranscriptItem$BeginAudioTime": "<p>The start time, in milliseconds, of the transcribed item.</p>",
245245
"MedicalScribeTranscriptItem$EndAudioTime": "<p>The end time, in milliseconds, of the transcribed item.</p>",
246246
"MedicalScribeTranscriptSegment$BeginAudioTime": "<p>The start time, in milliseconds, of the segment.</p>",
247247
"MedicalScribeTranscriptSegment$EndAudioTime": "<p>The end time, in milliseconds, of the segment.</p>",
248-
"Result$StartTime": "<p>The start time, in milliseconds, of the <code>Result</code>.</p>",
249-
"Result$EndTime": "<p>The end time, in milliseconds, of the <code>Result</code>.</p>"
248+
"Result$StartTime": "<p>The start time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>",
249+
"Result$EndTime": "<p>The end time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>"
250250
}
251251
},
252252
"Entity": {
@@ -263,13 +263,11 @@
263263
},
264264
"GetMedicalScribeStreamRequest": {
265265
"base": null,
266-
"refs": {
267-
}
266+
"refs": {}
268267
},
269268
"GetMedicalScribeStreamResponse": {
270269
"base": null,
271-
"refs": {
272-
}
270+
"refs": {}
273271
},
274272
"IamRoleArn": {
275273
"base": null,
@@ -546,7 +544,7 @@
546544
"MedicalScribeNoteTemplate": {
547545
"base": null,
548546
"refs": {
549-
"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>"
547+
"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. Examples of 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. Examples of sections include Goal, Intervention, Response, Progress, and Plan.</p> </li> <li> <p>BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.</p> </li> <li> <p>SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.</p> </li> <li> <p>DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.</p> </li> <li> <p>BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.</p> </li> <li> <p>PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.</p> </li> </ul>"
550548
}
551549
},
552550
"MedicalScribeParticipantRole": {
@@ -732,8 +730,7 @@
732730
},
733731
"ResourceNotFoundException": {
734732
"base": "<p>The request references a resource which doesn't exist.</p>",
735-
"refs": {
736-
}
733+
"refs": {}
737734
},
738735
"Result": {
739736
"base": "<p>The <code>Result</code> associated with a <code/>.</p> <p>Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.</p>",
@@ -793,43 +790,35 @@
793790
},
794791
"StartCallAnalyticsStreamTranscriptionRequest": {
795792
"base": null,
796-
"refs": {
797-
}
793+
"refs": {}
798794
},
799795
"StartCallAnalyticsStreamTranscriptionResponse": {
800796
"base": null,
801-
"refs": {
802-
}
797+
"refs": {}
803798
},
804799
"StartMedicalScribeStreamRequest": {
805800
"base": null,
806-
"refs": {
807-
}
801+
"refs": {}
808802
},
809803
"StartMedicalScribeStreamResponse": {
810804
"base": null,
811-
"refs": {
812-
}
805+
"refs": {}
813806
},
814807
"StartMedicalStreamTranscriptionRequest": {
815808
"base": null,
816-
"refs": {
817-
}
809+
"refs": {}
818810
},
819811
"StartMedicalStreamTranscriptionResponse": {
820812
"base": null,
821-
"refs": {
822-
}
813+
"refs": {}
823814
},
824815
"StartStreamTranscriptionRequest": {
825816
"base": null,
826-
"refs": {
827-
}
817+
"refs": {}
828818
},
829819
"StartStreamTranscriptionResponse": {
830820
"base": null,
831-
"refs": {
832-
}
821+
"refs": {}
833822
},
834823
"String": {
835824
"base": null,
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
22
"version": "1.0",
3-
"examples": {
4-
}
3+
"examples": {}
54
}

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

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@
361361
},
362362
"NoteTemplate":{
363363
"shape":"MedicalScribeNoteTemplate",
364-
"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>"
364+
"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. Examples of 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. Examples of sections include Goal, Intervention, Response, Progress, and Plan.</p> </li> <li> <p>BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.</p> </li> <li> <p>SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.</p> </li> <li> <p>DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.</p> </li> <li> <p>BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.</p> </li> <li> <p>PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.</p> </li> </ul>"
365365
}
366366
},
367367
"documentation":"<p>The output configuration for aggregated transcript and clinical note generation.</p>"
@@ -421,11 +421,11 @@
421421
"members":{
422422
"StartTime":{
423423
"shape":"Double",
424-
"documentation":"<p>The start time, in milliseconds, of the utterance that was identified as PII.</p>"
424+
"documentation":"<p>The start time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)</p>"
425425
},
426426
"EndTime":{
427427
"shape":"Double",
428-
"documentation":"<p>The end time, in milliseconds, of the utterance that was identified as PII.</p>"
428+
"documentation":"<p>The end time of the utterance that was identified as PII in seconds, with millisecond precision (e.g., 1.056)</p>"
429429
},
430430
"Category":{
431431
"shape":"String",
@@ -507,11 +507,11 @@
507507
"members":{
508508
"StartTime":{
509509
"shape":"Double",
510-
"documentation":"<p>The start time, in milliseconds, of the transcribed item.</p>"
510+
"documentation":"<p>The start time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)</p>"
511511
},
512512
"EndTime":{
513513
"shape":"Double",
514-
"documentation":"<p>The end time, in milliseconds, of the transcribed item.</p>"
514+
"documentation":"<p>The end time of the transcribed item in seconds, with millisecond precision (e.g., 1.056)</p>"
515515
},
516516
"Type":{
517517
"shape":"ItemType",
@@ -706,11 +706,11 @@
706706
"members":{
707707
"StartTime":{
708708
"shape":"Double",
709-
"documentation":"<p>The start time, in milliseconds, of the utterance that was identified as PHI.</p>"
709+
"documentation":"<p>The start time, in seconds, of the utterance that was identified as PHI.</p>"
710710
},
711711
"EndTime":{
712712
"shape":"Double",
713-
"documentation":"<p>The end time, in milliseconds, of the utterance that was identified as PHI.</p>"
713+
"documentation":"<p>The end time, in seconds, of the utterance that was identified as PHI.</p>"
714714
},
715715
"Category":{
716716
"shape":"String",
@@ -736,11 +736,11 @@
736736
"members":{
737737
"StartTime":{
738738
"shape":"Double",
739-
"documentation":"<p>The start time, in milliseconds, of the transcribed item.</p>"
739+
"documentation":"<p>The start time, in seconds, of the transcribed item.</p>"
740740
},
741741
"EndTime":{
742742
"shape":"Double",
743-
"documentation":"<p>The end time, in milliseconds, of the transcribed item.</p>"
743+
"documentation":"<p>The end time, in seconds, of the transcribed item.</p>"
744744
},
745745
"Type":{
746746
"shape":"ItemType",
@@ -774,11 +774,11 @@
774774
},
775775
"StartTime":{
776776
"shape":"Double",
777-
"documentation":"<p>The start time, in milliseconds, of the <code>Result</code>.</p>"
777+
"documentation":"<p>The start time, in seconds, of the <code>Result</code>.</p>"
778778
},
779779
"EndTime":{
780780
"shape":"Double",
781-
"documentation":"<p>The end time, in milliseconds, of the <code>Result</code>.</p>"
781+
"documentation":"<p>The end time, in seconds, of the <code>Result</code>.</p>"
782782
},
783783
"IsPartial":{
784784
"shape":"Boolean",
@@ -932,7 +932,12 @@
932932
"type":"string",
933933
"enum":[
934934
"HISTORY_AND_PHYSICAL",
935-
"GIRPP"
935+
"GIRPP",
936+
"DAP",
937+
"SIRP",
938+
"BIRP",
939+
"BEHAVIORAL_SOAP",
940+
"PHYSICAL_SOAP"
936941
]
937942
},
938943
"MedicalScribeParticipantRole":{
@@ -1297,11 +1302,11 @@
12971302
},
12981303
"StartTime":{
12991304
"shape":"Double",
1300-
"documentation":"<p>The start time, in milliseconds, of the <code>Result</code>.</p>"
1305+
"documentation":"<p>The start time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>"
13011306
},
13021307
"EndTime":{
13031308
"shape":"Double",
1304-
"documentation":"<p>The end time, in milliseconds, of the <code>Result</code>.</p>"
1309+
"documentation":"<p>The end time of the <code>Result</code> in seconds, with millisecond precision (e.g., 1.056).</p>"
13051310
},
13061311
"IsPartial":{
13071312
"shape":"Boolean",
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
{
2-
"pagination": {
3-
}
2+
"pagination": {}
43
}

sdk/src/Services/TranscribeStreaming/Generated/Model/ClinicalNoteGenerationSettings.cs

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,38 @@ public partial class ClinicalNoteGenerationSettings
4646
/// <ul> <li>
4747
/// <para>
4848
/// HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation.
49-
/// Sections include Chief Complaint, History of Present Illness, Review of Systems, Past
50-
/// Medical History, Assessment, and Plan.
49+
/// Examples of sections include Chief Complaint, History of Present Illness, Review of
50+
/// Systems, Past Medical History, Assessment, and Plan.
5151
/// </para>
5252
/// </li> <li>
5353
/// <para>
54-
/// GIRPP: Provides summaries based on the patients progress toward goals. Sections include
55-
/// Goal, Intervention, Response, Progress, and Plan.
54+
/// GIRPP: Provides summaries based on the patients progress toward goals. Examples of
55+
/// sections include Goal, Intervention, Response, Progress, and Plan.
56+
/// </para>
57+
/// </li> <li>
58+
/// <para>
59+
/// BIRP: Focuses on the patient's behavioral patterns and responses. Examples of sections
60+
/// include Behavior, Intervention, Response, and Plan.
61+
/// </para>
62+
/// </li> <li>
63+
/// <para>
64+
/// SIRP: Emphasizes the situational context of therapy. Examples of sections include
65+
/// Situation, Intervention, Response, and Plan.
66+
/// </para>
67+
/// </li> <li>
68+
/// <para>
69+
/// DAP: Provides a simplified format for clinical documentation. Examples of sections
70+
/// include Data, Assessment, and Plan.
71+
/// </para>
72+
/// </li> <li>
73+
/// <para>
74+
/// BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections
75+
/// include Subjective, Objective, Assessment, and Plan.
76+
/// </para>
77+
/// </li> <li>
78+
/// <para>
79+
/// PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections
80+
/// include Subjective, Objective, Assessment, and Plan.
5681
/// </para>
5782
/// </li> </ul>
5883
/// </summary>

sdk/src/Services/TranscribeStreaming/Generated/Model/Entity.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ internal bool IsSetContent()
105105
/// <summary>
106106
/// Gets and sets the property EndTime.
107107
/// <para>
108-
/// The end time, in milliseconds, of the utterance that was identified as PII.
108+
/// The end time of the utterance that was identified as PII in seconds, with millisecond
109+
/// precision (e.g., 1.056)
109110
/// </para>
110111
/// </summary>
111112
public double? EndTime
@@ -123,7 +124,8 @@ internal bool IsSetEndTime()
123124
/// <summary>
124125
/// Gets and sets the property StartTime.
125126
/// <para>
126-
/// The start time, in milliseconds, of the utterance that was identified as PII.
127+
/// The start time of the utterance that was identified as PII in seconds, with millisecond
128+
/// precision (e.g., 1.056)
127129
/// </para>
128130
/// </summary>
129131
public double? StartTime

sdk/src/Services/TranscribeStreaming/Generated/Model/Item.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ internal bool IsSetContent()
8888
/// <summary>
8989
/// Gets and sets the property EndTime.
9090
/// <para>
91-
/// The end time, in milliseconds, of the transcribed item.
91+
/// The end time of the transcribed item in seconds, with millisecond precision (e.g.,
92+
/// 1.056)
9293
/// </para>
9394
/// </summary>
9495
public double? EndTime
@@ -144,7 +145,8 @@ internal bool IsSetStable()
144145
/// <summary>
145146
/// Gets and sets the property StartTime.
146147
/// <para>
147-
/// The start time, in milliseconds, of the transcribed item.
148+
/// The start time of the transcribed item in seconds, with millisecond precision (e.g.,
149+
/// 1.056)
148150
/// </para>
149151
/// </summary>
150152
public double? StartTime

sdk/src/Services/TranscribeStreaming/Generated/Model/MedicalEntity.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ internal bool IsSetContent()
104104
/// <summary>
105105
/// Gets and sets the property EndTime.
106106
/// <para>
107-
/// The end time, in milliseconds, of the utterance that was identified as PHI.
107+
/// The end time, in seconds, of the utterance that was identified as PHI.
108108
/// </para>
109109
/// </summary>
110110
public double? EndTime
@@ -122,7 +122,7 @@ internal bool IsSetEndTime()
122122
/// <summary>
123123
/// Gets and sets the property StartTime.
124124
/// <para>
125-
/// The start time, in milliseconds, of the utterance that was identified as PHI.
125+
/// The start time, in seconds, of the utterance that was identified as PHI.
126126
/// </para>
127127
/// </summary>
128128
public double? StartTime

sdk/src/Services/TranscribeStreaming/Generated/Model/MedicalItem.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ internal bool IsSetContent()
8686
/// <summary>
8787
/// Gets and sets the property EndTime.
8888
/// <para>
89-
/// The end time, in milliseconds, of the transcribed item.
89+
/// The end time, in seconds, of the transcribed item.
9090
/// </para>
9191
/// </summary>
9292
public double? EndTime
@@ -123,7 +123,7 @@ internal bool IsSetSpeaker()
123123
/// <summary>
124124
/// Gets and sets the property StartTime.
125125
/// <para>
126-
/// The start time, in milliseconds, of the transcribed item.
126+
/// The start time, in seconds, of the transcribed item.
127127
/// </para>
128128
/// </summary>
129129
public double? StartTime

0 commit comments

Comments
 (0)