ConnectHealth / Client / get_medical_scribe_listening_session

get_medical_scribe_listening_session

ConnectHealth.Client.get_medical_scribe_listening_session(**kwargs)

Retrieves details about an existing Medical Scribe listening session

See also: AWS API Documentation

Request Syntax

response = client.get_medical_scribe_listening_session(
    sessionId='string',
    domainId='string',
    subscriptionId='string'
)

Parameters:

• sessionId (string) –

  [REQUIRED]

  The Session identifier

• domainId (string) –

  [REQUIRED]

  The Domain identifier

• subscriptionId (string) –

  [REQUIRED]

  The Subscription identifier

Return type:

dict

Returns:

Response Syntax

{
    'medicalScribeListeningSessionDetails': {
        'sessionId': 'string',
        'domainId': 'string',
        'subscriptionId': 'string',
        'languageCode': 'en-US',
        'mediaSampleRateHertz': 123,
        'mediaEncoding': 'pcm'|'flac',
        'channelDefinitions': [
            {
                'channelId': 123,
                'participantRole': 'PATIENT'|'CLINICIAN'
            },
        ],
        'postStreamActionSettings': {
            'outputS3Uri': 'string',
            'clinicalNoteGenerationSettings': {
                'noteTemplateSettings': {
                    'managedTemplate': {
                        'templateType': 'HISTORY_AND_PHYSICAL'|'GIRPP'|'DAP'|'SIRP'|'BIRP'|'BEHAVIORAL_SOAP'|'PHYSICAL_SOAP'
                    },
                    'customTemplate': {
                        'templateType': 'HISTORY_AND_PHYSICAL'|'GIRPP'|'DAP'|'SIRP'|'BIRP'|'BEHAVIORAL_SOAP'
                    }
                }
            }
        },
        'postStreamActionResult': {
            'clinicalNoteGenerationResult': {
                'noteResult': {
                    'outputLocation': 'string',
                    'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
                    'failureReason': 'string'
                },
                'transcriptResult': {
                    'outputLocation': 'string',
                    'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
                    'failureReason': 'string'
                },
                'afterVisitSummaryResult': {
                    'outputLocation': 'string',
                    'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED',
                    'failureReason': 'string'
                }
            }
        },
        'encounterContextProvided': True|False,
        'streamStatus': 'IN_PROGRESS'|'PAUSED'|'FAILED'|'COMPLETED',
        'streamCreationTime': datetime(2015, 1, 1),
        'streamEndTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • medicalScribeListeningSessionDetails (dict) –

    Details about the Medical Scribe listening session

    • sessionId (string) –

      The Session identifier

    • domainId (string) –

      The Domain identifier

    • subscriptionId (string) –

      The Subscription identifier

    • languageCode (string) –

      The Language Code for the audio in the session

    • mediaSampleRateHertz (integer) –

      The sample rate of the input audio

    • mediaEncoding (string) –

      The encoding for the input audio

    • channelDefinitions (list) –

      Channel definitions for the audio stream

      • (dict) –

        Defines a channel in the audio stream

        • channelId (integer) –

          The channel identifier

        • participantRole (string) –

          The role of the participant on this channel

    • postStreamActionSettings (dict) –

      Settings for post-stream actions

      • outputS3Uri (string) –

      • clinicalNoteGenerationSettings (dict) –

        Settings for clinical note generation

        • noteTemplateSettings (dict) –

          Settings for the note template used

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: managedTemplate, customTemplate. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • managedTemplate (dict) –

            • templateType (string) –

              The type of managed template used

          • customTemplate (dict) –

            • templateType (string) –

              The base template type that was customized

    • postStreamActionResult (dict) –

      Results of post-stream actions

      • clinicalNoteGenerationResult (dict) –

        Results of clinical note generation

        • noteResult (dict) –

          Details about the generated clinical note

          • outputLocation (string) –

          • status (string) –

            The generation status of the artifact

          • failureReason (string) –

            The reason for failure if the artifact generation failed

        • transcriptResult (dict) –

          Details about the generated transcript

          • outputLocation (string) –

          • status (string) –

            The generation status of the artifact

          • failureReason (string) –

            The reason for failure if the artifact generation failed

        • afterVisitSummaryResult (dict) –

          Details about the generated after visit summary

          • outputLocation (string) –

          • status (string) –

            The generation status of the artifact

          • failureReason (string) –

            The reason for failure if the artifact generation failed

    • encounterContextProvided (boolean) –

      Indicates whether encounter context was provided

    • streamStatus (string) –

      The current status of the stream

    • streamCreationTime (datetime) –

      The timestamp when the stream was created

    • streamEndTime (datetime) –

      The timestamp when the stream ended

Exceptions

• ConnectHealth.Client.exceptions.InternalServerException

• ConnectHealth.Client.exceptions.ResourceNotFoundException

• ConnectHealth.Client.exceptions.AccessDeniedException

• ConnectHealth.Client.exceptions.ThrottlingException

• ConnectHealth.Client.exceptions.ServiceQuotaExceededException