Get Medical Scribe Job

transcribeservice_get_medical_scribe_job

R Documentation

Provides information about the specified Medical Scribe job

Description

Provides information about the specified Medical Scribe job.

To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

To get a list of your Medical Scribe jobs, use the operation.

Usage

transcribeservice_get_medical_scribe_job(MedicalScribeJobName)

Arguments

MedicalScribeJobName

[required] The name of the Medical Scribe job you want information about. Job names are case sensitive.

Value

A list with the following syntax:

list(
  MedicalScribeJob = list(
    MedicalScribeJobName = "string",
    MedicalScribeJobStatus = "QUEUED"|"IN_PROGRESS"|"FAILED"|"COMPLETED",
    LanguageCode = "en-US",
    Media = list(
      MediaFileUri = "string",
      RedactedMediaFileUri = "string"
    ),
    MedicalScribeOutput = list(
      TranscriptFileUri = "string",
      ClinicalDocumentUri = "string"
    ),
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    CompletionTime = as.POSIXct(
      "2015-01-01"
    ),
    FailureReason = "string",
    Settings = list(
      ShowSpeakerLabels = TRUE|FALSE,
      MaxSpeakerLabels = 123,
      ChannelIdentification = TRUE|FALSE,
      VocabularyName = "string",
      VocabularyFilterName = "string",
      VocabularyFilterMethod = "remove"|"mask"|"tag"
    ),
    DataAccessRoleArn = "string",
    ChannelDefinitions = list(
      list(
        ChannelId = 123,
        ParticipantRole = "PATIENT"|"CLINICIAN"
      )
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$get_medical_scribe_job(
  MedicalScribeJobName = "string"
)