MedicalScribeJob
Provides detailed information about a Medical Scribe job.
To view the status of the specified Medical Scribe job, check the MedicalScribeJobStatus
field. If the status is COMPLETED
, the job is finished and you can find the results at the locations specified in MedicalScribeOutput
. If the status is FAILED
, FailureReason
provides details on why your Medical Scribe job failed.
Types
Properties
Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId
of the first ChannelDefinition
in the list to 0
(to indicate the first channel) and ParticipantRole
to CLINICIAN
(to indicate that it's the clinician speaking). Then you would set the ChannelId
of the second ChannelDefinition
in the list to 1
(to indicate the second channel) and ParticipantRole
to PATIENT
(to indicate that it's the patient speaking).
The date and time the specified Medical Scribe job finished processing.
The date and time the specified Medical Scribe job request was made.
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.
If MedicalScribeJobStatus
is FAILED
, FailureReason
contains information about why the transcription job failed. See also: Common Errors.
The language code used to create your Medical Scribe job. US English (en-US
) is the only supported language for Medical Scribe jobs.
The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
Provides the status of the specified Medical Scribe job.
The location of the output of your Medical Scribe job. ClinicalDocumentUri
holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri
holds the Amazon S3 URI for the Transcript.
Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings
object. Specify ChannelIdentification
if ChannelDefinitions
are set. Enabled ShowSpeakerLabels
if ChannelIdentification
and ChannelDefinitions
are not set. One and only one of ChannelIdentification
and ShowSpeakerLabels
must be set. If ShowSpeakerLabels
is set, MaxSpeakerLabels
must also be set. Use Settings
to specify a vocabulary or vocabulary filter or both using VocabularyName
, VocabularyFilterName
. VocabularyFilterMethod
must be specified if VocabularyFilterName
is set.