Amazon Web Services, Inc.

Amazon HealthLake

This is the HealthLake API Reference . For an introduction to the service, see What is HealthLake? in the HealthLake Developer Guide .

Healthcare#openapi#cloud

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

This is the HealthLake API Reference . For an introduction to the service, see What is HealthLake? in the HealthLake Developer Guide .

Endpoints 28

Data transformation profile

  • POSTTransform data/#X-Amz-Target=HealthLake.TransformDataTransforms clinical data synchronously to a Fast Healthcare Interoperability Resources R4 (FHIR R4) Bundle using a specified data transformation profile.
  • POSTCreate data transformation profile/#X-Amz-Target=HealthLake.CreateDataTransformationProfileCreates a data transformation profile in DRAFT state. Specify a built-in starter profile, an existing profile version, raw profile content, or a sample data…
  • POSTDelete data transformation profile/#X-Amz-Target=HealthLake.DeleteDataTransformationProfileDeletes a data transformation profile and all its versions, including the DRAFT and all published versions.
  • POSTGet data transformation profile/#X-Amz-Target=HealthLake.GetDataTransformationProfileRetrieves a data transformation profile's metadata and profile content at a specific version. Specify version 0 to retrieve the DRAFT, a version number…
  • POSTList data transformation profile versions/#X-Amz-Target=HealthLake.ListDataTransformationProfileVersionsLists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first). Use…
  • POSTList data transformation profiles/#X-Amz-Target=HealthLake.ListDataTransformationProfilesLists all data transformation profiles in your account, returning the latest version summary for each. Use GetDataTransformationProfile to retrieve profile…
  • POSTPublish data transformation profile/#X-Amz-Target=HealthLake.PublishDataTransformationProfilePromotes the current DRAFT version of a data transformation profile to a new immutable published version. Also supports rollback by publishing from a…
  • POSTStart data transformation job/#X-Amz-Target=HealthLake.StartDataTransformationJobStarts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or…
  • POSTUpdate data transformation profile/#X-Amz-Target=HealthLake.UpdateDataTransformationProfileUpdates the DRAFT version (version 0) of a data transformation profile with new profile content. The update replaces all existing DRAFT content.
  • POSTUpdate profile with agent/#X-Amz-Target=HealthLake.UpdateProfileWithAgentUpdates a data transformation profile using chat-based interaction with an agent. Supports multi-turn conversations for iteratively customizing profiles.
  • POSTList tags for resource/#X-Amz-Target=HealthLake.ListTagsForResourceReturns a list of all existing tags associated with a data store.
  • POSTTag resource/#X-Amz-Target=HealthLake.TagResourceAdd a user-specifed key and value tag to a data store.
  • POSTUntag resource/#X-Amz-Target=HealthLake.UntagResourceRemove a user-specifed key and value tag from a data store.
  • POSTValidate source/#X-Amz-Target=HealthLake.ValidateSourceValidates a source file against format specifications without performing conversion. Returns detailed validation issues including line and column locations,…
  • POSTCreate fHIR datastore/#X-Amz-Target=HealthLake.CreateFHIRDatastoreCreate a FHIR-enabled data store.
  • POSTDelete fHIR datastore/#X-Amz-Target=HealthLake.DeleteFHIRDatastoreDelete a FHIR-enabled data store.
  • POSTDescribe data transformation job/#X-Amz-Target=HealthLake.DescribeDataTransformationJobDescribes a data transformation job, including its current status, configuration, and progress information.
  • POSTDescribe fHIR datastore/#X-Amz-Target=HealthLake.DescribeFHIRDatastoreGet properties for a FHIR-enabled data store.
  • POSTDescribe fHIR export job/#X-Amz-Target=HealthLake.DescribeFHIRExportJobGet FHIR export job properties.
  • POSTDescribe fHIR import job/#X-Amz-Target=HealthLake.DescribeFHIRImportJobGet the import job properties to learn more about the job or job progress.
  • POSTList data transformation jobs/#X-Amz-Target=HealthLake.ListDataTransformationJobsLists data transformation jobs for your Amazon Web Services account. Results can be filtered by status, job name, and submit time window. Results are…
  • POSTList fHIR datastores/#X-Amz-Target=HealthLake.ListFHIRDatastoresList all FHIR-enabled data stores in a user’s account, regardless of data store status.
  • POSTList fHIR export jobs/#X-Amz-Target=HealthLake.ListFHIRExportJobsLists all FHIR export jobs associated with an account and their statuses.
  • POSTList fHIR import jobs/#X-Amz-Target=HealthLake.ListFHIRImportJobsList all FHIR import jobs associated with an account and their statuses.
  • POSTRestore fHIR datastore/#X-Amz-Target=HealthLake.RestoreFHIRDatastoreRestore a backup-enabled data store to a point in time. Creates a new data store from the backup.
  • POSTStart fHIR export job/#X-Amz-Target=HealthLake.StartFHIRExportJobStart a FHIR export job.
  • POSTStart fHIR import job/#X-Amz-Target=HealthLake.StartFHIRImportJobStart importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results…
  • POSTUpdate fHIR datastore/#X-Amz-Target=HealthLake.UpdateFHIRDatastoreUpdate the properties of a FHIR-enabled data store.

API details

Base URL
https://healthlake.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
28 operations on 28 pathsPOST 28
Main resources
Data transformation profile 10
Description format
AWS Smithy model, API version 2017-07-01

How to test the Amazon HealthLake 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 Amazon HealthLake 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 “Transform data” (POST /#X-Amz-Target=HealthLake.TransformData), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon HealthLake?

This is the HealthLake API Reference . For an introduction to the service, see What is HealthLake? in the HealthLake Developer Guide . It is listed under Healthcare and has 28 endpoints.

Who publishes the Amazon HealthLake?

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 Amazon HealthLake?

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

How do I authenticate with the Amazon HealthLake?

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

How many endpoints does the Amazon HealthLake have?

28 operations on 28 paths (28 POST). The largest groups are Data transformation profile.

Is forking the Amazon HealthLake 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.