Class: Aws::TranscribeStreamingService::Types::ClinicalNoteGenerationResult

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribestreamingservice/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#clinical_note_output_location ⇒ String

Holds the Amazon S3 URI for the output Clinical Note.

Returns:

  • (String) 


340
341
342
343
344
345
346
347
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 340

class ClinicalNoteGenerationResult < Struct.new(
  :clinical_note_output_location,
  :transcript_output_location,
  :status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

If ‘ClinicalNoteGenerationResult` is `FAILED`, information about why it failed.

Returns:

  • (String) 


340
341
342
343
344
345
346
347
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 340

class ClinicalNoteGenerationResult < Struct.new(
  :clinical_note_output_location,
  :transcript_output_location,
  :status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

  • (String) 


340
341
342
343
344
345
346
347
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 340

class ClinicalNoteGenerationResult < Struct.new(
  :clinical_note_output_location,
  :transcript_output_location,
  :status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#transcript_output_location ⇒ String

Holds the Amazon S3 URI for the output Transcript.

Returns:

  • (String) 


340
341
342
343
344
345
346
347
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 340

class ClinicalNoteGenerationResult < Struct.new(
  :clinical_note_output_location,
  :transcript_output_location,
  :status,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end