View Source AWS.ConnectHealth (aws-elixir v1.0.12)

Amazon Connect Health is an AI-powered healthcare service built on Amazon Connect.

It provides pre-built agents that automate patient engagement workflows and support clinical documentation at the point of care.

You can use the Amazon Connect Health API to programmatically manage domains, configure patient engagement agents, run patient insights jobs, and stream ambient documentation sessions. This API reference describes the available API operations and data types for Amazon Connect Health.

We recommend that you use the AWS SDKs to make programmatic API calls to Amazon Connect Health.

Link to this section Summary

Functions

activate_subscription(client, domain_id, subscription_id, input, options \\ [])

Activates a Subscription to enable billing for a user.

create_domain(client, input, options \\ [])

Creates a new Domain for managing HealthAgent resources.

create_subscription(client, domain_id, input, options \\ [])

Creates a new Subscription within a Domain for billing and user management.

deactivate_subscription(client, domain_id, subscription_id, input, options \\ [])

Deactivates a Subscription to stop billing for a user.

delete_domain(client, domain_id, input, options \\ [])

Deletes a Domain and all associated resources.

get_domain(client, domain_id, options \\ [])

Retrieves information about a Domain.

get_medical_scribe_listening_session(client, domain_id, session_id, subscription_id, options \\ [])

Retrieves details about an existing Medical Scribe listening session

get_patient_insights_job(client, domain_id, job_id, options \\ [])

Get details of a started patient insights job.

get_subscription(client, domain_id, subscription_id, options \\ [])

Retrieves information about a Subscription.

list_domains(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists Domains for a given account.

list_subscriptions(client, domain_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all Subscriptions within a Domain.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags associated with the specified resource

metadata()

start_medical_scribe_listening_session(client, input, options \\ [])

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

start_patient_insights_job(client, domain_id, input, options \\ [])

Starts a new patient insights job.

tag_resource(client, resource_arn, input, options \\ [])

Associates the specified tags with the specified resource

untag_resource(client, resource_arn, input, options \\ [])

Removes the specified tags from the specified resource

Link to this section Functions

activate_subscription(client, domain_id, subscription_id, input, options \\ [])

Activates a Subscription to enable billing for a user.

create_domain(client, input, options \\ [])

Creates a new Domain for managing HealthAgent resources.

create_subscription(client, domain_id, input, options \\ [])

Creates a new Subscription within a Domain for billing and user management.

deactivate_subscription(client, domain_id, subscription_id, input, options \\ [])

Deactivates a Subscription to stop billing for a user.

delete_domain(client, domain_id, input, options \\ [])

Deletes a Domain and all associated resources.

get_domain(client, domain_id, options \\ [])

Retrieves information about a Domain.

get_medical_scribe_listening_session(client, domain_id, session_id, subscription_id, options \\ [])

Retrieves details about an existing Medical Scribe listening session

get_patient_insights_job(client, domain_id, job_id, options \\ [])

Get details of a started patient insights job.

get_subscription(client, domain_id, subscription_id, options \\ [])

Retrieves information about a Subscription.

list_domains(client, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

Lists Domains for a given account.

list_subscriptions(client, domain_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all Subscriptions within a Domain.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags associated with the specified resource

metadata()

start_medical_scribe_listening_session(client, input, options \\ [])

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

start_patient_insights_job(client, domain_id, input, options \\ [])

Starts a new patient insights job.

tag_resource(client, resource_arn, input, options \\ [])

Associates the specified tags with the specified resource

untag_resource(client, resource_arn, input, options \\ [])

Removes the specified tags from the specified resource