Module Values.StartMedicalScribeJobResponseSource

Transcribes patient-clinician conversations and generates clinical notes. Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe. To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it. Media (MediaFileUri): The Amazon S3 location of your media file. MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account. OutputBucketName: The Amazon S3 bucket where you want your output files stored. Settings: A MedicalScribeSettings object that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set. ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true.

Sourcetype nonrec t = {
  1. medicalScribeJob : MedicalScribeJob.t option;
    (*

    Provides detailed information about the current Medical Scribe job, including job status and, if applicable, failure reason.

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequestException of BadRequestException.t
  2. | `ConflictException of ConflictException.t
  3. | `InternalFailureException of InternalFailureException.t
  4. | `LimitExceededException of LimitExceededException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?medicalScribeJob:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequestException of BadRequestException.t | `ConflictException of ConflictException.t | `InternalFailureException of InternalFailureException.t | `LimitExceededException of LimitExceededException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `BadRequestException of BadRequestException.t | `ConflictException of ConflictException.t | `InternalFailureException of InternalFailureException.t | `LimitExceededException of LimitExceededException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `Integer of MedicalScribeChannelId.t | `String of TagKey.t ]) list ] list | `String of TranscriptionJobName.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of MaxSpeakers.t | `String of Uri_.t | `Structure of (string * [> `Enum of string ]) list ]) list | `Timestamp of DateTime.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t