AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The details for clinical note generation, including status, and output locations for clinical note and aggregated transcript if the analytics completed, or failure reason if the analytics failed.

Inheritance Hierarchy

System.Object
  Amazon.TranscribeStreaming.Model.ClinicalNoteGenerationResult

Namespace: Amazon.TranscribeStreaming.Model
Assembly: AWSSDK.TranscribeStreaming.dll
Version: 3.x.y.z

Syntax

C# 
public class ClinicalNoteGenerationResult

The ClinicalNoteGenerationResult type exposes the following members

Constructors

NameDescription
Public Method ClinicalNoteGenerationResult()

Properties

NameTypeDescription
Public Property ClinicalNoteOutputLocation System.String

Gets and sets the property ClinicalNoteOutputLocation.

Holds the Amazon S3 URI for the output Clinical Note.

Public Property FailureReason System.String

Gets and sets the property FailureReason.

If ClinicalNoteGenerationResult is FAILED, information about why it failed.

Public Property Status Amazon.TranscribeStreaming.ClinicalNoteGenerationStatus

Gets and sets the property Status.

The status of the clinical note generation.

Possible Values:

  • IN_PROGRESS

  • FAILED

  • COMPLETED

After audio streaming finishes, and you send a MedicalScribeSessionControlEvent event (with END_OF_SESSION as the Type), the status is set to IN_PROGRESS. If the status is COMPLETED, the analytics completed successfully, and you can find the results at the locations specified in ClinicalNoteOutputLocation and TranscriptOutputLocation. If the status is FAILED, FailureReason provides details about the failure.

Public Property TranscriptOutputLocation System.String

Gets and sets the property TranscriptOutputLocation.

Holds the Amazon S3 URI for the output Transcript.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer