Skip to content

Type definitions#

Index > ConnectHealth > Type definitions

Auto-generated documentation for ConnectHealth type annotations stubs module mypy-boto3-connecthealth.

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_connecthealth.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

InputDataConfigUnionTypeDef#

# InputDataConfigUnionTypeDef Union usage example

from mypy_boto3_connecthealth.type_defs import InputDataConfigUnionTypeDef


def get_value() -> InputDataConfigUnionTypeDef:
    return ...


# InputDataConfigUnionTypeDef definition

InputDataConfigUnionTypeDef = Union[
    InputDataConfigTypeDef,  # (1)
    InputDataConfigOutputTypeDef,  # (2)
]
  1. See InputDataConfigTypeDef
  2. See InputDataConfigOutputTypeDef

ActivateSubscriptionInputTypeDef#

# ActivateSubscriptionInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ActivateSubscriptionInputTypeDef


def get_value() -> ActivateSubscriptionInputTypeDef:
    return {
        "domainId": ...,
    }


# ActivateSubscriptionInputTypeDef definition

class ActivateSubscriptionInputTypeDef(TypedDict):
    domainId: str,
    subscriptionId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

SubscriptionDescriptionTypeDef#

# SubscriptionDescriptionTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import SubscriptionDescriptionTypeDef


def get_value() -> SubscriptionDescriptionTypeDef:
    return {
        "domainId": ...,
    }


# SubscriptionDescriptionTypeDef definition

class SubscriptionDescriptionTypeDef(TypedDict):
    domainId: str,
    subscriptionId: str,
    arn: str,
    status: SubscriptionStatusType,  # (1)
    createdAt: datetime.datetime,
    lastUpdatedAt: datetime.datetime,
    activatedAt: NotRequired[datetime.datetime],
    deactivatedAt: NotRequired[datetime.datetime],
  1. See SubscriptionStatusType

ArtifactDetailsTypeDef#

# ArtifactDetailsTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ArtifactDetailsTypeDef


def get_value() -> ArtifactDetailsTypeDef:
    return {
        "outputLocation": ...,
    }


# ArtifactDetailsTypeDef definition

class ArtifactDetailsTypeDef(TypedDict):
    outputLocation: NotRequired[str],
    status: NotRequired[PostStreamArtifactGenerationStatusType],  # (1)
    failureReason: NotRequired[str],
  1. See PostStreamArtifactGenerationStatusType

CreateWebAppConfigurationTypeDef#

# CreateWebAppConfigurationTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import CreateWebAppConfigurationTypeDef


def get_value() -> CreateWebAppConfigurationTypeDef:
    return {
        "ehrRole": ...,
    }


# CreateWebAppConfigurationTypeDef definition

class CreateWebAppConfigurationTypeDef(TypedDict):
    ehrRole: str,
    idcInstanceId: str,
    idcRegion: str,

EncryptionContextTypeDef#

# EncryptionContextTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import EncryptionContextTypeDef


def get_value() -> EncryptionContextTypeDef:
    return {
        "encryptionType": ...,
    }


# EncryptionContextTypeDef definition

class EncryptionContextTypeDef(TypedDict):
    encryptionType: EncryptionTypeType,  # (1)
    kmsKeyArn: NotRequired[str],
  1. See EncryptionTypeType

WebAppConfigurationTypeDef#

# WebAppConfigurationTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import WebAppConfigurationTypeDef


def get_value() -> WebAppConfigurationTypeDef:
    return {
        "ehrRole": ...,
    }


# WebAppConfigurationTypeDef definition

class WebAppConfigurationTypeDef(TypedDict):
    ehrRole: str,
    idcApplicationId: str,
    idcRegion: str,

CreateSubscriptionInputTypeDef#

# CreateSubscriptionInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import CreateSubscriptionInputTypeDef


def get_value() -> CreateSubscriptionInputTypeDef:
    return {
        "domainId": ...,
    }


# CreateSubscriptionInputTypeDef definition

class CreateSubscriptionInputTypeDef(TypedDict):
    domainId: str,

CustomTemplateResponseTypeDef#

# CustomTemplateResponseTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import CustomTemplateResponseTypeDef


def get_value() -> CustomTemplateResponseTypeDef:
    return {
        "templateType": ...,
    }


# CustomTemplateResponseTypeDef definition

class CustomTemplateResponseTypeDef(TypedDict):
    templateType: NotRequired[CustomTemplateBaseType],  # (1)
  1. See CustomTemplateBaseType

TemplateSectionInstructionTypeDef#

# TemplateSectionInstructionTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import TemplateSectionInstructionTypeDef


def get_value() -> TemplateSectionInstructionTypeDef:
    return {
        "sectionHeader": ...,
    }


# TemplateSectionInstructionTypeDef definition

class TemplateSectionInstructionTypeDef(TypedDict):
    sectionHeader: str,
    sectionInstruction: str,

