Interface ClinicalNoteGenerationResult.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ClinicalNoteGenerationResult.Builder,ClinicalNoteGenerationResult>, SdkBuilder<ClinicalNoteGenerationResult.Builder,ClinicalNoteGenerationResult>, SdkPojo
Enclosing class:
ClinicalNoteGenerationResult
@Mutable @NotThreadSafe public static interface ClinicalNoteGenerationResult.Builder extends SdkPojo, CopyableBuilder<ClinicalNoteGenerationResult.Builder,ClinicalNoteGenerationResult>

  • Method Details

    • clinicalNoteOutputLocation

      ClinicalNoteGenerationResult.Builder clinicalNoteOutputLocation(String clinicalNoteOutputLocation)

      Holds the Amazon S3 URI for the output Clinical Note.

      Parameters:
      clinicalNoteOutputLocation - Holds the Amazon S3 URI for the output Clinical Note.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transcriptOutputLocation

      ClinicalNoteGenerationResult.Builder transcriptOutputLocation(String transcriptOutputLocation)

      Holds the Amazon S3 URI for the output Transcript.

      Parameters:
      transcriptOutputLocation - Holds the Amazon S3 URI for the output Transcript.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ClinicalNoteGenerationResult.Builder status(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ClinicalNoteGenerationResult.Builder status(ClinicalNoteGenerationStatus 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureReason

      ClinicalNoteGenerationResult.Builder failureReason(String failureReason)

      If ClinicalNoteGenerationResult is FAILED, information about why it failed.

      Parameters:
      failureReason - If ClinicalNoteGenerationResult is FAILED, information about why it failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.