ValidateHL7

The ValidateHL7 activity utilizes TIBCO Foresight® Instream® to validate an EDI file against a specified guideline and provides summary and a detail output containing the results.

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

Examples

Refer to the associated examples:

General

The General tab contains the following fields.

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 Select this checkbox to use a Java Class for callback (optional).

See ValidateHL7 Callback for more complete information on Enabling Callbacks.

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

Create a new Java Class.

Browse to an existing Java Class using the Type selection dialog.

See ValidateHL7 Callback for more complete information on Enabling Callbacks.

Description

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

Input

The Input tab contains the following fields.

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 TIBCO 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 below.
msg_content string The input data for validation.

Share Guidelines and Maps

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

The Output tab contains the following fields.

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 TIBCO Foresight® Instream® return code.

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

Return codes are listed in the TIBCO Foresight® Instream® documentation.

Fault

The Fault tab lists exceptions that are thrown by this activity.

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

See Error Codes for details.