Create a destination for AWS + HealthLake

Last updated: Dec 13, 2024
IMPLEMENTATION
HEALTH TECH VENDOR

For cloud connectivity with Redox, you decide which cloud provider and cloud product(s) to use. Then, you'll need to create a cloud destination in your Redox organization.

You'll need to perform some steps in your cloud product(s) and some in Redox. You can perform Redox setup in our dashboard or with the Redox Platform API.

Cloud products

This article is for this combination of cloud products:

  • Amazon Web Services (AWS)
  • HealthLake

Configure in AWS

  1. Navigate to the AWS dashboard and log in.
  2. Generate an access key and secret pair.
  3. Create a new HealthLake datastore, or open an existing one.

Create a cloud destination in Redox

Next, create a cloud destination in your Redox organization. This destination will be where your data is pushed to.

In the dashboard

  1. From the Product type field, select HealthLake.
  2. For the configure destination step, populate these fields. Then click the Next button.
    1. FHIR® URL: Enter the AWS FHIR® endpoint where data should be sent.
  3. For the auth credential step, either a drop-down list of existing auth credentials displays or a new auth credential form opens. Learn how to create an auth credential for AWS Sigv4.

With the Redox Platform API

  1. In your terminal, prepare the /v1/authcredentials request.
  2. Specify these values in the request.
    • Locate the accessKeyId and secretAccessKey values in the AWS dashboard.
      Example: Create auth credential for AWS + HealthLake
      json
      1
      curl 'https://api.redoxengine.com/platform/v1/authcredentials' \
      2
      --request POST \
      3
      --header 'Authorization: Bearer $API_TOKEN' \
      4
      --header 'accept: application/json' \
      5
      --header 'content-type: application/json' \
      6
      --data '{
      7
      "organization": "<Redox_organization_id>"
      8
      "name": "<human_readable_name_for_auth_credential>"
      9
      "environmentId": "<Redox_environment_ID>"
      10
      "authStrategy": "AwsSigV4"
      11
      "accessKey": "<access_key_from_AWS>"
      12
      "secretKey": "<secret_key_from_AWS>"
      13
      "serviceName": "healthlake"
      14
      "awsRegion": "<aws_region_of_healthlake_datastore>"
      15
      }
  3. You should get a successful response with details for the new auth credential.
  4. In your terminal, prepare the /v1/environments/{environmentId}/destinations request.
  5. Specify these values in the request.
    • Set authCredential to the auth credential ID from the response you received in step #4.
    • Populate cloudProviderSettings with the settings below.
      • Locate the FHIR® base URL in the AWS dashboard.
        Example: Values for AWS + HealthLake cloudProviderSettings
        json
        1
        {
        2
        "cloudProviderSettings": {
        3
        "typeId": "aws",
        4
        "productId": "healthlake",
        5
        "settings": {
        6
        "fhirBaseUrl": "<URL_of_healthlake_datastore>",
        7
        }
        8
        }
        9
        }
  6. You should get a successful response with details for the new destination for AWS.
  7. Your new destination will now be able to receive messages. Redox converts any notification bundles or other message bundles into individual FHIR® resource requests, which are stored in the HealthLake datastore.