DeactivateSubscriptionInputTypeDef#

# DeactivateSubscriptionInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import DeactivateSubscriptionInputTypeDef


def get_value() -> DeactivateSubscriptionInputTypeDef:
    return {
        "domainId": ...,
    }


# DeactivateSubscriptionInputTypeDef definition

class DeactivateSubscriptionInputTypeDef(TypedDict):
    domainId: str,
    subscriptionId: str,

DeleteDomainInputTypeDef#

# DeleteDomainInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import DeleteDomainInputTypeDef


def get_value() -> DeleteDomainInputTypeDef:
    return {
        "domainId": ...,
    }


# DeleteDomainInputTypeDef definition

class DeleteDomainInputTypeDef(TypedDict):
    domainId: str,

DomainSummaryTypeDef#

# DomainSummaryTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import DomainSummaryTypeDef


def get_value() -> DomainSummaryTypeDef:
    return {
        "domainId": ...,
    }


# DomainSummaryTypeDef definition

class DomainSummaryTypeDef(TypedDict):
    domainId: str,
    arn: str,
    name: str,
    status: DomainStatusType,  # (1)
    createdAt: datetime.datetime,
  1. See DomainStatusType

EncounterContextTypeDef#

# EncounterContextTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import EncounterContextTypeDef


def get_value() -> EncounterContextTypeDef:
    return {
        "unstructuredContext": ...,
    }


# EncounterContextTypeDef definition

class EncounterContextTypeDef(TypedDict):
    unstructuredContext: NotRequired[str],

FHIRServerTypeDef#

# FHIRServerTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import FHIRServerTypeDef


def get_value() -> FHIRServerTypeDef:
    return {
        "fhirEndpoint": ...,
    }


# FHIRServerTypeDef definition

class FHIRServerTypeDef(TypedDict):
    fhirEndpoint: str,
    oauthToken: NotRequired[str],

GetDomainInputTypeDef#

# GetDomainInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import GetDomainInputTypeDef


def get_value() -> GetDomainInputTypeDef:
    return {
        "domainId": ...,
    }


# GetDomainInputTypeDef definition

class GetDomainInputTypeDef(TypedDict):
    domainId: str,

GetMedicalScribeListeningSessionInputTypeDef#

# GetMedicalScribeListeningSessionInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import GetMedicalScribeListeningSessionInputTypeDef


def get_value() -> GetMedicalScribeListeningSessionInputTypeDef:
    return {
        "sessionId": ...,
    }


# GetMedicalScribeListeningSessionInputTypeDef definition

class GetMedicalScribeListeningSessionInputTypeDef(TypedDict):
    sessionId: str,
    domainId: str,
    subscriptionId: str,

GetPatientInsightsJobRequestTypeDef#

# GetPatientInsightsJobRequestTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import GetPatientInsightsJobRequestTypeDef


def get_value() -> GetPatientInsightsJobRequestTypeDef:
    return {
        "domainId": ...,
    }


# GetPatientInsightsJobRequestTypeDef definition

class GetPatientInsightsJobRequestTypeDef(TypedDict):
    domainId: str,
    jobId: str,

InsightsContextTypeDef#

# InsightsContextTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import InsightsContextTypeDef


def get_value() -> InsightsContextTypeDef:
    return {
        "insightsType": ...,
    }


# InsightsContextTypeDef definition

class InsightsContextTypeDef(TypedDict):
    insightsType: InsightsTypeType,  # (1)
  1. See InsightsTypeType

InsightsOutputTypeDef#

# InsightsOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import InsightsOutputTypeDef


def get_value() -> InsightsOutputTypeDef:
    return {
        "uri": ...,
    }


# InsightsOutputTypeDef definition

class InsightsOutputTypeDef(TypedDict):
    uri: str,

OutputDataConfigTypeDef#

# OutputDataConfigTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import OutputDataConfigTypeDef


def get_value() -> OutputDataConfigTypeDef:
    return {
        "s3OutputPath": ...,
    }


# OutputDataConfigTypeDef definition

class OutputDataConfigTypeDef(TypedDict):
    s3OutputPath: str,

PatientInsightsEncounterContextTypeDef#

# PatientInsightsEncounterContextTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import PatientInsightsEncounterContextTypeDef


def get_value() -> PatientInsightsEncounterContextTypeDef:
    return {
        "encounterReason": ...,
    }


# PatientInsightsEncounterContextTypeDef definition

class PatientInsightsEncounterContextTypeDef(TypedDict):
    encounterReason: str,

PatientInsightsPatientContextTypeDef#

# PatientInsightsPatientContextTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import PatientInsightsPatientContextTypeDef


def get_value() -> PatientInsightsPatientContextTypeDef:
    return {
        "patientId": ...,
    }


# PatientInsightsPatientContextTypeDef definition

