Skip to content

Commit dae0d16

Browse files
AWS HealthScribe now supports specifying preferred patient pronouns through the MedicalScribeContext parameter for use in the generated clinical notes.
1 parent ae215ef commit dae0d16

19 files changed

+626
-67
lines changed

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

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1621,6 +1621,12 @@
16211621
"max":1,
16221622
"min":0
16231623
},
1624+
"MedicalScribeContext":{
1625+
"type":"structure",
1626+
"members":{
1627+
"PatientContext":{"shape":"MedicalScribePatientContext"}
1628+
}
1629+
},
16241630
"MedicalScribeJob":{
16251631
"type":"structure",
16261632
"members":{
@@ -1636,6 +1642,7 @@
16361642
"Settings":{"shape":"MedicalScribeSettings"},
16371643
"DataAccessRoleArn":{"shape":"DataAccessRoleArn"},
16381644
"ChannelDefinitions":{"shape":"MedicalScribeChannelDefinitions"},
1645+
"MedicalScribeContextProvided":{"shape":"Boolean"},
16391646
"Tags":{"shape":"TagList"}
16401647
}
16411648
},
@@ -1698,6 +1705,12 @@
16981705
"CLINICIAN"
16991706
]
17001707
},
1708+
"MedicalScribePatientContext":{
1709+
"type":"structure",
1710+
"members":{
1711+
"Pronouns":{"shape":"Pronouns"}
1712+
}
1713+
},
17011714
"MedicalScribeSettings":{
17021715
"type":"structure",
17031716
"members":{
@@ -1882,6 +1895,15 @@
18821895
"max":11,
18831896
"min":0
18841897
},
1898+
"Pronouns":{
1899+
"type":"string",
1900+
"enum":[
1901+
"HE_HIM",
1902+
"SHE_HER",
1903+
"THEY_THEM"
1904+
],
1905+
"sensitive":true
1906+
},
18851907
"RedactionOutput":{
18861908
"type":"string",
18871909
"enum":[
@@ -2002,7 +2024,8 @@
20022024
"DataAccessRoleArn":{"shape":"DataAccessRoleArn"},
20032025
"Settings":{"shape":"MedicalScribeSettings"},
20042026
"ChannelDefinitions":{"shape":"MedicalScribeChannelDefinitions"},
2005-
"Tags":{"shape":"TagList"}
2027+
"Tags":{"shape":"TagList"},
2028+
"MedicalScribeContext":{"shape":"MedicalScribeContext"}
20062029
}
20072030
},
20082031
"StartMedicalScribeJobResponse":{

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

Lines changed: 26 additions & 7 deletions
Large diffs are not rendered by default.

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

Lines changed: 44 additions & 7 deletions
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/*
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License").
5+
* You may not use this file except in compliance with the License.
6+
* A copy of the License is located at
7+
*
8+
* http://aws.amazon.com/apache2.0
9+
*
10+
* or in the "license" file accompanying this file. This file is distributed
11+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
* express or implied. See the License for the specific language governing
13+
* permissions and limitations under the License.
14+
*/
15+
16+
/*
17+
* Do not modify this file. This file is generated from the transcribe-2017-10-26.normal.json service model.
18+
*/
19+
using System;
20+
using System.Collections.Generic;
21+
using System.Globalization;
22+
using System.IO;
23+
using System.Text;
24+
using System.Xml.Serialization;
25+
26+
using Amazon.TranscribeService.Model;
27+
using Amazon.Runtime;
28+
using Amazon.Runtime.Internal;
29+
using Amazon.Runtime.Internal.Transform;
30+
using Amazon.Runtime.Internal.Util;
31+
#pragma warning disable CS0612,CS0618
32+
namespace Amazon.TranscribeService.Model.Internal.MarshallTransformations
33+
{
34+
/// <summary>
35+
/// MedicalScribeContext Marshaller
36+
/// </summary>
37+
public class MedicalScribeContextMarshaller : IRequestMarshaller<MedicalScribeContext, JsonMarshallerContext>
38+
{
39+
/// <summary>
40+
/// Unmarshaller the response from the service to the response class.
41+
/// </summary>
42+
/// <param name="requestObject"></param>
43+
/// <param name="context"></param>
44+
/// <returns></returns>
45+
public void Marshall(MedicalScribeContext requestObject, JsonMarshallerContext context)
46+
{
47+
if(requestObject == null)
48+
return;
49+
if(requestObject.IsSetPatientContext())
50+
{
51+
context.Writer.WritePropertyName("PatientContext");
52+
context.Writer.WriteStartObject();
53+
54+
var marshaller = MedicalScribePatientContextMarshaller.Instance;
55+
marshaller.Marshall(requestObject.PatientContext, context);
56+
57+
context.Writer.WriteEndObject();
58+
}
59+
60+
}
61+
62+
/// <summary>
63+
/// Singleton Marshaller.
64+
/// </summary>
65+
public readonly static MedicalScribeContextMarshaller Instance = new MedicalScribeContextMarshaller();
66+
67+
}
68+
}

sdk/src/Services/TranscribeService/Generated/Model/Internal/MarshallTransformations/MedicalScribeJobUnmarshaller.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ public MedicalScribeJob Unmarshall(JsonUnmarshallerContext context, ref Streamin
9898
unmarshalledObject.Media = unmarshaller.Unmarshall(context, ref reader);
9999
continue;
100100
}
101+
if (context.TestExpression("MedicalScribeContextProvided", targetDepth))
102+
{
103+
var unmarshaller = NullableBoolUnmarshaller.Instance;
104+
unmarshalledObject.MedicalScribeContextProvided = unmarshaller.Unmarshall(context, ref reader);
105+
continue;
106+
}
101107
if (context.TestExpression("MedicalScribeJobName", targetDepth))
102108
{
103109
var unmarshaller = StringUnmarshaller.Instance;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/*
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License").
5+
* You may not use this file except in compliance with the License.
6+
* A copy of the License is located at
7+
*
8+
* http://aws.amazon.com/apache2.0
9+
*
10+
* or in the "license" file accompanying this file. This file is distributed
11+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
* express or implied. See the License for the specific language governing
13+
* permissions and limitations under the License.
14+
*/
15+
16+
/*
17+
* Do not modify this file. This file is generated from the transcribe-2017-10-26.normal.json service model.
18+
*/
19+
using System;
20+
using System.Collections.Generic;
21+
using System.Globalization;
22+
using System.IO;
23+
using System.Text;
24+
using System.Xml.Serialization;
25+
26+
using Amazon.TranscribeService.Model;
27+
using Amazon.Runtime;
28+
using Amazon.Runtime.Internal;
29+
using Amazon.Runtime.Internal.Transform;
30+
using Amazon.Runtime.Internal.Util;
31+
#pragma warning disable CS0612,CS0618
32+
namespace Amazon.TranscribeService.Model.Internal.MarshallTransformations
33+
{
34+
/// <summary>
35+
/// MedicalScribePatientContext Marshaller
36+
/// </summary>
37+
public class MedicalScribePatientContextMarshaller : IRequestMarshaller<MedicalScribePatientContext, JsonMarshallerContext>
38+
{
39+
/// <summary>
40+
/// Unmarshaller the response from the service to the response class.
41+
/// </summary>
42+
/// <param name="requestObject"></param>
43+
/// <param name="context"></param>
44+
/// <returns></returns>
45+
public void Marshall(MedicalScribePatientContext requestObject, JsonMarshallerContext context)
46+
{
47+
if(requestObject == null)
48+
return;
49+
if(requestObject.IsSetPronouns())
50+
{
51+
context.Writer.WritePropertyName("Pronouns");
52+
context.Writer.WriteStringValue(requestObject.Pronouns);
53+
}
54+
55+
}
56+
57+
/// <summary>
58+
/// Singleton Marshaller.
59+
/// </summary>
60+
public readonly static MedicalScribePatientContextMarshaller Instance = new MedicalScribePatientContextMarshaller();
61+
62+
}
63+
}

sdk/src/Services/TranscribeService/Generated/Model/Internal/MarshallTransformations/StartMedicalScribeJobRequestMarshaller.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,17 @@ public IRequest Marshall(StartMedicalScribeJobRequest publicRequest)
122122
context.Writer.WriteEndObject();
123123
}
124124

125+
if(publicRequest.IsSetMedicalScribeContext())
126+
{
127+
context.Writer.WritePropertyName("MedicalScribeContext");
128+
context.Writer.WriteStartObject();
129+
130+
var marshaller = MedicalScribeContextMarshaller.Instance;
131+
marshaller.Marshall(publicRequest.MedicalScribeContext, context);
132+
133+
context.Writer.WriteEndObject();
134+
}
135+
125136
if(publicRequest.IsSetMedicalScribeJobName())
126137
{
127138
context.Writer.WritePropertyName("MedicalScribeJobName");
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
/*
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License").
5+
* You may not use this file except in compliance with the License.
6+
* A copy of the License is located at
7+
*
8+
* http://aws.amazon.com/apache2.0
9+
*
10+
* or in the "license" file accompanying this file. This file is distributed
11+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
* express or implied. See the License for the specific language governing
13+
* permissions and limitations under the License.
14+
*/
15+
16+
/*
17+
* Do not modify this file. This file is generated from the transcribe-2017-10-26.normal.json service model.
18+
*/
19+
using System;
20+
using System.Collections.Generic;
21+
using System.Xml.Serialization;
22+
using System.Text;
23+
using System.IO;
24+
using System.Net;
25+
26+
using Amazon.Runtime;
27+
using Amazon.Runtime.Internal;
28+
29+
#pragma warning disable CS0612,CS0618,CS1570
30+
namespace Amazon.TranscribeService.Model
31+
{
32+
/// <summary>
33+
/// The <c>MedicalScribeContext</c> object that contains contextual information used to
34+
/// generate customized clinical notes.
35+
/// </summary>
36+
public partial class MedicalScribeContext
37+
{
38+
private MedicalScribePatientContext _patientContext;
39+
40+
/// <summary>
41+
/// Gets and sets the property PatientContext.
42+
/// <para>
43+
/// Contains patient-specific information.
44+
/// </para>
45+
/// </summary>
46+
public MedicalScribePatientContext PatientContext
47+
{
48+
get { return this._patientContext; }
49+
set { this._patientContext = value; }
50+
}
51+
52+
// Check to see if PatientContext property is set
53+
internal bool IsSetPatientContext()
54+
{
55+
return this._patientContext != null;
56+
}
57+
58+
}
59+
}

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

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ public partial class MedicalScribeJob
5050
private string _failureReason;
5151
private MedicalScribeLanguageCode _languageCode;
5252
private Media _media;
53+
private bool? _medicalScribeContextProvided;
5354
private string _medicalScribeJobName;
5455
private MedicalScribeJobStatus _medicalScribeJobStatus;
5556
private MedicalScribeOutput _medicalScribeOutput;
@@ -221,6 +222,25 @@ internal bool IsSetMedia()
221222
return this._media != null;
222223
}
223224

225+
/// <summary>
226+
/// Gets and sets the property MedicalScribeContextProvided.
227+
/// <para>
228+
/// Indicates whether the <c>MedicalScribeContext</c> object was provided when the Medical
229+
/// Scribe job was started.
230+
/// </para>
231+
/// </summary>
232+
public bool? MedicalScribeContextProvided
233+
{
234+
get { return this._medicalScribeContextProvided; }
235+
set { this._medicalScribeContextProvided = value; }
236+
}
237+
238+
// Check to see if MedicalScribeContextProvided property is set
239+
internal bool IsSetMedicalScribeContextProvided()
240+
{
241+
return this._medicalScribeContextProvided.HasValue;
242+
}
243+
224244
/// <summary>
225245
/// Gets and sets the property MedicalScribeJobName.
226246
/// <para>
@@ -337,7 +357,7 @@ internal bool IsSetStartTime()
337357
/// <summary>
338358
/// Gets and sets the property Tags.
339359
/// <para>
340-
/// Adds one or more custom tags, each in the form of a key:value pair, to the Medica
360+
/// Adds one or more custom tags, each in the form of a key:value pair, to the Medical
341361
/// Scribe job.
342362
/// </para>
343363
///
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/*
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License").
5+
* You may not use this file except in compliance with the License.
6+
* A copy of the License is located at
7+
*
8+
* http://aws.amazon.com/apache2.0
9+
*
10+
* or in the "license" file accompanying this file. This file is distributed
11+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
* express or implied. See the License for the specific language governing
13+
* permissions and limitations under the License.
14+
*/
15+
16+
/*
17+
* Do not modify this file. This file is generated from the transcribe-2017-10-26.normal.json service model.
18+
*/
19+
using System;
20+
using System.Collections.Generic;
21+
using System.Xml.Serialization;
22+
using System.Text;
23+
using System.IO;
24+
using System.Net;
25+
26+
using Amazon.Runtime;
27+
using Amazon.Runtime.Internal;
28+
29+
#pragma warning disable CS0612,CS0618,CS1570
30+
namespace Amazon.TranscribeService.Model
31+
{
32+
/// <summary>
33+
/// Contains patient-specific information used to customize the clinical note generation.
34+
/// </summary>
35+
public partial class MedicalScribePatientContext
36+
{
37+
private Pronouns _pronouns;
38+
39+
/// <summary>
40+
/// Gets and sets the property Pronouns.
41+
/// <para>
42+
/// The patient's preferred pronouns that the user wants to provide as a context for clinical
43+
/// note generation.
44+
/// </para>
45+
/// </summary>
46+
[AWSProperty(Sensitive=true)]
47+
public Pronouns Pronouns
48+
{
49+
get { return this._pronouns; }
50+
set { this._pronouns = value; }
51+
}
52+
53+
// Check to see if Pronouns property is set
54+
internal bool IsSetPronouns()
55+
{
56+
return this._pronouns != null;
57+
}
58+
59+
}
60+
}

0 commit comments

Comments
 (0)