aws_transcribe_medical_scribe_job

account_id

Type: STRING

channel_definitions

Type: UNORDERED_LIST_STRUCT
Provider name: ChannelDefinitions
Description: 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).

• channel_id
  Type: INT32
  Provider name: ChannelId
  Description: Specify the audio channel you want to define.
  
• participant_role
  Type: STRING
  Provider name: ParticipantRole
  Description: Specify the participant that you want to flag. The options are CLINICIAN and PATIENT
  

completion_time

Type: TIMESTAMP
Provider name: CompletionTime
Description: The date and time the specified Medical Scribe job finished processing. Timestamps are in the format YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.

creation_time

Type: TIMESTAMP
Provider name: CreationTime
Description: The date and time the specified Medical Scribe job request was made. Timestamps are in the format YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

data_access_role_arn

Type: STRING
Provider name: DataAccessRoleArn
Description: 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. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.

failure_reason

Type: STRING
Provider name: FailureReason
Description: If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

language_code

Type: STRING
Provider name: LanguageCode
Description: The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

media

Type: STRUCT
Provider name: Media

• media_file_uri
  Type: STRING
  Provider name: MediaFileUri
  Description: The Amazon S3 location of the media file you want to transcribe. For example:
  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
  Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you’re making your transcription request.
  
• redacted_media_file_uri
  Type: STRING
  Provider name: RedactedMediaFileUri
  Description: The Amazon S3 location of the media file you want to redact. For example:
  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
  Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you’re making your transcription request. RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.
  

medical_scribe_job_name

Type: STRING
Provider name: MedicalScribeJobName
Description: The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.

medical_scribe_job_status

Type: STRING
Provider name: MedicalScribeJobStatus
Description: Provides the status of the specified Medical Scribe job. If the status is COMPLETED, the job is finished and 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.

medical_scribe_output

Type: STRUCT
Provider name: MedicalScribeOutput
Description: 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.

• clinical_document_uri
  Type: STRING
  Provider name: ClinicalDocumentUri
  Description: Holds the Amazon S3 URI for the Clinical Document.
  
• transcript_file_uri
  Type: STRING
  Provider name: TranscriptFileUri
  Description: Holds the Amazon S3 URI for the Transcript.
  

settings

Type: STRUCT
Provider name: Settings
Description: 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.

• channel_identification
  Type: BOOLEAN
  Provider name: ChannelIdentification
  Description: Enables channel identification in multi-channel audio. Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript. For more information, see Transcribing multi-channel audio.
  
• clinical_note_generation_settings
  Type: STRUCT
  Provider name: ClinicalNoteGenerationSettings
  Description: Specify settings for the clinical note generation.
  
  • note_template
    Type: STRING
    Provider name: NoteTemplate
    Description: Specify one of the following templates to use for the clinical note summary. The default is HISTORY_AND_PHYSICAL.
    • HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.
    • GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention, Response, Progress, and Plan.
    • BIRP: Focuses on the patient’s behavioral patterns and responses. Examples of sections include Behavior, Intervention, Response, and Plan.
    • SIRP: Emphasizes the situational context of therapy. Examples of sections include Situation, Intervention, Response, and Plan.
    • DAP: Provides a simplified format for clinical documentation. Examples of sections include Data, Assessment, and Plan.
    • BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.
    • PHYSICAL_SOAP: Physical health focused documentation format. Examples of sections include Subjective, Objective, Assessment, and Plan.
• max_speaker_labels
  Type: INT32
  Provider name: MaxSpeakerLabels
  Description: Specify the maximum number of speakers you want to partition in your media. Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
  
• show_speaker_labels
  Type: BOOLEAN
  Provider name: ShowSpeakerLabels
  Description: Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. For more information, see Partitioning speakers (diarization).
  
• vocabulary_filter_method
  Type: STRING
  Provider name: VocabularyFilterMethod
  Description: Specify how you want your custom vocabulary filter applied to your transcript. To replace words with ***, choose mask. To delete words, choose remove. To flag words without changing them, choose tag.
  
• vocabulary_filter_name
  Type: STRING
  Provider name: VocabularyFilterName
  Description: The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive. Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
  
• vocabulary_name
  Type: STRING
  Provider name: VocabularyName
  Description: The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
  

start_time

Type: TIMESTAMP
Provider name: StartTime
Description: The date and time your Medical Scribe job began processing. Timestamps are in the format YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

tags

Type: UNORDERED_LIST_STRING