Skip to content

ClinicalNoteGenerationResult

Source code in docs_src/capo_transcribe_streaming/types/clinical_note_generation_result.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class ClinicalNoteGenerationResult(TypedDict, closed=True):
    clinical_note_output_location: NotRequired[
        "capo_transcribe_streaming.types.uri.Uri"
    ]
    """<p>Holds the Amazon S3 URI for the output Clinical Note. </p>"""
    transcript_output_location: NotRequired["capo_transcribe_streaming.types.uri.Uri"]
    """<p>Holds the Amazon S3 URI for the output Transcript. </p>"""
    status: NotRequired[
        "capo_transcribe_streaming.types.clinical_note_generation_status.ClinicalNoteGenerationStatus"
    ]
    """<p>The status of the clinical note generation.</p> <p>Possible Values:</p> <ul> <li> <p> <code>IN_PROGRESS</code> </p> </li> <li> <p> <code>FAILED</code> </p> </li> <li> <p> <code>COMPLETED</code> </p> </li> </ul> <p> After audio streaming finishes, and you send a <code>MedicalScribeSessionControlEvent</code> event (with END_OF_SESSION as the Type), the status is set to <code>IN_PROGRESS</code>. If the status is <code>COMPLETED</code>, the analytics completed successfully, and you can find the results at the locations specified in <code>ClinicalNoteOutputLocation</code> and <code>TranscriptOutputLocation</code>. If the status is <code>FAILED</code>, <code>FailureReason</code> provides details about the failure. </p>"""
    failure_reason: NotRequired["capo_transcribe_streaming.types.string.String"]
    """<p>If <code>ClinicalNoteGenerationResult</code> is <code>FAILED</code>, information about why it failed. </p>"""

clinical_note_output_location instance-attribute 

clinical_note_output_location: NotRequired[Uri]

Holds the Amazon S3 URI for the output Clinical Note.

failure_reason instance-attribute 

failure_reason: NotRequired[String]

If ClinicalNoteGenerationResult is FAILED, information about why it failed.

status instance-attribute 

status: NotRequired[ClinicalNoteGenerationStatus]

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.

transcript_output_location instance-attribute 

transcript_output_location: NotRequired[Uri]

Holds the Amazon S3 URI for the output Transcript.