medical_scribe_listening_sessions

Creates, updates, deletes, gets or lists a medical_scribe_listening_sessions resource.

Overview

Name	medical_scribe_listening_sessions
Type	Resource
Id	aws.connecthealth.medical_scribe_listening_sessions

Fields

The following fields are returned by SELECT queries:

get_medical_scribe_listening_session

Name	Datatype	Description
channel_definitions	array	Channel definitions for the audio stream
domain_id	string	The Domain identifier (pattern: <code>(hai-|dom-)[a-z0-9]+</code>)
encounter_context_provided	boolean	Indicates whether encounter context was provided
language_code	string	The Language Code for the audio in the session (en-US)
media_encoding	string	The encoding for the input audio (pcm, flac)
media_sample_rate_hertz	integer	The sample rate of the input audio
post_stream_action_result	object	Results of post-stream actions
post_stream_action_settings	object	Settings for post-stream actions
session_id	string	The Session identifier (pattern: <code>.[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}.</code>)
stream_creation_time	string (date-time)	The timestamp when the stream was created
stream_end_time	string (date-time)	The timestamp when the stream ended
stream_status	string	The current status of the stream (IN_PROGRESS, PAUSED, FAILED, COMPLETED)
subscription_id	string	The Subscription identifier (pattern: <code>sub-[a-zA-Z0-9]{21}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_medical_scribe_listening_session	select	session_id, domain_id, subscription_id, region		Retrieves details about an existing Medical Scribe listening session

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_id	string	The Domain identifier
region	string	AWS region (default: us-east-1)
session_id	string	The Session identifier
subscription_id	string	The Subscription identifier

SELECT examples

get_medical_scribe_listening_session

Retrieves details about an existing Medical Scribe listening session

SELECT
channel_definitions,
domain_id,
encounter_context_provided,
language_code,
media_encoding,
media_sample_rate_hertz,
post_stream_action_result,
post_stream_action_settings,
session_id,
stream_creation_time,
stream_end_time,
stream_status,
subscription_id
FROM aws.connecthealth.medical_scribe_listening_sessions
WHERE session_id = '{{ session_id }}' -- required
AND domain_id = '{{ domain_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND region = '{{ region }}' -- required
;