Transcribe Streaming  >  Structures  >  MedicalScribeConfigurationEvent

MedicalScribeConfigurationEvent

Structure Class

MedicalScribeConfigurationEvent dataclass

Specify details to configure the streaming session, including channel definitions, encryption settings, post-stream analytics settings, resource access role ARN and vocabulary settings.

Whether you are starting a new session or resuming an existing session, your first event must be a MedicalScribeConfigurationEvent. If you are resuming a session, then this event must have the same configurations that you provided to start the session.

Attributes

channel_definitions class-attribute instance-attribute

channel_definitions: list[MedicalScribeChannelDefinition] | None = None

Specify which speaker is on which audio channel.

encryption_settings class-attribute instance-attribute

encryption_settings: MedicalScribeEncryptionSettings | None = None

Specify the encryption settings for your streaming session.

medical_scribe_context class-attribute instance-attribute

medical_scribe_context: MedicalScribeContext | None = None

The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.

post_stream_analytics_settings instance-attribute

post_stream_analytics_settings: MedicalScribePostStreamAnalyticsSettings

Specify settings for post-stream analytics.

resource_access_role_arn instance-attribute

resource_access_role_arn: str

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, 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 Amazon Web Services HealthScribe.

vocabulary_filter_method class-attribute instance-attribute

vocabulary_filter_method: MedicalScribeVocabularyFilterMethod | None = None

Specify how you want your custom vocabulary filter applied to the streaming session.

To replace words with ***, specify mask.

To delete words, specify remove.

To flag words without changing them, specify tag.

vocabulary_filter_name class-attribute instance-attribute

vocabulary_filter_name: str | None = None

Specify the name of the custom vocabulary filter you want to include in your streaming session. Custom vocabulary filter names are case-sensitive.

If you include VocabularyFilterName in the MedicalScribeConfigurationEvent, you must also include VocabularyFilterMethod.

vocabulary_name class-attribute instance-attribute

vocabulary_name: str | None = None

Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.