2026/11/16 - Connect Health - 7 new2 updated api methods
Changes Adds dataset APIs and async medical coding jobs that can use a customer dataset (preview). Ambient listening sessions add medical coding job details and real-time periodontal chart and checklist events (preview). SubmitFeedback compares human-approved and AI-generated artifacts (preview).
Lists the Datasets in a Domain. You can list only the datasets of one type. The operation doesn't return datasets whose status is DELETED, and the order of the results isn't specified. We recommend using pagination to ensure that the operation returns quickly and successfully.
Datasets are in preview release and are subject to change.
See also: AWS API Documentation
Request Syntax
client.list_datasets(
domainId='string',
type='MEDICAL_CODING',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the parent Domain.
string
Returns only datasets of this type.
string
The token for the next page of results, from a previous ListDatasets response. If you don't specify a value, the operation returns the first page of results.
integer
The maximum number of datasets to return in one page. The default is 100.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'datasetId': 'string',
'name': 'string',
'type': 'MEDICAL_CODING',
'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED',
'statusDetails': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of dataset summaries.
(dict) --
Summary information about a Dataset.
arn (string) --
The Amazon Resource Name (ARN) of the dataset.
datasetId (string) --
The unique identifier of the dataset.
name (string) --
The name of the dataset.
type (string) --
The type of the dataset.
status (string) --
The status of the dataset.
statusDetails (string) --
Details about the status of the dataset, such as the reason that it failed to build or delete.
createdAt (datetime) --
The date and time that the dataset was created.
updatedAt (datetime) --
The date and time that the dataset was last updated.
nextToken (string) --
The token for the next page of results. Not returned if there are no more results.
Creates a Dataset in a Domain and starts building it. A new dataset has the status CREATING. When it's ready to use, its status changes to ACTIVE, or to CREATE_FAILED if it fails to build. To check the status, call GetDataset.
This operation is idempotent: if you retry a request with the same clientToken, it returns the dataset that the first request created.
For a medical coding dataset, Amazon Connect Health uses the coded examples that are in the s3InputPath when you create the dataset, and writes evaluation scores to the s3OutputPath. Later changes to the s3InputPath don't change the dataset. To use this operation, you must have s3:GetObject and s3:ListBucket permissions for the input location and s3:PutObject permission for the output location, and kms:Decrypt and kms:GenerateDataKey permissions if you encrypt the locations with an AWS KMS key.
Datasets are in preview release and are subject to change.
See also: AWS API Documentation
Request Syntax
client.create_dataset(
domainId='string',
name='string',
config={
'medicalCoding': {
's3InputPath': 'string',
's3OutputPath': 'string'
}
},
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the parent Domain.
string
[REQUIRED]
A name for the dataset.
dict
[REQUIRED]
The configuration of the dataset. The member that you set determines the dataset type. You can't change the configuration after you create the dataset.
medicalCoding (dict) --
The configuration of a medical coding dataset, which tailors medical coding jobs to your coded examples.
s3InputPath (string) -- [REQUIRED]
The Amazon S3 location of your coded examples. You need s3:GetObject and s3:ListBucket permissions for it, and kms:Decrypt if you encrypt it with an AWS KMS key.
s3OutputPath (string) -- [REQUIRED]
The Amazon S3 location where Amazon Connect Health writes the evaluation scores for the dataset. You need s3:PutObject permission for it, and kms:GenerateDataKey if you encrypt it with an AWS KMS key.
string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the operation returns the dataset that the first request created. If you reuse a clientToken with different parameters, the request fails with ConflictException. Use a new clientToken for a request with different parameters.
This field is autopopulated if not provided.
dict
Response Syntax
{
'arn': 'string',
'datasetId': 'string',
'type': 'MEDICAL_CODING',
'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the dataset.
datasetId (string) --
The unique identifier of the dataset.
type (string) --
The type of the dataset, determined by the configuration that you provided.
status (string) --
The status of the dataset. A new dataset has the status CREATING.
createdAt (datetime) --
The date and time that the dataset was created.
Retrieves information about a Dataset, including its status and, after it is built, its results. A dataset whose status is DELETED returns ResourceNotFoundException.
Datasets are in preview release and are subject to change.
See also: AWS API Documentation
Request Syntax
client.get_dataset(
domainId='string',
datasetId='string'
)
string
[REQUIRED]
The unique identifier of the parent Domain.
string
[REQUIRED]
The unique identifier of the dataset.
dict
Response Syntax
{
'arn': 'string',
'datasetId': 'string',
'name': 'string',
'type': 'MEDICAL_CODING',
'config': {
'medicalCoding': {
's3InputPath': 'string',
's3OutputPath': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED',
'statusDetails': 'string',
'artifacts': {
'medicalCoding': {
'evaluationS3Uri': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the dataset.
datasetId (string) --
The unique identifier of the dataset.
name (string) --
The name of the dataset.
type (string) --
The type of the dataset.
config (dict) --
The configuration that you provided when you created the dataset.
medicalCoding (dict) --
The configuration of a medical coding dataset, which tailors medical coding jobs to your coded examples.
s3InputPath (string) --
The Amazon S3 location of your coded examples. You need s3:GetObject and s3:ListBucket permissions for it, and kms:Decrypt if you encrypt it with an AWS KMS key.
s3OutputPath (string) --
The Amazon S3 location where Amazon Connect Health writes the evaluation scores for the dataset. You need s3:PutObject permission for it, and kms:GenerateDataKey if you encrypt it with an AWS KMS key.
status (string) --
The status of the dataset.
statusDetails (string) --
Details about the status of the dataset, such as the reason that it failed to build or delete.
artifacts (dict) --
The results of building the dataset, such as medical coding evaluation scores. Available after Amazon Connect Health builds the dataset.
medicalCoding (dict) --
The results of building a medical coding dataset.
evaluationS3Uri (string) --
The Amazon S3 location, under the s3OutputPath of the dataset, of the evaluation scores for the dataset.
createdAt (datetime) --
The date and time that the dataset was created.
updatedAt (datetime) --
The date and time that the dataset was last updated.
Retrieves information about a medical coding job, including its status and, when it succeeds, the location of its results.
Medical coding jobs are in preview release and are subject to change.
See also: AWS API Documentation
Request Syntax
client.get_medical_coding_job(
domainId='string',
jobId='string'
)
string
[REQUIRED]
The unique identifier of the parent Domain.
string
[REQUIRED]
The unique identifier of the medical coding job.
dict
Response Syntax
{
'jobId': 'string',
'jobArn': 'string',
'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'creationTime': datetime(2015, 1, 1),
'updatedTime': datetime(2015, 1, 1),
'text': 'string',
'patientContext': {
'sex': 'MALE'|'FEMALE'|'NON_BINARY'|'UNKNOWN',
'status': 'NEW'|'ESTABLISHED',
'dateOfBirth': 'string',
'insurance': 'string'
},
'encounterContext': {
'encounterType': 'TELEHEALTH'|'IN_PERSON',
'encounterReason': 'string',
'afterHours': True|False,
'encounterDate': 'string',
'encounterDurationMinutes': 123
},
'outputDataConfig': {
's3OutputPath': 'string'
},
'datasetId': 'string',
'medicalCodingOutput': {
'uri': 'string'
},
'statusDetails': 'string'
}
Response Structure
(dict) --
jobId (string) --
The unique identifier of the medical coding job.
jobArn (string) --
The Amazon Resource Name (ARN) of the medical coding job.
jobStatus (string) --
The status of the medical coding job.
creationTime (datetime) --
The date and time that the medical coding job was created.
updatedTime (datetime) --
The date and time that the medical coding job was last updated.
text (string) --
The clinical text that the medical coding job codes.
patientContext (dict) --
The patient context that you provided for the job.
sex (string) --
The sex of the patient.
status (string) --
The status of the patient, either new or established.
dateOfBirth (string) --
The date of birth of the patient, in YYYY-MM-DD format. The date can't be after the current date in UTC.
insurance (string) --
The insurance of the patient.
encounterContext (dict) --
The encounter context that you provided for the job.
encounterType (string) --
The type of the encounter, either in person or telehealth.
encounterReason (string) --
The reason for the encounter. The reason can contain letters, numbers, spaces, periods, commas, and hyphens, and can't contain only spaces.
afterHours (boolean) --
Specifies whether the encounter took place outside regular business hours.
encounterDate (string) --
The date of the encounter, in YYYY-MM-DD format. The date can't be more than one day after the current date in UTC.
encounterDurationMinutes (integer) --
The duration of the encounter, in minutes, from 1 to 1440.
outputDataConfig (dict) --
The output configuration that you provided for the job.
s3OutputPath (string) --
The Amazon S3 location where Amazon Connect Health writes the results of the job.
datasetId (string) --
The unique identifier of the dataset that the job codes against. Not returned if the job uses the general medical coding knowledge base.
medicalCodingOutput (dict) --
The location of the job results. Returned when the job succeeds.
uri (string) --
The Amazon S3 location of the medical codes that the job generated.
statusDetails (string) --
Details about the status of the job, such as the reason that it failed.
Starts an asynchronous job that generates medical codes (ICD-10 and CPT) for clinical text. Call GetMedicalCodingJob to check the status of the job. When the job succeeds, Amazon Connect Health writes the results to the output Amazon S3 location.
To tailor the codes to your organization, specify an ACTIVE medical coding dataset in the Domain. If you don't specify a dataset, the job uses the general medical coding knowledge base.
Medical coding jobs are in preview release and are subject to change.
See also: AWS API Documentation
Request Syntax
client.start_medical_coding_job(
domainId='string',
text='string',
patientContext={
'sex': 'MALE'|'FEMALE'|'NON_BINARY'|'UNKNOWN',
'status': 'NEW'|'ESTABLISHED',
'dateOfBirth': 'string',
'insurance': 'string'
},
encounterContext={
'encounterType': 'TELEHEALTH'|'IN_PERSON',
'encounterReason': 'string',
'afterHours': True|False,
'encounterDate': 'string',
'encounterDurationMinutes': 123
},
outputDataConfig={
's3OutputPath': 'string'
},
datasetId='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the parent Domain.
string
[REQUIRED]
The clinical text to generate medical codes for, such as a clinical note.
dict
Patient context for the job. Providing this information can improve the accuracy of the medical codes.
sex (string) --
The sex of the patient.
status (string) --
The status of the patient, either new or established.
dateOfBirth (string) --
The date of birth of the patient, in YYYY-MM-DD format. The date can't be after the current date in UTC.
insurance (string) --
The insurance of the patient.
dict
Encounter context for the job. Providing this information can improve the accuracy of the medical codes.
encounterType (string) --
The type of the encounter, either in person or telehealth.
encounterReason (string) --
The reason for the encounter. The reason can contain letters, numbers, spaces, periods, commas, and hyphens, and can't contain only spaces.
afterHours (boolean) --
Specifies whether the encounter took place outside regular business hours.
encounterDate (string) --
The date of the encounter, in YYYY-MM-DD format. The date can't be more than one day after the current date in UTC.
encounterDurationMinutes (integer) --
The duration of the encounter, in minutes, from 1 to 1440.
dict
[REQUIRED]
The output configuration for the job.
s3OutputPath (string) -- [REQUIRED]
The Amazon S3 location where Amazon Connect Health writes the results of the job.
string
The unique identifier of an ACTIVE medical coding dataset in the Domain to code against. If you don't specify a dataset, the job uses the general medical coding knowledge base.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'jobArn': 'string',
'jobId': 'string',
'creationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
jobArn (string) --
The Amazon Resource Name (ARN) of the medical coding job.
jobId (string) --
The unique identifier of the medical coding job.
creationTime (datetime) --
The date and time that the medical coding job was created.
Starts deleting a Dataset and the resources that Amazon Connect Health built for it. You can delete a dataset whose status is ACTIVE, CREATE_FAILED, or DELETE_FAILED. The dataset moves to DELETING, and then to DELETED. If the delete fails, the dataset moves to DELETE_FAILED, and you can call DeleteDataset again.
Medical coding jobs that already use the dataset finish. Amazon Connect Health rejects new requests that specify the dataset.
Datasets are in preview release and are subject to change.
See also: AWS API Documentation
Request Syntax
client.delete_dataset(
domainId='string',
datasetId='string'
)
string
[REQUIRED]
The unique identifier of the parent Domain.
string
[REQUIRED]
The unique identifier of the dataset to delete.
dict
Response Syntax
{
'arn': 'string',
'datasetId': 'string',
'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'DELETED'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the dataset.
datasetId (string) --
The unique identifier of the dataset.
status (string) --
The status of the dataset. After Amazon Connect Health accepts the request, the status is DELETING.
Submits feedback on a clinical document or a set of medical codes that Amazon Connect Health generated.
See also: AWS API Documentation
Request Syntax
client.submit_feedback(
domainId='string',
artifactSourceId='string',
subscriptionId='string',
artifactType='CLINICAL_DOC'|'MEDICAL_CODES',
signedArtifactS3Uri='string',
generatedArtifactS3Uri='string',
comments='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the parent Domain.
string
[REQUIRED]
The identifier of the artifact source. For a clinical document, this is the session ID. For a set of medical codes, this is the medical coding job ID.
string
The unique identifier of the Subscription.
string
[REQUIRED]
The type of artifact that you submit feedback for. The following values are valid:
CLINICAL_DOC is the clinical document generated for an ambient documentation session.
MEDICAL_CODES is the set of medical codes generated by a medical coding job.
string
[REQUIRED]
The Amazon Simple Storage Service (Amazon S3) URI of the final artifact that the clinician signed.
string
The Amazon S3 URI of the clinical document or set of medical codes that Amazon Connect Health generated.
string
Optional comments about the feedback.
string
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --
{'medicalScribeListeningSessionDetails': {'medicalCodingContextProvided': 'boolean',
'postStreamActionResult': {'clinicalNoteGenerationResult': {'afterVisitSummaryResult': {'status': {'PENDING',
'SKIPPED'}},
'noteResult': {'status': {'PENDING',
'SKIPPED'}},
'transcriptResult': {'status': {'PENDING',
'SKIPPED'}}},
'medicalCodeGenerationResult': {'jobId': 'string',
'medicalCodesResult': {'failureReason': 'string',
'outputLocation': 'string',
'status': 'IN_PROGRESS '
'| '
'FAILED '
'| '
'COMPLETED '
'| '
'PENDING '
'| '
'SKIPPED'}}},
'postStreamActionSettings': {'medicalCodeGenerationSettings': {'enabled': 'boolean'}}}}
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'
)
string
[REQUIRED]
The Session identifier
string
[REQUIRED]
The Domain identifier
string
[REQUIRED]
The Subscription identifier
dict
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'
}
}
},
'medicalCodeGenerationSettings': {
'enabled': True|False
}
},
'postStreamActionResult': {
'clinicalNoteGenerationResult': {
'noteResult': {
'outputLocation': 'string',
'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED'|'PENDING'|'SKIPPED',
'failureReason': 'string'
},
'transcriptResult': {
'outputLocation': 'string',
'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED'|'PENDING'|'SKIPPED',
'failureReason': 'string'
},
'afterVisitSummaryResult': {
'outputLocation': 'string',
'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED'|'PENDING'|'SKIPPED',
'failureReason': 'string'
}
},
'medicalCodeGenerationResult': {
'medicalCodesResult': {
'outputLocation': 'string',
'status': 'IN_PROGRESS'|'FAILED'|'COMPLETED'|'PENDING'|'SKIPPED',
'failureReason': 'string'
},
'jobId': 'string'
}
},
'encounterContextProvided': True|False,
'medicalCodingContextProvided': 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
managedTemplate (dict) --
templateType (string) --
The type of managed template used
customTemplate (dict) --
templateType (string) --
The base template type that was customized
medicalCodeGenerationSettings (dict) --
Settings for medical code generation. Returned only if you specified medicalCodeGenerationSettings when you started the session.
enabled (boolean) --
Indicates whether medical code generation was requested for the session.
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
medicalCodeGenerationResult (dict) --
Results of medical code generation. Returned if medical code generation runs for the session. Not returned if you set enabled to false in medicalCodeGenerationSettings.
medicalCodesResult (dict) --
Details about the generated medical codes. If the status is SKIPPED, medical codes weren't generated, for example because the clinical note wasn't generated or had no content.
outputLocation (string) --
status (string) --
The generation status of the artifact
failureReason (string) --
The reason for failure if the artifact generation failed
jobId (string) --
The identifier of the medical coding job that generated the medical codes. To submit feedback on the medical codes, use this value as the artifactSourceId, with the artifactType MEDICAL_CODES, in SubmitFeedback.
encounterContextProvided (boolean) --
Indicates whether encounter context was provided
medicalCodingContextProvided (boolean) --
Indicates whether medical coding 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
{'inputStream': {'configurationEvent': {'encounterContext': {'medicalCodingContext': {'afterHours': 'boolean',
'dateOfBirth': 'string',
'encounterDate': 'string',
'encounterReason': 'string',
'encounterType': 'TELEHEALTH '
'| '
'IN_PERSON',
'sex': 'MALE '
'| '
'FEMALE '
'| '
'NON_BINARY '
'| '
'UNKNOWN',
'status': 'NEW '
'| '
'ESTABLISHED'}},
'postStreamActionSettings': {'medicalCodeGenerationSettings': {'enabled': 'boolean'}}}}}
Response {'responseStream': {'checklistEvent': {'checklists': [{'checklistId': 'string',
'items': [{'itemKey': 'string',
'status': 'DISCUSSED '
'| '
'PARTIALLY_DISCUSSED '
'| '
'NOT_DISCUSSED'}]}],
'snapshotVersion': 'long'},
'periodontalChartEvent': {'reviewItems': [{'reason': 'SITE_NOT_CHARTED '
'| '
'VALUE_NOT_CHARTED '
'| '
'READING_COUNT_MISMATCH '
'| '
'LINE_UNCLEAR '
'| '
'TOOTH_UNCLEAR '
'| '
'MISSING_TOOTH_CONFLICT '
'| '
'MEASUREMENT_NOT_CHARTED '
'| '
'SESSION_ISSUE',
'sites': ['DB | '
'B | '
'MB | '
'DL | '
'L | '
'ML'],
'toothNumber': 'integer'}],
'snapshotVersion': 'long',
'teeth': [{'furcation': 'integer',
'missing': 'boolean',
'mobility': 'integer',
'sites': [{'bleeding': 'boolean',
'probingDepth': 'integer',
'recession': 'integer',
'site': 'DB '
'| '
'B '
'| '
'MB '
'| '
'DL '
'| '
'L '
'| '
'ML',
'suppuration': 'boolean'}],
'toothNumber': 'integer'}]}}}
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={...}
)
string
[REQUIRED]
The Session identifier
string
[REQUIRED]
The Domain identifier
string
[REQUIRED]
The Subscription identifier
string
[REQUIRED]
The Language Code for the audio in the session
integer
[REQUIRED]
The sample rate of the input audio
string
[REQUIRED]
The encoding for the input audio
dict
dict
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'
},
'periodontalChartEvent': {
'snapshotVersion': 123,
'teeth': [
{
'toothNumber': 123,
'missing': True|False,
'mobility': 123,
'furcation': 123,
'sites': [
{
'site': 'DB'|'B'|'MB'|'DL'|'L'|'ML',
'probingDepth': 123,
'recession': 123,
'bleeding': True|False,
'suppuration': True|False
},
]
},
],
'reviewItems': [
{
'reason': 'SITE_NOT_CHARTED'|'VALUE_NOT_CHARTED'|'READING_COUNT_MISMATCH'|'LINE_UNCLEAR'|'TOOTH_UNCLEAR'|'MISSING_TOOTH_CONFLICT'|'MEASUREMENT_NOT_CHARTED'|'SESSION_ISSUE',
'toothNumber': 123,
'sites': [
'DB'|'B'|'MB'|'DL'|'L'|'ML',
]
},
]
},
'checklistEvent': {
'snapshotVersion': 123,
'checklists': [
{
'checklistId': 'string',
'items': [
{
'itemKey': 'string',
'status': 'DISCUSSED'|'PARTIALLY_DISCUSSED'|'NOT_DISCUSSED'
},
]
},
]
}
})
}
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 that contains transcript events, periodontal chart events, checklist events, and errors.
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) --
periodontalChartEvent (dict) --
Real-time extraction is in preview release for Amazon Connect Health and is subject to change. To request access to this feature, contact your AWS account team.
A snapshot of the periodontal chart. Amazon Connect Health sends this event only when real-time extraction is enabled for the account and periodontal charting is dictated during the session.
snapshotVersion (integer) --
The version of this snapshot. Versions increase within a session and can skip values. Keep the snapshot with the highest version and ignore any event whose version is not higher, including after you reconnect to the session. Versions of checklist events and periodontal chart events are independent.
teeth (list) --
The teeth that have a recorded value or are marked missing, in ascending toothNumber order.
(dict) --
The chart for one tooth.
toothNumber (integer) --
The tooth number in the Universal Numbering System. The value ranges from 1 to 32.
missing (boolean) --
Specifies whether the tooth is missing.
mobility (integer) --
The tooth mobility grade. The value ranges from 0 to 3.
furcation (integer) --
The furcation involvement class. The value ranges from 0 to 3.
sites (list) --
The probing sites that have a recorded measurement, in the order MB, B, DB, ML, L, DL.
(dict) --
The measurements at one probing site of a tooth.
site (string) --
The probing site. The following values are valid:
DB: Distobuccal.
B: Buccal.
MB: Mesiobuccal.
DL: Distolingual.
L: Lingual.
ML: Mesiolingual.
probingDepth (integer) --
The probing depth, in millimeters. The value ranges from 0 to 15.
recession (integer) --
The gingival recession, in millimeters. The value ranges from -5 to 15. For example, -1 represents "plus one."
bleeding (boolean) --
Specifies whether the site bled during probing.
suppuration (boolean) --
Specifies whether suppuration was present at the site.
reviewItems (list) --
Items that need the clinician's confirmation.
(dict) --
An item of the periodontal chart that needs the clinician's confirmation.
reason (string) --
The reason for review. The following values are valid:
SITE_NOT_CHARTED: One or more sites have no reading.
VALUE_NOT_CHARTED: A dictated value or charting instruction was not charted, for example because the value was out of range or not valid at its position.
READING_COUNT_MISMATCH: The number of dictated values did not match the number of open sites. The values were charted as dictated.
LINE_UNCLEAR: A line of dictation could not be interpreted and was not charted.
TOOTH_UNCLEAR: A line of dictation did not identify the tooth and was not charted.
MISSING_TOOTH_CONFLICT: The dictation conflicts with a tooth marked as missing.
MEASUREMENT_NOT_CHARTED: The dictation included a measurement that the chart does not record, such as plaque, calculus, or the mucogingival junction.
SESSION_ISSUE: The exam setup could not be used and all teeth were assumed to be present, or the earlier chart could not be restored and charting restarted.
toothNumber (integer) --
The tooth that the item refers to.
sites (list) --
The probing sites of that tooth that the item refers to.
(string) --
checklistEvent (dict) --
Real-time extraction is in preview release for Amazon Connect Health and is subject to change. To request access to this feature, contact your AWS account team.
A snapshot of the session's checklist. Amazon Connect Health sends this event only when real-time extraction is enabled for the account and the session uses a supported note template.
snapshotVersion (integer) --
The version of this snapshot. Versions increase within a session and can skip values. Keep the snapshot with the highest version and ignore any event whose version is not higher, including after you reconnect to the session. Versions of checklist events and periodontal chart events are independent.
checklists (list) --
The checklists for the session. The list is empty when no checklist is active.
(dict) --
Contains the sections of a note template checklist and the discussion status of each section.
checklistId (string) --
The identifier of the checklist. For a managed note template, this value is the template type, such as HISTORY_AND_PHYSICAL. For a custom note template, this value is CUSTOM_ followed by the template base, such as CUSTOM_GIRPP.
items (list) --
The checklist items in template order. The list contains one item for each checklist section, including sections that have not been discussed.
(dict) --
Contains a checklist item and its discussion status.
itemKey (string) --
The key that uniquely identifies the item within the checklist. For a managed note template, this value is a service-defined section key, such as CHIEF_COMPLAINT. For a custom note template, this value is the sectionHeader of the section that you defined.
status (string) --
The discussion status of the checklist item. The following values are valid:
DISCUSSED: The conversation has covered the item.
PARTIALLY_DISCUSSED: The conversation has covered part of the item.
NOT_DISCUSSED: The conversation has not covered the item.
The status usually progresses toward DISCUSSED, but it can return to NOT_DISCUSSED if a speaker retracts a statement.