Skip to main content

Getting Started

Before you can use HealthShare Message Transformation Services, you must set up the following locations, which are external to the services:

  • An input location, which is an Amazon S3 bucket where you will upload the data to be transformed.

  • An error logs location, which is a different Amazon S3 bucket where the services will write error logs.

  • A target location, where HealthShare Message Transformation Services will deposit FHIR resources. This may be an S3 bucket or an Amazon HealthLake data store.

You must also create an AWS Identity and Access Management (IAM) user with access to these locations.

The following sections walk you through these tasks and describe how to create an account for HealthShare Message Transformation Services and log in.

Set Up the Input and Error Logs Locations

To set up the input and error logs locations, perform the following steps:

  1. Create an Amazon S3 bucket. For instructions, refer to the Amazon S3 documentation:

    https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html

  2. Create two folders within the S3 bucket, one for input and one error logs. For example:

    s3://Transformation/in/
    s3://Transformation/logs/
    

Set Up the Target Location

To set up the target location, choose between Amazon HealthLake and Amazon S3. Perform the following steps for the service you chose.

Targeting Amazon HealthLake Data Store

  1. Create an Amazon HealthLake data store.

    For instructions, refer to the Amazon HealthLake documentation:

    https://docs.aws.amazon.com/healthlake/latest/devguide/what-is-amazon-health-lake.html

  2. Note the Data Store Id, which is a series of alphanumeric characters.

Targeting Amazon S3 Bucket

  1. Create an Amazon S3 bucket. For instructions, refer to the Amazon S3 documentation:

    https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html

    Note:

    Instead of creating a new bucket, you may use the same bucket you created for the input and error logs.

  2. Create a folder within the S3 bucket for the output. For example:

    s3://Transformation/out/
    

Creating an AWS IAM Policy for Accessing the Input Location, Error Logs Location, and Target Location

In the AWS IAM console, a policy defines a set of permissions that you can assign to a user, group, or role. To enable HealthShare Message Transformation Services to interact with the input location, error logs location, and target location, you must create a new policy with appropriate permissions.

To get started, see these example policies:

For detailed instructions on creating a new policy, refer to the AWS IAM documentation:

https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html

AWS IAM Policy Example: Amazon S3 Input and Amazon S3 Target

The following Amazon IAM policy grants access to an Amazon S3 bucket containing the input, error, and target locations:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "healthshare0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:ListBucket",
                "s3:DeleteObject",
                "s3:GetBucketLocation"
            ],
            "Resource": [
                "arn:aws:s3:::<bucket-name>",
                "arn:aws:s3:::<bucket-name>/*"
            ]
        }
    ]
}

To use this example, replace <bucket-name> with the name of your Amazon S3 bucket. For instance, if your input location is s3://Transformation/in/, the corresponding section of the policy would look like:

"Resource": [
    "arn:aws:s3:::Transformation",
    "arn:aws:s3:::Transformation/*",
]

AWS IAM Policy Example: Amazon S3 Input and Amazon HealthLake Target

The following Amazon IAM policy grants access to an Amazon HealthLake data store target location and an Amazon S3 bucket containing the input and error locations:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "healthshare0",
            "Effect": "Allow",
            "Action": [
                "healthlake:CreateResource",
                "healthlake:ReadResource",
                "healthlake:DeleteResource",
                "healthlake:SearchWithGet",
                "healthlake:SearchWithPost",
                "healthlake:UpdateResource",
                "healthlake:GetCapabilities"
            ],
            "Resource": [
                "arn:aws:healthlake:<region>:<account_id>:datastore/fhir/<datastore_id>"
            ]
        },
        {
            "Sid": "healthshare1",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:ListBucket",
                "s3:DeleteObject",
                "s3:GetBucketLocation"
            ],
            "Resource": [
                "arn:aws:s3:::<bucket-name>",
                "arn:aws:s3:::<bucket-name>/*"
            ]
        }
    ]
}

To use this example, you must fill in the placeholder values. The placeholders are:

  • <region> — The AWS region code for your HealthLake data store. For example, us-east-1.

  • <account_id> — The twelve-digit account ID for the Amazon account that owns the data store. For example, 123456789123.

  • <datastore_id> — The data store ID, which you can find in the Amazon HealthLake console. For example, 573dabaa35d8d0d92e5aa6aca4d5a3q3.

  • <bucket-name> — The name of the Amazon S3 bucket you are using. For example, Transformation. This needs to be filled in twice in the example policy.

Provide HealthShare Message Transformation Services with Access to the AWS IAM Policy

Once you have created a policy that defines access to the input location, error location, and target location, you must allow HealthShare Message Transformation Services to use the policy. You may accomplish this using either of the following methods:

Create a New Account

After you sign up for HealthShare Message Transformation Services, InterSystems provides you with instructions for accessing your organization’s Sign Up page.

To create an account, perform the following steps:

  1. Navigate to the URL provided by InterSystems.

  2. Fill in the required fields.

  3. Click Create Account.

Log In

After you create an account, you can log in the to the services with the username and password that you specified for yourself.

To log into the services, perform the following steps:

  1. Navigate to the URL for your organization’s Sign In page.

  2. Enter your credentials.

  3. Click Submit.

    The HealthShare Message Transformation Services home page appears and lists any existing transformation pipelines.

Try the Demo Tool

HealthShare Message Transformation Services includes a demo feature which you may use to gain a better understanding of how the transformation operates. The Demo Tool allows you to enter sample data into a text box and view the FHIR output.

Important:

The Demo Tool should only be used on sample data. It should not be used on sensitive data, nor should it be used instead of a pipeline.

To use the Demo Tool:

  1. Click Demo Tool from the hamburger menu on the left side of the screen.

  2. Select the sample data format from the Type of Message drop-down list.

  3. Paste your sample data into the text box. Alternately, you may select Fill with Sample to populate the text box.

  4. Click Transform to FHIR and review the Transformed Message preview that appears on the left side of the page.

  5. Select one of the FHIR resources to view more information about that resource.

Change Display Name

You can change your display name, which is the name that appears in the top-right corner of the application, as follows:

  1. In the top-right corner, click your display name.

  2. Click View Profile.

  3. Click Edit.

  4. Modify the name fields as needed.

  5. Click Save.

Change Password

You can change your password as follows:

  1. In the top-right corner, click your display name.

  2. Click View Profile.

  3. Click Change Password.

  4. Fill in the fields.

  5. Click Confirm Password Change.

Feedback