class PatientInsightsPatientContextTypeDef(TypedDict):
    patientId: str,
    dateOfBirth: NotRequired[str],
    pronouns: NotRequired[PronounsType],  # (1)
  1. See PronounsType

UserContextTypeDef#

# UserContextTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import UserContextTypeDef


def get_value() -> UserContextTypeDef:
    return {
        "role": ...,
    }


# UserContextTypeDef definition

class UserContextTypeDef(TypedDict):
    role: ProviderRoleType,  # (1)
    userId: str,
    specialty: NotRequired[SpecialtyType],  # (2)
  1. See ProviderRoleType
  2. See SpecialtyType

GetSubscriptionInputTypeDef#

# GetSubscriptionInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import GetSubscriptionInputTypeDef


def get_value() -> GetSubscriptionInputTypeDef:
    return {
        "domainId": ...,
    }


# GetSubscriptionInputTypeDef definition

class GetSubscriptionInputTypeDef(TypedDict):
    domainId: str,
    subscriptionId: str,

S3SourceTypeDef#

# S3SourceTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import S3SourceTypeDef


def get_value() -> S3SourceTypeDef:
    return {
        "uri": ...,
    }


# S3SourceTypeDef definition

class S3SourceTypeDef(TypedDict):
    uri: str,

InternalServerExceptionTypeDef#

# InternalServerExceptionTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import InternalServerExceptionTypeDef


def get_value() -> InternalServerExceptionTypeDef:
    return {
        "message": ...,
    }


# InternalServerExceptionTypeDef definition

class InternalServerExceptionTypeDef(TypedDict):
    message: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDomainsInputTypeDef#

# ListDomainsInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ListDomainsInputTypeDef


def get_value() -> ListDomainsInputTypeDef:
    return {
        "status": ...,
    }


# ListDomainsInputTypeDef definition

class ListDomainsInputTypeDef(TypedDict):
    status: NotRequired[DomainStatusType],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See DomainStatusType

ListSubscriptionsInputTypeDef#

# ListSubscriptionsInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ListSubscriptionsInputTypeDef


def get_value() -> ListSubscriptionsInputTypeDef:
    return {
        "domainId": ...,
    }


# ListSubscriptionsInputTypeDef definition

class ListSubscriptionsInputTypeDef(TypedDict):
    domainId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    resourceArn: str,

ManagedTemplateResponseTypeDef#

# ManagedTemplateResponseTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ManagedTemplateResponseTypeDef


def get_value() -> ManagedTemplateResponseTypeDef:
    return {
        "templateType": ...,
    }


# ManagedTemplateResponseTypeDef definition

class ManagedTemplateResponseTypeDef(TypedDict):
    templateType: NotRequired[ManagedNoteTemplateType],  # (1)
  1. See ManagedNoteTemplateType

ManagedTemplateTypeDef#

# ManagedTemplateTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ManagedTemplateTypeDef


def get_value() -> ManagedTemplateTypeDef:
    return {
        "templateType": ...,
    }


# ManagedTemplateTypeDef definition

class ManagedTemplateTypeDef(TypedDict):
    templateType: ManagedNoteTemplateType,  # (1)
  1. See ManagedNoteTemplateType

MedicalScribeChannelDefinitionTypeDef#

# MedicalScribeChannelDefinitionTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeChannelDefinitionTypeDef


def get_value() -> MedicalScribeChannelDefinitionTypeDef:
    return {
        "channelId": ...,
    }


# MedicalScribeChannelDefinitionTypeDef definition

class MedicalScribeChannelDefinitionTypeDef(TypedDict):
    channelId: int,
    participantRole: MedicalScribeParticipantRoleType,  # (1)
  1. See MedicalScribeParticipantRoleType

MedicalScribeSessionControlEventTypeDef#

# MedicalScribeSessionControlEventTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeSessionControlEventTypeDef


def get_value() -> MedicalScribeSessionControlEventTypeDef:
    return {
        "type": ...,
    }


# MedicalScribeSessionControlEventTypeDef definition

class MedicalScribeSessionControlEventTypeDef(TypedDict):
    type: NotRequired[MedicalScribeSessionControlEventTypeType],  # (1)
  1. See MedicalScribeSessionControlEventTypeType

ValidationExceptionTypeDef#

# ValidationExceptionTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ValidationExceptionTypeDef


def get_value() -> ValidationExceptionTypeDef:
    return {
        "message": ...,
    }


# ValidationExceptionTypeDef definition

class ValidationExceptionTypeDef(TypedDict):
    message: NotRequired[str],

MedicalScribeTranscriptSegmentTypeDef#

# MedicalScribeTranscriptSegmentTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeTranscriptSegmentTypeDef


def get_value() -> MedicalScribeTranscriptSegmentTypeDef:
    return {
        "segmentId": ...,
    }


# MedicalScribeTranscriptSegmentTypeDef definition

