AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Transcribe Service StartMedicalScribeJob API operation.

Syntax

Start-TRSMedicalScribeJob
-MedicalScribeJobName <String>
-ChannelDefinition <MedicalScribeChannelDefinition[]>
-Settings_ChannelIdentification <Boolean>
-DataAccessRoleArn <String>
-KMSEncryptionContext <Hashtable>
-Settings_MaxSpeakerLabel <Int32>
-Media_MediaFileUri <String>
-ClinicalNoteGenerationSettings_NoteTemplate <MedicalScribeNoteTemplate>
-OutputBucketName <String>
-OutputEncryptionKMSKeyId <String>
-PatientContext_Pronoun <Pronouns>
-Media_RedactedMediaFileUri <String>
-Settings_ShowSpeakerLabel <Boolean>
-Tag <Tag[]>
-Settings_VocabularyFilterMethod <VocabularyFilterMethod>
-Settings_VocabularyFilterName <String>
-Settings_VocabularyName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonTranscribeServiceConfig>

Description

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.

Parameters

-ChannelDefinition <MedicalScribeChannelDefinition[]>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChannelDefinitions
-ClientConfig <AmazonTranscribeServiceConfig>
Amazon.PowerShell.Cmdlets.TRS.AmazonTranscribeServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClinicalNoteGenerationSettings_NoteTemplate <MedicalScribeNoteTemplate>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_ClinicalNoteGenerationSettings_NoteTemplate
-DataAccessRoleArn <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KMSEncryptionContext <Hashtable>
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Media_MediaFileUri <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Media_RedactedMediaFileUri <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MedicalScribeJobName <String>
A unique name, chosen by you, for your Medical Scribe job.This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-OutputBucketName <String>
The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3:// prefix of the specified bucket.Note that the role specified in the DataAccessRoleArn request parameter must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputEncryptionKMSKeyId <String>
The KMS key you want to use to encrypt your Medical Scribe output.If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
  1. Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
  2. Use an alias for the KMS key ID. For example, alias/ExampleAlias.
  3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
  4. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
  1. Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
  2. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).Note that the role specified in the DataAccessRoleArn request parameter must have permission to use the specified KMS key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the MedicalScribeJobName parameter. The -PassThru parameter is deprecated, use -Select '^MedicalScribeJobName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PatientContext_Pronoun <Pronouns>
The patient's preferred pronouns that the user wants to provide as a context for clinical note generation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMedicalScribeContext_PatientContext_Pronouns
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MedicalScribeJob'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.StartMedicalScribeJobResponse). Specifying the name of a property of type Amazon.TranscribeService.Model.StartMedicalScribeJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_ChannelIdentification <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_MaxSpeakerLabel <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_MaxSpeakerLabels
-Settings_ShowSpeakerLabel <Boolean>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSettings_ShowSpeakerLabels
-Settings_VocabularyFilterMethod <VocabularyFilterMethod>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_VocabularyFilterName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_VocabularyName <String>
The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Adds one or more custom tags, each in the form of a key:value pair, to the Medical Scribe job.To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.TranscribeService.Model.MedicalScribeJob or Amazon.TranscribeService.Model.StartMedicalScribeJobResponse
This cmdlet returns an Amazon.TranscribeService.Model.MedicalScribeJob object. The service call response (type Amazon.TranscribeService.Model.StartMedicalScribeJobResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z