ClinicalNoteGenerationResult¶
Structure Class¶
dataclass
¶
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.
Attributes¶
class-attribute
instance-attribute
¶
clinical_note_output_location: str | None = None
Holds the Amazon S3 URI for the output Clinical Note.
class-attribute
instance-attribute
¶
failure_reason: str | None = None
If ClinicalNoteGenerationResult is FAILED, information about why it
failed.
class-attribute
instance-attribute
¶
status: ClinicalNoteGenerationStatus | None = None
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.
class-attribute
instance-attribute
¶
transcript_output_location: str | None = None
Holds the Amazon S3 URI for the output Transcript.