InterSystems FHIR Transformation Services Reference Information

Deployment Details

In the Deployment Details section of the Overview page, you can view the details of your deployment, including:

• Deployment size

• Number of cores

• Amount of RAM

• Deployment ID

• Underlying InterSystems IRIS platform and version

• Cloud provider and region

• Creation and expiration dates

• High Availability Status

• Service Level and Service Level Urgency

FTS Details

In the FTS Details section of the Overview page, you can view the REST API endpoints for the following transformations:

• Autodetected message type to FHIR

• HL7 v2 to FHIR

• C-CDA to FHIR

• SDA3 to FHIR

For information on how to use these endpoints, see Transform Data using a REST API Endpoint.

Edit S3 Interface Configuration

When you first deployed FHIR Transformation Services, you set up an initial S3 interface configuration.

If you need to edit your existing S3 interface configuration:

1. On the Configurations page for your deployment, make any needed changes to the fields in the Input Properties or Target Properties sections of the screen.

   These fields are the same as described in the Create a Deployment section of this document.

2. Click Save.

3. If you have changed either your input or target S3 buckets, set up a bucket access policy for each bucket.

4. If you have changed your input bucket, activate a trigger on the bucket.

Set Up Bucket Access Policy

In order for FHIR Transformation Services to access your S3 bucket (or buckets), you need to set up an access policy in your AWS account for each bucket.

To set up a bucket access policy:

1. On the Configurations page for your deployment, follow the instructions in the blue How to setup policy access box to set up permissions for FHIR Transformation Services to access your input S3 bucket.

2. If you are using a target S3 bucket that is different from the input S3 bucket, you need to set up a bucket access policy on the target bucket, as well. In such cases, the blue How to setup policy access box will provide a separate policy for you to apply to the target bucket.

Activate Bucket Trigger

After you set up your initial S3 interface configuration or after you change to a new input S3 bucket, you need to activate a trigger on the input bucket to notify FHIR Transformation Services when messages have been placed into the S3 bucket so that the service can pick up the messages for processing.

To activate a trigger on your input S3 bucket, on the Configurations page for your deployment, click Activate Trigger at the bottom of the screen.

View Errors

To view transformation errors, click Errors on the main menu for your deployment.

The displayed errors are divided into three sections:

• Global Errors — Errors for which a valid facility ID/patient ID combination could not be identified. For example, one or both of these ID types might be missing or the message was malformed and could not be parsed.

• Local Errors — Errors for which a valid facility ID/patient ID combination could be identified, but where other required information is missing or not valid.

• Resolved Errors — Errors for which corrections have been determined and the messages have been resubmitted and transformed successfully.

Each error is listed with the date and time of the error, the S3 location where the original healthcare message was moved, and a description of the error. To filter the errors on this page, specify a start date (with an optional start time) and/or an end date (with an optional end time), and click Apply.

Resolve Errors

To use the Errors page as a work list to resolve errors:

1. Find an error in the Global Errors or the Local Errors section of the page.

2. Find the original healthcare message in the errors folder of your input S3 bucket, as indicated in the File column for that error.

3. Identify and fix the error in the message.

4. Resubmit the message by placing the corrected file in the input S3 bucket, in the folder matching the input bucket prefix. See the Configurations page, if you don’t know the input bucket prefix.

5. If the corrected message is transformed successfully, on the Errors page, select the error, and click Resolve Errors. If you have corrected several messages, you can select them and resolve them all at once.

   The errors are moved to the Resolved Errors section of the page.

Create a Key/Value Pair

To create a new key/value pair:

1. On the Metadata page, click Create Metadata.

2. In the Metadata dialog, type the Key and Value.

3. Click Save.

After you create a tag, it shows up in the Metadata list.

Edit the Value of a Tag

To edit the value in an existing key/value pair:

1. On the Metadata page, click the Edit icon in the Actions column for that key/value pair.

2. In the Metadata dialog, type the new Value for the tag.

   It is not possible to edit the name of the key at this time. If you type the name of a key incorrectly, delete the key/value pair and then re-create it.

3. Click Save.

After you edit the value of a tag, the new value shows up in the Metadata list.

Delete a Key/Value Pair

To delete a key/value pair:

1. On the Metadata page, click the Delete icon in the Actions column for that key/value pair.

2. In the Delete Metadata dialog box, type the name of the key you are deleting, and click Delete.

The key/value pair is removed from the Metadata list.

Metadata Example

This example shows how the metadata you create appears in the FHIR output for a C-CDA transformation.

If you create the following tags:

Then the following JSON appears in each FHIR resource in the output:

   "meta": {
      "source": "MS",
      "tag": [
         {
            "code": "MXYZ-CCDA"
         },
                         {
            "code": "VSI"
         },
         {
            "code": "cohortIdValue",
            "system": "urn:dav-cohort-id"
         }
      ]
   },