MedicalScribeStreamDetails ¶

class MedicalScribeStreamDetails(TypedDict, closed=True):
    session_id: NotRequired["capo_transcribe_streaming.types.session_id.SessionId"]
    """<p>The identifier of the HealthScribe streaming session.</p>"""
    stream_created_at: NotRequired["capo_transcribe_streaming.types.date_time.DateTime"]
    """<p>The date and time when the HealthScribe streaming session was created.</p>"""
    stream_ended_at: NotRequired["capo_transcribe_streaming.types.date_time.DateTime"]
    """<p>The date and time when the HealthScribe streaming session was ended.</p>"""
    language_code: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_language_code.MedicalScribeLanguageCode"
    ]
    """<p>The Language Code of the HealthScribe streaming session.</p>"""
    media_sample_rate_hertz: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_media_sample_rate_hertz.MedicalScribeMediaSampleRateHertz"
    ]
    """<p>The sample rate (in hertz) of the HealthScribe streaming session.</p>"""
    media_encoding: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_media_encoding.MedicalScribeMediaEncoding"
    ]
    """<p>The Media Encoding of the HealthScribe streaming session.</p>"""
    vocabulary_name: NotRequired[
        "capo_transcribe_streaming.types.vocabulary_name.VocabularyName"
    ]
    """<p>The vocabulary name of the HealthScribe streaming session.</p>"""
    vocabulary_filter_name: NotRequired[
        "capo_transcribe_streaming.types.vocabulary_filter_name.VocabularyFilterName"
    ]
    """<p>The name of the vocabulary filter used for the HealthScribe streaming session .</p>"""
    vocabulary_filter_method: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_vocabulary_filter_method.MedicalScribeVocabularyFilterMethod"
    ]
    """<p>The method of the vocabulary filter for the HealthScribe streaming session.</p>"""
    resource_access_role_arn: NotRequired[
        "capo_transcribe_streaming.types.iam_role_arn.IamRoleArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.</p>"""
    channel_definitions: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_channel_definitions.MedicalScribeChannelDefinitions"
    ]
    """<p>The Channel Definitions of the HealthScribe streaming session.</p>"""
    encryption_settings: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_encryption_settings.MedicalScribeEncryptionSettings"
    ]
    """<p>The Encryption Settings of the HealthScribe streaming session.</p>"""
    stream_status: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_stream_status.MedicalScribeStreamStatus"
    ]
    """<p>The streaming status of the HealthScribe streaming session.</p> <p>Possible Values:</p> <ul> <li> <p> <code>IN_PROGRESS</code> </p> </li> <li> <p> <code>PAUSED</code> </p> </li> <li> <p> <code>FAILED</code> </p> </li> <li> <p> <code>COMPLETED</code> </p> </li> </ul> <note> <p>This status is specific to real-time streaming. A <code>COMPLETED</code> status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the <code>Status</code> field for the analytics result within the <code>MedicalScribePostStreamAnalyticsResult</code>. For example, you can view the status of the <code>ClinicalNoteGenerationResult</code>. </p> </note>"""
    post_stream_analytics_settings: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_post_stream_analytics_settings.MedicalScribePostStreamAnalyticsSettings"
    ]
    """<p>The post-stream analytics settings of the HealthScribe streaming session.</p>"""
    post_stream_analytics_result: NotRequired[
        "capo_transcribe_streaming.types.medical_scribe_post_stream_analytics_result.MedicalScribePostStreamAnalyticsResult"
    ]
    """<p>The result of post-stream analytics for the HealthScribe streaming session.</p>"""
    medical_scribe_context_provided: NotRequired[
        "capo_transcribe_streaming.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Indicates whether the <code>MedicalScribeContext</code> object was provided when the stream was started.</p>"""