Skip to main content
info
This documentation is for version v2.4 of the product.
For the latest version(v2.7) documentation click here
Version: v2.4 print this page

Healthlake

Amazon Healthlake is a HIPAA-eligible service that can be used to store, transform, query, and analyze large-scale health data. This enables health data to be ingested into Amorphic datasets and used for further downstream querying and analysis using the Query Engine.

Note

To use Healthlake, HCLS should be enabled in the environment.

How to create a Healthlake store?

  1. Click on + New Healthlake.
  2. Fill in the required fields (Details listed below).

Create Healthlake

Following fields are needed to create a Healthlake store:

  • Store Name: The name for the Healthlake data store.
  • Description: A brief description about the Healthlake data store.
  • Keywords: Optional keywords for the Healthlake data store. This can be used to flag related stores.
  • Preload Sample Data: Enable/disable preloading of sample data.
  • Auto Terminate: This enables Healthlake Store termination to save resource costs based on the termination time value provided by the user. Auto termination process is triggered every hour and looks for any Healthlake Store that needs to be notified or deleted and sends an email when one of the below criteria is met. The user will receive a notification email in the following scenarios:
    • If the difference between the auto-terminate process trigger run (every whole hour) and the termination time is less than 30 minutes.
    • If the auto-termination process was successfully able to delete the Healthlake Store after the termination time.
    • If the auto-termination process wasn't able to delete the Healthlake Store due to some fatal errors.
  • Auto Termination Time: Time at which the system auto terminates the Healthlake store.
Note
  • Auto-termination process is scheduled to run every hour on the hour (e.g: 6:00, 7:00, 8:00, 9:00).
  • User will receive a email notification only when the user is subscribed to alerts. Please refer to Alert Preferences to enable alerts.
  • When the termination time elapses, auto termination process will terminate/delete the Healthlake Store and also deletes all the metadata related to the Healthlake Store and this process cannot be undone.

After entering the details, click the Create button to initiate the Healthlake data store creation.

Healthlake Store details

Once the store creation is triggered, the store details will appear in the page in this format.

Healthlake Details

How to import data into Healthlake?

  1. Under the Import Jobs tab, click on the + New Job button.
  2. In the following form, specify a dataset which contains the data.

Import Data into Healthlake

Note

Only files of ndjson format will be imported into HealthLake.

This is an asynchronous process and will take a while to complete.

If an import job only succeeds partially, then the failed files as well as the manifest file can be downloaded from the Job details tab, as shown below. Healthlake Job Details

How to query Healthlake datasets?

  1. Go to Analytics > Query Engine.
  2. Generate a sample query by specifying the Healthlake Domain and desired dataset.

Query Healthlake Dataset

  1. Click on the icon and change workgroup to Amazon Athena Engine V3
  2. Run the desired query.