Amazon Web Services, Inc.

Connect Health

Amazon Connect Health is an AI-powered healthcare service built on Amazon Connect. It provides pre-built agents that automate patient engagement workflows and…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 23

  • POSTActivate subscription/domains/:domainId/subscriptions/:subscriptionId/activateActivates a Subscription to enable billing for a user.
  • GETList datasets/domains/:domainId/datasets?type=string&nextToken=string&maxResults=0Lists 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…
  • POSTCreate dataset/domains/:domainId/datasetsCreates 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…
  • GETList domains/domain?status=string&maxResults=0&nextToken=stringLists Domains for a given account.
  • POSTCreate domain/domainCreates a new Domain for managing HealthAgent resources.
  • GETList subscriptions/domains/:domainId/subscriptions?maxResults=0&nextToken=stringLists all Subscriptions within a Domain.
  • POSTCreate subscription/domains/:domainId/subscriptionsCreates a new Subscription within a Domain for billing and user management.
  • POSTDeactivate subscription/domains/:domainId/subscriptions/:subscriptionId/deactivateDeactivates a Subscription to stop billing for a user.
  • GETGet dataset/domains/:domainId/datasets/:datasetIdRetrieves information about a Dataset, including its status and, after it is built, its results. A dataset whose status is DELETED returns…
  • DELETEDelete dataset/domains/:domainId/datasets/:datasetIdStarts 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…
  • GETGet domain/domain/:domainIdRetrieves information about a Domain.
  • DELETEDelete domain/domain/:domainIdDeletes a Domain and all associated resources.
  • GETGet medical coding job/domain/:domainId/medical-coding-job/:jobIdRetrieves information about a medical coding job, including its status and, when it succeeds, the location of its results. Medical coding jobs are in preview…
  • GETGet medical scribe listening session/medical-scribe-stream/domain/:domainId/subscription/:subscriptionId/session/:sessionIdRetrieves details about an existing Medical Scribe listening session
  • GETGet patient insights job/domain/:domainId/patient-insights-job/:jobIdGet details of a started patient insights job.
  • GETGet subscription/domains/:domainId/subscriptions/:subscriptionIdRetrieves information about a Subscription.
  • GETList tags for resource/tags/:resourceArnLists the tags associated with the specified resource
  • POSTTag resource/tags/:resourceArnAssociates the specified tags with the specified resource
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes the specified tags from the specified resource
  • POSTStart medical coding job/domain/:domainId/medical-coding-jobStarts 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…
  • POSTStart medical scribe listening session/medical-scribe-stream/Starts a new Medical Scribe listening session for real-time audio transcription
  • POSTStart patient insights job/domain/:domainId/patient-insights-jobStarts a new patient insights job.
  • POSTSubmit feedback/domain/:domainId/feedbackSubmits feedback on a clinical document or a set of medical codes that Amazon Connect Health generated.

API details

Base URL
https://health-agent.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
23 operations on 16 pathsGET 10POST 10DELETE 3
Description format
AWS Smithy model, API version 2025-01-29

How to test the Connect Health in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Connect Health collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Activate subscription” (POST /domains/:domainId/subscriptions/:subscriptionId/activate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Connect Health?

Amazon Connect Health is an AI-powered healthcare service built on Amazon Connect. It provides pre-built agents that automate patient engagement workflows and… It is listed under Communication and has 23 endpoints.

Who publishes the Connect Health?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Connect Health?

Requests go to https://health-agent.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Connect Health?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Connect Health have?

23 operations on 16 paths (10 GET, 10 POST, 3 DELETE).

Is forking the Connect Health free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.