ValidateHL7 Activity

The ValidateHL7 activity utilizes Foresight Instream to validate an Electronic Data Interchange (EDI) file against a specified guideline and provides summary and a detailed output containing the results.

Use the ValidateHL7 activity to validate HL7 input data and generate a result and a summary report.

Example

Refer to the associated example:

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.
CallBack No Optional. Select this check box to use a Java Class for callback .

For more information about Enabling Callbacks, see ValidateHL7 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 ValidateHL7 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
validator_profile string Optional. Contains configuration information for this activity.

Each time you validate, this file is read to determine what is to be checked and what is to be displayed on the screen or written to output files.

The value is the full path of the validator_profile file.

The $fsdeflt.apf file, which is installed in the Foresight Instream bin directory, is the default profile file for the validate operation. If the $fsdeflt.apf file is modified, the changes do not take effect until you stop and restart TIBCO Business Studio.

guideline_name string The name of the guideline used for the validation.

It must be in the TIBCO_FORESIGHT_HOME/Instream/Database directory. If you want to share guidelines with the TIBCO_FORESIGHT_HOME/Translator/Database directory, refer to the Share Guidelines and Maps section in this topic.

msg_content string The input data for validation.

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 in 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 result and the summary report are listed on the Output tab. For more information about output items, see TIBCO Foresight® Instream® Validation Technical Manual.

The following table lists the fields on the Output tab:

Output Item Datatype Description
Validation string Validation_result_in_flatfile - Specifies the message of the validation detail results in Flat File format.

Validation_summary_in_flatfile - Specifies the message of the validation summary results in Flat File format.

Validation_summary numeric Severity - Error severity summary record.

Type - Error type summary record, containing the following counts:

  • ignoreCount
  • infoCount
  • warningCount
  • errorCount
  • fatalCount
  • user1Count
  • user2Count
total_of_errors numeric Total number of errors.
return_code numeric Specifies the Foresight Instream return code.

For example, 100 means the validation ran successfully and 133 means the database directory cannot be opened.

Return codes are listed in the Foresight Instream documentation.

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 and Foresight Instream errors.

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