Using translation sets

One thing we can all agree on in healthcare is that no one can agree on codes. This means your connection might send messages with different codes or values than your organization uses. Differences in code sets (or Redox value sets) might confuse or complicate ingesting data on your side.

Instead of wasting time detangling codes, you can use a translation set to define how two value sets should map to each other. You can use translation sets to:

• Save time: Automatically translate codes for smooth data exchange instead of manually tweaking data.
• Get relevant data: Make sure data is delivered in a code set that’s pertinent to your context and system.

A value set is a list of values that should be translated during the process of data exchange. A value set could be a common code set like LOINC, SNOMED, or any other you know. It could also be a custom code set that your organization uses.

You must define a value set for each system’s code set. This means you should have two value sets to make up one translation set. Essentially, there should be a value set for each code set you want to translate to or from for each system.

A translation set is a list of individual translations between two value sets. A translation maps either:

• one value to one value

  Example: WISCONSIN to WI

  Your connection stores an address value as WISCONSIN. Your system stores the same address value as the abbreviated WI. A translation can resolve the WISCONSIN value at the specified field path to the value you use instead.

• multiple values to one value

  Example: WISCO or WI to WISCONSIN

  Your connection stores an address value as WISCONSIN. Your system stores the same address value as either the abbreviated WI or WISCO. A translation can resolve your WI or WISCO values at the specified field path to the value your connection uses instead.

You can either build or import translations when creating or editing a translation set in the dashboard. Or, you can add a translation with the Redox Platform API for an existing translation set.

After you link a translation set, we run our magic in the background so that you both send and receive data in the expected format.

Translation sets v Redox base config translation

Translation sets are different from Redox base configs, which include their own base translation. Our base translation provides a consistent experience for all our customers.

For each data model, you can see which fields are included in Redox’s base config translation by using the toggle for Show Translation Fields. Review Data Model API specs.

Here’s an overview of the steps you need to complete to fully create and link a translation set in the Redox dashboard.

1. First, create relevant value sets that you and your connection use.
2. To create a translation set, start by selecting the two value sets you want to translate between.
3. Next, create a translation by mapping a value from the first value set to a value from the second value set. Dive into more details about translations below this list.
4. Repeat the process until you’ve created all the translation mappings you need. This builds your set.
5. Save your translation set.
6. Link a translation set to at least one log processing stage. Dive into more details about linking below this list.

You can do all these steps with the Redox Platform API, too. Review Platform API endpoints.

To apply a translation set, you have to link it to the relevant log processing stage and field path.

Where you link a translation set depends on whether you own either the source, destination, or both. Learn about log processing stages.

You can link a translation set to the processing stages you own. Your connection could also link their own translation sets to their processing stages. This means translation is likely happening to more than just one field, and there could be different translation happening on both sides of the exchange.

A field path is like an “address” for a particular field and value in the data payload.

You can link a translation set to one or more field paths. This means you can use one translation set to update multiple values in a data payload.

A translation set can be either bi-directional, or uni-directional.

• Bi-directional (default): A translation can potentially be linked twice, meaning the translation could happen in both directions. For example, a translation that maps between Value A and Value B means that the values can be translated on both sides of the exchange, back and forth.

  
• Uni-directional: A translation can only be linked once going in one direction. This works for translating one value to one or multiple values to one. For example, if you have a translation from Value to Value B, the translation happens only once and won’t be translated back. Specifically, Value B wouldn’t ever be translated to Value A. You could also have a translation from Value A or Value C to Value B.

  

A translation set automatically changes from the default bi-directional option to uni-directional if you add translations for multiple values to the same value. This can only happen if you don’t have any other bi-directional links, however. To change a uni-directional set back to bi-directional, remove all translations with mappings to the same value.

By default, translation sets are case sensitive. However, if your data won’t be consistently cased, you can turn off case sensitivity. That way, you can manage translations with just one translation set, instead of having to create a new set for differing cases.

After you create and link a translation set, the translation(s) automatically apply to the linked subscription. The translation details are visible in the log details. Learn more about log operation details.

During implementation, you can build and test a translation set in a staging environment. Once you’re confident it works, you can promote it to production. When you promote, the value set is automatically promoted, too. Value sets can’t be promoted on their own.

Promoting an asset saves time and avoids introducing errors by having to rebuild it in a different environment. Learn more about asset promotion, then promote a translation set.

Every time you edit a translation set, you create a new version of the asset. If you run into errors or unexpected outcomes after editing, you can restore to a different version to help troubleshoot and find where any errors were introduced. Learn how to restore a translation set.