AWS API Changes

2026/09/23 - Connect Health - 2 updated api methods

Changes Multi language support with code switching, custom template sectionHeader now allows underscores.

GetMedicalScribeListeningSession (updated)

Link ¶
Changes (response)

{'medicalScribeListeningSessionDetails': {'languageCode': {'multi'}}}

Retrieves details about an existing Medical Scribe listening session

See also: AWS API Documentation

Request Syntax

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

type sessionId:

string

param sessionId:

[REQUIRED]

The Session identifier

type domainId:

string

param domainId:

[REQUIRED]

The Domain identifier

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The Subscription identifier

rtype:

dict

returns:

Response Syntax

{
    'medicalScribeListeningSessionDetails': {
        'sessionId': 'string',
        'domainId': 'string',
        'subscriptionId': 'string',
        'languageCode': 'en-US'|'multi',
        '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

StartMedicalScribeListeningSession (updated)

Link ¶
Changes (both)

{'languageCode': {'multi'}}

Starts a new Medical Scribe listening session for real-time audio transcription

See also: AWS API Documentation

Request Syntax

client.start_medical_scribe_listening_session(
    sessionId='string',
    domainId='string',
    subscriptionId='string',
    languageCode='en-US'|'multi',
    mediaSampleRateHertz=123,
    mediaEncoding='pcm'|'flac',
    inputStream={...}
)

type sessionId:

string

param sessionId:

[REQUIRED]

The Session identifier

type domainId:

string

param domainId:

[REQUIRED]

The Domain identifier

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The Subscription identifier

type languageCode:

string

param languageCode:

[REQUIRED]

The Language Code for the audio in the session

type mediaSampleRateHertz:

integer

param mediaSampleRateHertz:

[REQUIRED]

The sample rate of the input audio

type mediaEncoding:

string

param mediaEncoding:

[REQUIRED]

The encoding for the input audio

type inputStream:

dict

param inputStream:

rtype:

dict

returns:

The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.

Response Syntax

{
    'sessionId': 'string',
    'domainId': 'string',
    'subscriptionId': 'string',
    'requestId': 'string',
    'languageCode': 'en-US'|'multi',
    'mediaSampleRateHertz': 123,
    'mediaEncoding': 'pcm'|'flac',
    'responseStream': EventStream({
        'transcriptEvent': {
            'transcriptSegment': {
                'segmentId': 'string',
                'audioBeginOffset': 123.0,
                'audioEndOffset': 123.0,
                'isPartial': True|False,
                'channelId': 'string',
                'content': 'string'
            }
        },
        'internalFailureException': {
            'message': 'string'
        },
        'validationException': {
            'message': 'string'
        }
    })
}

Response Structure

(dict) --
- sessionId (string) --
  
  The Session identifier
- domainId (string) --
  
  The Domain identifier
- subscriptionId (string) --
  
  The Subscription identifier
- requestId (string) --
  
  The Request 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
- responseStream (:class:`.EventStream`) --
  
  The output stream containing transcript events
  - transcriptEvent (dict) --
    - transcriptSegment (dict) --
      
      A segment of the transcript
      - segmentId (string) --
        
        The unique identifier for this segment
      - audioBeginOffset (float) --
        
        The offset from audio start when the audio for this segment begins
      - audioEndOffset (float) --
        
        The offset from audio start when the audio for this segment ends
      - isPartial (boolean) --
        
        Indicates whether this is a partial or final transcript
      - channelId (string) --
        
        The channel identifier for this segment
      - content (string) --
        
        The transcript text content
  - internalFailureException (dict) --
    - message (string) --
  - validationException (dict) --
    - message (string) --