Transcribe Streaming  >  Structures  >  MedicalScribeStreamDetails

MedicalScribeStreamDetails

Structure Class

MedicalScribeStreamDetails dataclass

Contains details about a Amazon Web Services HealthScribe streaming session.

Attributes

channel_definitions class-attribute instance-attribute

channel_definitions: list[MedicalScribeChannelDefinition] | None = None

The Channel Definitions of the HealthScribe streaming session.

encryption_settings class-attribute instance-attribute

encryption_settings: MedicalScribeEncryptionSettings | None = None

The Encryption Settings of the HealthScribe streaming session.

language_code class-attribute instance-attribute

language_code: MedicalScribeLanguageCode | None = None

The Language Code of the HealthScribe streaming session.

media_encoding class-attribute instance-attribute

media_encoding: MedicalScribeMediaEncoding | None = None

The Media Encoding of the HealthScribe streaming session.

media_sample_rate_hertz class-attribute instance-attribute

media_sample_rate_hertz: int | None = None

The sample rate (in hertz) of the HealthScribe streaming session.

medical_scribe_context_provided class-attribute instance-attribute

medical_scribe_context_provided: bool | None = None

Indicates whether the MedicalScribeContext object was provided when the stream was started.

post_stream_analytics_result class-attribute instance-attribute

post_stream_analytics_result: MedicalScribePostStreamAnalyticsResult | None = None

The result of post-stream analytics for the HealthScribe streaming session.

post_stream_analytics_settings class-attribute instance-attribute

post_stream_analytics_settings: MedicalScribePostStreamAnalyticsSettings | None = None

The post-stream analytics settings of the HealthScribe streaming session.

resource_access_role_arn class-attribute instance-attribute

resource_access_role_arn: str | None = None

The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.

session_id class-attribute instance-attribute

session_id: str | None = None

The identifier of the HealthScribe streaming session.

stream_created_at class-attribute instance-attribute

stream_created_at: datetime | None = None

The date and time when the HealthScribe streaming session was created.

stream_ended_at class-attribute instance-attribute

stream_ended_at: datetime | None = None

The date and time when the HealthScribe streaming session was ended.

stream_status class-attribute instance-attribute

stream_status: MedicalScribeStreamStatus | None = None

The streaming status of the HealthScribe streaming session.

Possible Values:

• IN_PROGRESS

• PAUSED

• FAILED

• COMPLETED

Note

This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

vocabulary_filter_method class-attribute instance-attribute

vocabulary_filter_method: MedicalScribeVocabularyFilterMethod | None = None

The method of the vocabulary filter for the HealthScribe streaming session.

vocabulary_filter_name class-attribute instance-attribute

vocabulary_filter_name: str | None = None

The name of the vocabulary filter used for the HealthScribe streaming session .

vocabulary_name class-attribute instance-attribute

vocabulary_name: str | None = None

The vocabulary name of the HealthScribe streaming session.