TranslateHL7 Activity

The TranslateHL7 activity utilizes Foresight Translator to translate a file from one format to another format.

Use the Translate HL7 activity to specify a translation type and translation map to be used to translate input data from one format to another with no interim staging required.

Example

Refer to the associated example:

Translated Data Formats

Translation for the following data formats is supported by this activity:

From (Source) To (Target)
HL7 XML
HL7 HL7
HL7 Flat File
XML HL7
Flat File HL7

General

The following table lists the fields on the General tab:

Field Literal Value/Module Property/Process Property? Description
Name No The name to be displayed as the label for the activity in the process.
Operation Type No List of operation types.

Refer to the Translated Data Formats section.

CallBack No Optional. Select this check box to use a Java Class for callback.
Note: This function is not available for XML input.

For more information about Enabling Callback, see TranslateHL7 Callback.

Class Name No Specify a Java Class. This field is enabled when CallBack is selected.

To create a new Java class, click Create a new class icon.

To browse to an existing Java class and use the Type selection dialog box, click Browse a class icon.

For more information about Enabling Callbacks, see TranslateHL7 Callback.

Description

The Description tab is used to provide a short description for the activity.

Input

The following table lists the fields on the Input tab:

Field Datatype Description
map_filename string This field specifies the name and extension of a map file. ActiveMatrix BusinessWorks Plug-in for HL7 with FHIR supports map files with the .map and .xml file name extensions.

A map file specifies the source and target guidelines for each translation map. The source guideline describes the data before translation. The target guideline describes the data after translation.

Note: All involved XSD, STD, and MAP files must be in the TIBCO_FORESIGHT_HOME/Translator/Database directory. If you want to share guidelines with the TIBCO_FORESIGHT_HOME /Instream/Database directory, refer to the Share Guidelines and Maps section in this topic.
msg_content string The message content to be translated.
input encoding string Optional. The input encoding used for translation.

This is used when translating to ISO-8859-1 only. Valid values are blank (no encoding) or ISO-8859-1.

output encoding string Optional. The output encoding used for translation.

Valid values are blank (no encoding), UTF-8, UTF-16, or ISO-8859-1.

Share Guidelines and Maps

If you install Foresight Translator and Foresight Instream in different directories, you can share their Database directories by modifying the TIBCO_FORESIGHT_HOME/Instream/bin/$dir.ini or TIBCO_FORESIGHT_HOME/Translator/bin/$dir.ini file.

For example, if you want to use the TIBCO_FORESIGHT_HOME/Instream/Database directory as shared, perform the following steps:
  1. Open the TIBCO_FORESIGHT_HOME/Translator/bin/$dir.ini file.
  2. Modify the database path and point it to the TIBCO_FORESIGHT_HOME/Instream/Database directory.
    The following code is an example: 
    :* FORESIGHT Supplied .STD Standard Files
FSFACTORY ="C:\Foresight\Instream\Static"

:*User-defined .STD Standard Files
ALLUSERSSHARED ="C:\Foresight\Instream\Database"
    Note: The value must be enclosed with double quotation marks.
  3. After making the modification, you can put the involved XSD, STD, and MAP files either in the TIBCO_FORESIGHT_HOME/Translator/Database directory or in the TIBCO_FORESIGHT_HOME/Instream/Database directory.

Output

The Output tab contains the following fields:

Output Item Datatype Description
msg_content string The output of this activity is the translated message in the specified format, which can be the HL7, XML, or Flat File format.

The generated message format is specified in the Operation Type field on the Configuration tab.

return_code numeric Specifies the Foresight Translator return code.

For example, 100 means the transaction ran successfully, 158 means the map file cannot be opened, and so on.

Foresight Translator return codes are listed in the Foresight Translator documentation.

encoding string The encoding used for translation.

Fault

The Fault tab lists errors that might occur when you use this activity.

Error Schema Element Datatype Description
msg string Error message description.
msgCode string The error code. It represents ActiveMatrix BusinessWorks Plug-in for HL7 with FHIR and Foresight Translator errors.

For more information about error codes, see HL7 Error Codes.