class MedicalScribeTranscriptSegmentTypeDef(TypedDict):
    segmentId: NotRequired[str],
    audioBeginOffset: NotRequired[float],
    audioEndOffset: NotRequired[float],
    isPartial: NotRequired[bool],
    channelId: NotRequired[str],
    content: NotRequired[str],

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

CreateSubscriptionOutputTypeDef#

# CreateSubscriptionOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import CreateSubscriptionOutputTypeDef


def get_value() -> CreateSubscriptionOutputTypeDef:
    return {
        "domainId": ...,
    }


# CreateSubscriptionOutputTypeDef definition

class CreateSubscriptionOutputTypeDef(TypedDict):
    domainId: str,
    subscriptionId: str,
    arn: str,
    status: SubscriptionStatusType,  # (1)
    createdAt: datetime.datetime,
    lastUpdatedAt: datetime.datetime,
    activatedAt: datetime.datetime,
    deactivatedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionStatusType
  2. See ResponseMetadataTypeDef

DeleteDomainOutputTypeDef#

# DeleteDomainOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import DeleteDomainOutputTypeDef


def get_value() -> DeleteDomainOutputTypeDef:
    return {
        "domainId": ...,
    }


# DeleteDomainOutputTypeDef definition

class DeleteDomainOutputTypeDef(TypedDict):
    domainId: str,
    arn: str,
    status: DomainStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainStatusType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartPatientInsightsJobResponseTypeDef#

# StartPatientInsightsJobResponseTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import StartPatientInsightsJobResponseTypeDef


def get_value() -> StartPatientInsightsJobResponseTypeDef:
    return {
        "jobArn": ...,
    }


# StartPatientInsightsJobResponseTypeDef definition

class StartPatientInsightsJobResponseTypeDef(TypedDict):
    jobArn: str,
    jobId: str,
    creationTime: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ActivateSubscriptionOutputTypeDef#

# ActivateSubscriptionOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ActivateSubscriptionOutputTypeDef


def get_value() -> ActivateSubscriptionOutputTypeDef:
    return {
        "subscription": ...,
    }


# ActivateSubscriptionOutputTypeDef definition

class ActivateSubscriptionOutputTypeDef(TypedDict):
    subscription: SubscriptionDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DeactivateSubscriptionOutputTypeDef#

# DeactivateSubscriptionOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import DeactivateSubscriptionOutputTypeDef


def get_value() -> DeactivateSubscriptionOutputTypeDef:
    return {
        "subscription": ...,
    }


# DeactivateSubscriptionOutputTypeDef definition

class DeactivateSubscriptionOutputTypeDef(TypedDict):
    subscription: SubscriptionDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionDescriptionTypeDef
  2. See ResponseMetadataTypeDef

GetSubscriptionOutputTypeDef#

# GetSubscriptionOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import GetSubscriptionOutputTypeDef


def get_value() -> GetSubscriptionOutputTypeDef:
    return {
        "subscription": ...,
    }


# GetSubscriptionOutputTypeDef definition

class GetSubscriptionOutputTypeDef(TypedDict):
    subscription: SubscriptionDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListSubscriptionsOutputTypeDef#

# ListSubscriptionsOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ListSubscriptionsOutputTypeDef


def get_value() -> ListSubscriptionsOutputTypeDef:
    return {
        "subscriptions": ...,
    }


# ListSubscriptionsOutputTypeDef definition

