Skip to main content

Configuring HealthShare Message Transformation Services

To configure HealthShare Message Transformation Services, you create one or more transformation pipelines. A transformation pipeline is a channel between an input location, HealthShare Message Transformation Services, and a target location.

A transformation pipelines stores several key pieces of information:

  • The type of input data you will supply (for example, HL7 version 2 messages)

  • The type of output data you expect (for example, FHIR R4 resources)

  • Where the services can retrieve the input data

  • Where the services should deposit the output data

  • The credentials required to access the input location and target location

  • Metrics that you can use to determine the efficiency of the pipeline

  • Error logs that enable you to troubleshoot the pipeline

The following sections describe how to manage transformation pipelines and credentials.

Create a Transformation Pipeline

You can create one or more transformation pipelines as follows:

  1. In the HealthShare Message Transformation Services home page, click New Transformation Pipeline.

  2. Fill in the fields.

    For a description of each field, see Transformation Pipeline Properties.

  3. Click Save.

    The transformation pipeline remains in Pending status while the services perform the operations required to activate it. When the pipeline is able to transform data, its status changes to Live. For more information, see Transformation Pipeline Statuses.

Edit a Transformation Pipeline

You can edit the properties of a transformation pipeline as follows:

  1. In the HealthShare Message Transformation Services home page, locate the pipeline to edit.

  2. In the Actions column for the pipeline, click the ellipsis, and then click View.

  3. At the bottom of the Properties page for the pipeline, click Edit.

  4. Modify the properties as needed.

    For a description of each field, see Transformation Pipeline Properties.

  5. Click Save.

Delete a Transformation Pipeline

You can delete transformation pipelines that are no longer needed as follows:

  1. In the HealthShare Message Transformation Services home page, locate the pipeline to delete.

  2. In the Actions column for the pipeline, click the ellipsis, and then click Delete.

    A confirmation message appears.

  3. Click Delete.

Transformation Pipeline Properties

Each transformation pipeline has the following properties:

Name

Specify a name for the transformation pipeline.

Transformation Type

Select the option that best describes the input and output data types.

Input Properties
Input Credentials

Select the credentials that provide HealthShare Message Transformation Services access to the Amazon S3 bucket containing the input data. This may be the same as the Target Credentials.

You can create a new set of credentials by clicking New and specifying the required information. For more information, see Managing Credentials.

Input Location

Specify the name of the Amazon S3 bucket and folder that you will use to supply input data, for example, Transformation/in. For more information see Set Up the Input Location.

You can test whether the services can access the input location by clicking Test.

Additional Input Properties
Error Logs Location

Specify the name of the Amazon S3 bucket that the services will write error logs to, for example, Transformation/logs.

Target Properties
Target Type

Select the cloud-based data repository where HealthShare Message Transformation Services deposits the transformed FHIR resources. The remaining fields change based on your selection.

Target Credentials

Select the credentials that provide HealthShare Message Transformation Services access to the AWS service containing the output data. This may be the same as the Input Credentials.

You can create a new set of credentials by clicking New and specifying the required information. For more information, see Managing Credentials.

HealthLake Id/Target Location

Specify the target location identifier:

  • If using an Amazon HealthLake data store, this is the data store identifier, which you can find in the Amazon HealthLake console.

  • If using an Amazon S3 bucket, this is the bucket name and folder. For example, Transformation/out.

You can test whether the services can access the target location by clicking Test.

For more information see Set Up the Target Location.

Transformation Pipeline Statuses

Transformation pipelines can be in one of several states:

Pending

A user has created a new pipeline or edited an existing pipeline, and HealthShare Message Transformation Services are performing the operations necessary to activate it.

Live

The transformation pipeline is actively polling the input location for files and transforming data.

Deleting

A user has deleted a pipeline and HealthShare Message Transformation Services are performing the operations necessary to remove it.

Unreachable

The transformation pipeline cannot access the input location or target location.

Tip:

If a pipeline is unreachable, you can try editing the Input Credentials or Target Credentials associated with the pipeline. For more information, see Edit a Transformation Pipeline.

Managing Credentials

When you create a transformation pipeline, you specify a set of credentials that enables HealthShare Message Transformation Services to interact with the input location, error logs location, and target location. For these credentials, you may configure cross-account access or provide a pair of keys associated with an AWS IAM user. These methods are described in Provide HealthShare Message Transformation Services with Access to the AWS IAM Policy

You can manage credentials from the HealthShare Message Transformation Services portal.

Add Credentials

To store the credentials in HealthShare Message Transformation Services for use in a transformation pipeline, perform the following steps:

  1. In the HealthShare Message Transformation Services menu, click Credentials.

    The Credentials page appears.

  2. Click New Credentials.

  3. Select the Credential Type, and fill in the remaining fields.

    • Selecting AWS key-pair requires the AWS IAM user’s secret access key. If you do not have this, you can create a new AWS IAM user.

    • Selecting Cross Account requires additional setup within the AWS console.

Delete Credentials

To delete a set of credentials that you no longer need, perform the following steps:

  1. In the HealthShare Message Transformation Services menu, click Credentials.

    The Credentials page appears.

  2. Locate the credentials to delete in the list.

  3. Click the Delete icon for the credentials to delete.

Note:

If you delete a set of credentials from the HealthShare Message Transformation Services portal, you cannot create a set of credentials with the same name for seven days.

FeedbackOpens in a new tab