class ListSubscriptionsOutputTypeDef(TypedDict):
    subscriptions: list[SubscriptionDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[SubscriptionDescriptionTypeDef]
  2. See ResponseMetadataTypeDef

ClinicalNoteGenerationResultTypeDef#

# ClinicalNoteGenerationResultTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ClinicalNoteGenerationResultTypeDef


def get_value() -> ClinicalNoteGenerationResultTypeDef:
    return {
        "noteResult": ...,
    }


# ClinicalNoteGenerationResultTypeDef definition

class ClinicalNoteGenerationResultTypeDef(TypedDict):
    noteResult: NotRequired[ArtifactDetailsTypeDef],  # (1)
    transcriptResult: NotRequired[ArtifactDetailsTypeDef],  # (1)
    afterVisitSummaryResult: NotRequired[ArtifactDetailsTypeDef],  # (1)
  1. See ArtifactDetailsTypeDef
  2. See ArtifactDetailsTypeDef
  3. See ArtifactDetailsTypeDef

MedicalScribeAudioEventTypeDef#

# MedicalScribeAudioEventTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeAudioEventTypeDef


def get_value() -> MedicalScribeAudioEventTypeDef:
    return {
        "audioChunk": ...,
    }


# MedicalScribeAudioEventTypeDef definition

class MedicalScribeAudioEventTypeDef(TypedDict):
    audioChunk: BlobTypeDef,

CreateDomainInputTypeDef#

# CreateDomainInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import CreateDomainInputTypeDef


def get_value() -> CreateDomainInputTypeDef:
    return {
        "name": ...,
    }


# CreateDomainInputTypeDef definition

class CreateDomainInputTypeDef(TypedDict):
    name: str,
    kmsKeyArn: NotRequired[str],
    webAppSetupConfiguration: NotRequired[CreateWebAppConfigurationTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See CreateWebAppConfigurationTypeDef

CreateDomainOutputTypeDef#

# CreateDomainOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import CreateDomainOutputTypeDef


def get_value() -> CreateDomainOutputTypeDef:
    return {
        "domainId": ...,
    }


# CreateDomainOutputTypeDef definition

class CreateDomainOutputTypeDef(TypedDict):
    domainId: str,
    arn: str,
    name: str,
    kmsKeyArn: str,
    encryptionContext: EncryptionContextTypeDef,  # (1)
    status: DomainStatusType,  # (2)
    webAppUrl: str,
    webAppConfiguration: WebAppConfigurationTypeDef,  # (3)
    createdAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See EncryptionContextTypeDef
  2. See DomainStatusType
  3. See WebAppConfigurationTypeDef
  4. See ResponseMetadataTypeDef

GetDomainOutputTypeDef#

# GetDomainOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import GetDomainOutputTypeDef


def get_value() -> GetDomainOutputTypeDef:
    return {
        "domainId": ...,
    }


# GetDomainOutputTypeDef definition

class GetDomainOutputTypeDef(TypedDict):
    domainId: str,
    arn: str,
    name: str,
    kmsKeyArn: str,
    encryptionContext: EncryptionContextTypeDef,  # (1)
    status: DomainStatusType,  # (2)
    webAppUrl: str,
    webAppConfiguration: WebAppConfigurationTypeDef,  # (3)
    createdAt: datetime.datetime,
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See EncryptionContextTypeDef
  2. See DomainStatusType
  3. See WebAppConfigurationTypeDef
  4. See ResponseMetadataTypeDef

CustomTemplateTypeDef#

# CustomTemplateTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import CustomTemplateTypeDef


def get_value() -> CustomTemplateTypeDef:
    return {
        "templateType": ...,
    }


# CustomTemplateTypeDef definition

class CustomTemplateTypeDef(TypedDict):
    templateType: CustomTemplateBaseType,  # (1)
    templateInstructions: Sequence[TemplateSectionInstructionTypeDef],  # (2)
  1. See CustomTemplateBaseType
  2. See Sequence[TemplateSectionInstructionTypeDef]

ListDomainsOutputTypeDef#

# ListDomainsOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ListDomainsOutputTypeDef


def get_value() -> ListDomainsOutputTypeDef:
    return {
        "domains": ...,
    }


# ListDomainsOutputTypeDef definition

class ListDomainsOutputTypeDef(TypedDict):
    domains: list[DomainSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[DomainSummaryTypeDef]
  2. See ResponseMetadataTypeDef

InputDataConfigOutputTypeDef#

# InputDataConfigOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import InputDataConfigOutputTypeDef


def get_value() -> InputDataConfigOutputTypeDef:
    return {
        "fhirServer": ...,
    }


# InputDataConfigOutputTypeDef definition

class InputDataConfigOutputTypeDef(TypedDict):
    fhirServer: NotRequired[FHIRServerTypeDef],  # (1)
    s3Sources: NotRequired[list[S3SourceTypeDef]],  # (2)
  1. See FHIRServerTypeDef
  2. See list[S3SourceTypeDef]

InputDataConfigTypeDef#

# InputDataConfigTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import InputDataConfigTypeDef


def get_value() -> InputDataConfigTypeDef:
    return {
        "fhirServer": ...,
    }


# InputDataConfigTypeDef definition

class InputDataConfigTypeDef(TypedDict):
    fhirServer: NotRequired[FHIRServerTypeDef],  # (1)
    s3Sources: NotRequired[Sequence[S3SourceTypeDef]],  # (2)
  1. See FHIRServerTypeDef
  2. See Sequence[S3SourceTypeDef]

ListDomainsInputPaginateTypeDef#

# ListDomainsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ListDomainsInputPaginateTypeDef


def get_value() -> ListDomainsInputPaginateTypeDef:
    return {
        "status": ...,
    }


# ListDomainsInputPaginateTypeDef definition

class ListDomainsInputPaginateTypeDef(TypedDict):
    status: NotRequired[DomainStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See DomainStatusType
  2. See PaginatorConfigTypeDef

ListSubscriptionsInputPaginateTypeDef#

# ListSubscriptionsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ListSubscriptionsInputPaginateTypeDef


def get_value() -> ListSubscriptionsInputPaginateTypeDef:
    return {
        "domainId": ...,
    }


# ListSubscriptionsInputPaginateTypeDef definition

class ListSubscriptionsInputPaginateTypeDef(TypedDict):
    domainId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

NoteTemplateSettingsResponseTypeDef#

# NoteTemplateSettingsResponseTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import NoteTemplateSettingsResponseTypeDef


def get_value() -> NoteTemplateSettingsResponseTypeDef:
    return {
        "managedTemplate": ...,
    }


# NoteTemplateSettingsResponseTypeDef definition

class NoteTemplateSettingsResponseTypeDef(TypedDict):
    managedTemplate: NotRequired[ManagedTemplateResponseTypeDef],  # (1)
    customTemplate: NotRequired[CustomTemplateResponseTypeDef],  # (2)
  1. See ManagedTemplateResponseTypeDef
  2. See CustomTemplateResponseTypeDef

MedicalScribeTranscriptEventTypeDef#

# MedicalScribeTranscriptEventTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeTranscriptEventTypeDef


def get_value() -> MedicalScribeTranscriptEventTypeDef:
    return {
        "transcriptSegment": ...,
    }


# MedicalScribeTranscriptEventTypeDef definition

class MedicalScribeTranscriptEventTypeDef(TypedDict):
    transcriptSegment: NotRequired[MedicalScribeTranscriptSegmentTypeDef],  # (1)
  1. See MedicalScribeTranscriptSegmentTypeDef

MedicalScribePostStreamActionsResultTypeDef#

# MedicalScribePostStreamActionsResultTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribePostStreamActionsResultTypeDef


def get_value() -> MedicalScribePostStreamActionsResultTypeDef:
    return {
        "clinicalNoteGenerationResult": ...,
    }


# MedicalScribePostStreamActionsResultTypeDef definition

class MedicalScribePostStreamActionsResultTypeDef(TypedDict):
    clinicalNoteGenerationResult: NotRequired[ClinicalNoteGenerationResultTypeDef],  # (1)
  1. See ClinicalNoteGenerationResultTypeDef

NoteTemplateSettingsTypeDef#

# NoteTemplateSettingsTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import NoteTemplateSettingsTypeDef


def get_value() -> NoteTemplateSettingsTypeDef:
    return {
        "managedTemplate": ...,
    }


# NoteTemplateSettingsTypeDef definition

class NoteTemplateSettingsTypeDef(TypedDict):
    managedTemplate: NotRequired[ManagedTemplateTypeDef],  # (1)
    customTemplate: NotRequired[CustomTemplateTypeDef],  # (2)
  1. See ManagedTemplateTypeDef
  2. See CustomTemplateTypeDef

GetPatientInsightsJobResponseTypeDef#

# GetPatientInsightsJobResponseTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import GetPatientInsightsJobResponseTypeDef


def get_value() -> GetPatientInsightsJobResponseTypeDef:
    return {
        "jobId": ...,
    }


# GetPatientInsightsJobResponseTypeDef definition

class GetPatientInsightsJobResponseTypeDef(TypedDict):
    jobId: str,
    jobArn: str,
    jobStatus: JobStatusType,  # (1)
    creationTime: datetime.datetime,
    updatedTime: datetime.datetime,
    insightsOutput: InsightsOutputTypeDef,  # (2)
    statusDetails: str,
    patientContext: PatientInsightsPatientContextTypeDef,  # (3)
    insightsContext: InsightsContextTypeDef,  # (4)
    encounterContext: PatientInsightsEncounterContextTypeDef,  # (5)
    userContext: UserContextTypeDef,  # (6)
    inputDataConfig: InputDataConfigOutputTypeDef,  # (7)
    outputDataConfig: OutputDataConfigTypeDef,  # (8)
    ResponseMetadata: ResponseMetadataTypeDef,  # (9)
  1. See JobStatusType
  2. See InsightsOutputTypeDef
  3. See PatientInsightsPatientContextTypeDef
  4. See InsightsContextTypeDef
  5. See PatientInsightsEncounterContextTypeDef
  6. See UserContextTypeDef
  7. See InputDataConfigOutputTypeDef
  8. See OutputDataConfigTypeDef
  9. See ResponseMetadataTypeDef

ClinicalNoteGenerationSettingsResponseTypeDef#

# ClinicalNoteGenerationSettingsResponseTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ClinicalNoteGenerationSettingsResponseTypeDef


def get_value() -> ClinicalNoteGenerationSettingsResponseTypeDef:
    return {
        "noteTemplateSettings": ...,
    }


# ClinicalNoteGenerationSettingsResponseTypeDef definition

class ClinicalNoteGenerationSettingsResponseTypeDef(TypedDict):
    noteTemplateSettings: NotRequired[NoteTemplateSettingsResponseTypeDef],  # (1)
  1. See NoteTemplateSettingsResponseTypeDef

MedicalScribeOutputStreamTypeDef#

# MedicalScribeOutputStreamTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeOutputStreamTypeDef


def get_value() -> MedicalScribeOutputStreamTypeDef:
    return {
        "transcriptEvent": ...,
    }


# MedicalScribeOutputStreamTypeDef definition

class MedicalScribeOutputStreamTypeDef(TypedDict):
    transcriptEvent: NotRequired[MedicalScribeTranscriptEventTypeDef],  # (1)
    internalFailureException: NotRequired[InternalServerExceptionTypeDef],  # (2)
    validationException: NotRequired[ValidationExceptionTypeDef],  # (3)
  1. See MedicalScribeTranscriptEventTypeDef
  2. See InternalServerExceptionTypeDef
  3. See ValidationExceptionTypeDef

ClinicalNoteGenerationSettingsTypeDef#

# ClinicalNoteGenerationSettingsTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import ClinicalNoteGenerationSettingsTypeDef


def get_value() -> ClinicalNoteGenerationSettingsTypeDef:
    return {
        "noteTemplateSettings": ...,
    }


# ClinicalNoteGenerationSettingsTypeDef definition

class ClinicalNoteGenerationSettingsTypeDef(TypedDict):
    noteTemplateSettings: NoteTemplateSettingsTypeDef,  # (1)
  1. See NoteTemplateSettingsTypeDef

StartPatientInsightsJobRequestTypeDef#

# StartPatientInsightsJobRequestTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import StartPatientInsightsJobRequestTypeDef


def get_value() -> StartPatientInsightsJobRequestTypeDef:
    return {
        "domainId": ...,
    }


# StartPatientInsightsJobRequestTypeDef definition

class StartPatientInsightsJobRequestTypeDef(TypedDict):
    domainId: str,
    patientContext: PatientInsightsPatientContextTypeDef,  # (1)
    insightsContext: InsightsContextTypeDef,  # (2)
    encounterContext: PatientInsightsEncounterContextTypeDef,  # (3)
    userContext: UserContextTypeDef,  # (4)
    inputDataConfig: InputDataConfigUnionTypeDef,  # (5)
    outputDataConfig: OutputDataConfigTypeDef,  # (6)
    clientToken: NotRequired[str],
  1. See PatientInsightsPatientContextTypeDef
  2. See InsightsContextTypeDef
  3. See PatientInsightsEncounterContextTypeDef
  4. See UserContextTypeDef
  5. See InputDataConfigUnionTypeDef
  6. See OutputDataConfigTypeDef

MedicalScribePostStreamActionSettingsResponseTypeDef#

# MedicalScribePostStreamActionSettingsResponseTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribePostStreamActionSettingsResponseTypeDef


def get_value() -> MedicalScribePostStreamActionSettingsResponseTypeDef:
    return {
        "outputS3Uri": ...,
    }


# MedicalScribePostStreamActionSettingsResponseTypeDef definition

class MedicalScribePostStreamActionSettingsResponseTypeDef(TypedDict):
    outputS3Uri: str,
    clinicalNoteGenerationSettings: ClinicalNoteGenerationSettingsResponseTypeDef,  # (1)
  1. See ClinicalNoteGenerationSettingsResponseTypeDef

StartMedicalScribeListeningSessionOutputTypeDef#

# StartMedicalScribeListeningSessionOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import StartMedicalScribeListeningSessionOutputTypeDef


def get_value() -> StartMedicalScribeListeningSessionOutputTypeDef:
    return {
        "sessionId": ...,
    }


# StartMedicalScribeListeningSessionOutputTypeDef definition

class StartMedicalScribeListeningSessionOutputTypeDef(TypedDict):
    sessionId: str,
    domainId: str,
    subscriptionId: str,
    requestId: str,
    languageCode: MedicalScribeLanguageCodeType,  # (1)
    mediaSampleRateHertz: int,
    mediaEncoding: MedicalScribeMediaEncodingType,  # (2)
    responseStream: botocore.eventstream.EventStream[MedicalScribeOutputStreamTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See MedicalScribeLanguageCodeType
  2. See MedicalScribeMediaEncodingType
  3. See EventStream[MedicalScribeOutputStreamTypeDef]
  4. See ResponseMetadataTypeDef

MedicalScribePostStreamActionSettingsTypeDef#

# MedicalScribePostStreamActionSettingsTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribePostStreamActionSettingsTypeDef


def get_value() -> MedicalScribePostStreamActionSettingsTypeDef:
    return {
        "outputS3Uri": ...,
    }


# MedicalScribePostStreamActionSettingsTypeDef definition

class MedicalScribePostStreamActionSettingsTypeDef(TypedDict):
    outputS3Uri: str,
    clinicalNoteGenerationSettings: ClinicalNoteGenerationSettingsTypeDef,  # (1)
  1. See ClinicalNoteGenerationSettingsTypeDef

MedicalScribeListeningSessionDetailsTypeDef#

# MedicalScribeListeningSessionDetailsTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeListeningSessionDetailsTypeDef


def get_value() -> MedicalScribeListeningSessionDetailsTypeDef:
    return {
        "sessionId": ...,
    }


# MedicalScribeListeningSessionDetailsTypeDef definition

class MedicalScribeListeningSessionDetailsTypeDef(TypedDict):
    sessionId: NotRequired[str],
    domainId: NotRequired[str],
    subscriptionId: NotRequired[str],
    languageCode: NotRequired[MedicalScribeLanguageCodeType],  # (1)
    mediaSampleRateHertz: NotRequired[int],
    mediaEncoding: NotRequired[MedicalScribeMediaEncodingType],  # (2)
    channelDefinitions: NotRequired[list[MedicalScribeChannelDefinitionTypeDef]],  # (3)
    postStreamActionSettings: NotRequired[MedicalScribePostStreamActionSettingsResponseTypeDef],  # (4)
    postStreamActionResult: NotRequired[MedicalScribePostStreamActionsResultTypeDef],  # (5)
    encounterContextProvided: NotRequired[bool],
    streamStatus: NotRequired[MedicalScribeStreamStatusType],  # (6)
    streamCreationTime: NotRequired[datetime.datetime],
    streamEndTime: NotRequired[datetime.datetime],
  1. See MedicalScribeLanguageCodeType
  2. See MedicalScribeMediaEncodingType
  3. See list[MedicalScribeChannelDefinitionTypeDef]
  4. See MedicalScribePostStreamActionSettingsResponseTypeDef
  5. See MedicalScribePostStreamActionsResultTypeDef
  6. See MedicalScribeStreamStatusType

MedicalScribeConfigurationEventTypeDef#

# MedicalScribeConfigurationEventTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeConfigurationEventTypeDef


def get_value() -> MedicalScribeConfigurationEventTypeDef:
    return {
        "postStreamActionSettings": ...,
    }


# MedicalScribeConfigurationEventTypeDef definition

class MedicalScribeConfigurationEventTypeDef(TypedDict):
    postStreamActionSettings: MedicalScribePostStreamActionSettingsTypeDef,  # (1)
    channelDefinitions: NotRequired[Sequence[MedicalScribeChannelDefinitionTypeDef]],  # (2)
    encounterContext: NotRequired[EncounterContextTypeDef],  # (3)
  1. See MedicalScribePostStreamActionSettingsTypeDef
  2. See Sequence[MedicalScribeChannelDefinitionTypeDef]
  3. See EncounterContextTypeDef

GetMedicalScribeListeningSessionOutputTypeDef#

# GetMedicalScribeListeningSessionOutputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import GetMedicalScribeListeningSessionOutputTypeDef


def get_value() -> GetMedicalScribeListeningSessionOutputTypeDef:
    return {
        "medicalScribeListeningSessionDetails": ...,
    }


# GetMedicalScribeListeningSessionOutputTypeDef definition

class GetMedicalScribeListeningSessionOutputTypeDef(TypedDict):
    medicalScribeListeningSessionDetails: MedicalScribeListeningSessionDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MedicalScribeListeningSessionDetailsTypeDef
  2. See ResponseMetadataTypeDef

MedicalScribeInputStreamTypeDef#

# MedicalScribeInputStreamTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import MedicalScribeInputStreamTypeDef


def get_value() -> MedicalScribeInputStreamTypeDef:
    return {
        "audioEvent": ...,
    }


# MedicalScribeInputStreamTypeDef definition

class MedicalScribeInputStreamTypeDef(TypedDict):
    audioEvent: NotRequired[MedicalScribeAudioEventTypeDef],  # (1)
    sessionControlEvent: NotRequired[MedicalScribeSessionControlEventTypeDef],  # (2)
    configurationEvent: NotRequired[MedicalScribeConfigurationEventTypeDef],  # (3)
  1. See MedicalScribeAudioEventTypeDef
  2. See MedicalScribeSessionControlEventTypeDef
  3. See MedicalScribeConfigurationEventTypeDef

StartMedicalScribeListeningSessionInputTypeDef#

# StartMedicalScribeListeningSessionInputTypeDef TypedDict usage example

from mypy_boto3_connecthealth.type_defs import StartMedicalScribeListeningSessionInputTypeDef


def get_value() -> StartMedicalScribeListeningSessionInputTypeDef:
    return {
        "sessionId": ...,
    }


# StartMedicalScribeListeningSessionInputTypeDef definition

class StartMedicalScribeListeningSessionInputTypeDef(TypedDict):
    sessionId: str,
    domainId: str,
    subscriptionId: str,
    languageCode: MedicalScribeLanguageCodeType,  # (1)
    mediaSampleRateHertz: int,
    mediaEncoding: MedicalScribeMediaEncodingType,  # (2)
    inputStream: NotRequired[botocore.eventstream.EventStream[MedicalScribeInputStreamTypeDef]],  # (3)
  1. See MedicalScribeLanguageCodeType
  2. See MedicalScribeMediaEncodingType
  3. See EventStream[MedicalScribeInputStreamTypeDef]