HIPAA 4010 Validation

The HIPAA 4010 Validation filter is used to check for validity of HIPAA messages.

The filter automatically generates a TA1 acknowledgment message with the option of including the 997 information. The filter includes the option to return the original HIPAA message, the acknowledgment, or both regardless of whether the validation fails or succeeds. It is also possible to return separate messages containing only valid transactions or invalid transactions contained in the original message. Additionally, users can return an XML document with full error information that can be viewed as an HTML file with a provided XSLT stylesheet.

Configuration Properties

Property	Description
Maximum Concurrency	The maximum level of concurrency for this filter. A setting of `0` (zero) means unlimited. Limiting the level of concurrency limits memory usage. Refer to Maximum Concurrency for details.
Version of Validation	Options: `Version 4010A`, `Version 4010`, `Custom`. Default: `Version 4010A` Identifies the version of HIPAA standard that valid messages conform to. If `Custom`, the definition specified in the Definition S3D (or PCF) File property will be used to validate messages.
Allowed Transactions	The list that specifies identifiers for the valid transactions. Any transactions that are not in the list will be considered invalid. This property only makes sense if the Version of Validation field is set to `Version 4010A` or `Version 4010`
Definition S3D (or PCF) File	An S3D or a PCF definition that is used to validate messages. This property is only available and also required if the Version of Validation field is set to `Custom`.
Validate	Options: `Entire Message`, `Envelope Only`. Default: `Envelope Only` Type of validation. If `Envelope Only` is selected, then the filter will validate just the interchange envelope of a HIPAA message, not the transactions contained in the message. Otherwise the whole message is validated.
Level of validation checking	Options: `Symphonia Engine Errors Only`, `Level 1-2`, `Level 1-3`, `Level 1-4`, `Level 1-5`. Default: `Level 1-4` Identifies the level of strictness for the HIPAA validation with `Symphonia Engine Errors Only` as the least strict level and `Level 1-5` as the strictest. For an explanation of validation levels, please consult the HIPAA specifications.
Return Type on Pass	This option specifies what message(s) comes out of the filter if the original message passes the validation process. The options are: `Original` - the input message. `Functional Acknowledgment (997)` - 997 acknowledgment produced as a result of the input message validation. `Interchange Acknowledgment (TA1)` - TA1 acknowledgment produced as a result of the validation of the input message's envelope. `XML` - XML report of validation of the input message. `Both Original and Functional Acknowledgment (997)` - both 1 and 2 as separate messages. `Valid Transactions, Invalid Transactions and Functional Acknowledgment (997)` - three separate messages come out of the filter, one containing only the valid transactions contained in the original message, another containing only the invalid transactions contained in the original message, and finally the 997 functional acknowledgment for the input message. Since the filter can return more than one message there needs to be a way to distinguish between the messages containing transactions and the acknowledgments. To this effect the filter sets the following properties on the output messages: `ACK` - Values: `True`, `False`. If `True`, the message is a functional acknowledgment. Otherwise it is a message that contains transactions of the input message. `VALID` - Values: `True`, `False`. If `True`, the message contains only valid transactions. If `False`, the message either contains only invalid transactions (if option 6 is used) or it is the original message (if option 5 is used).
On Validation Error	Options: `Continue Processing`, `Send to Error Node`. Default: `Send to Error Node`. This option specifies where to route the output message(s) if the validation of the input message fails. If `Send to Error Node` is set, then the output message(s) is sent to the error connector for the filter. Otherwise, the output message(s) is sent to the normal output of the filter.
Return Type on Fail	This option specifies what message(s) comes out of the filter if the original message fails the validation process. The options are: `Original` - the input message. `Functional Acknowledgment (997)` - 997 acknowledgment produced as a result of the input message validation. `Interchange Acknowledgment (TA1)` - TA1 acknowledgment produced as a result of the validation of the input message's envelope. `XML` - XML report of validation of the input message. `Both Original and Functional Acknowledgment (997)` - both 1 and 2 as separate messages. `Valid Transactions, Invalid Transactions and Functional Acknowledgment (997)` - three separate messages come out of the filter, one containing only the valid transactions contained in the original message, another containing only the invalid transactions contained in the original message, and finally the 997 functional acknowledgment for the input message. Since the filter can return more than one message there needs to be a way to distinguish between the messages containing transactions and the acknowledgments. To this effect the filter sets the following properties on the output messages: `ACK` - Values: `True`, `False`. If set to `True` then the message is a functional acknowledgment. Otherwise it is a message that contains transactions of the input message. `VALID` - Values: `True`, `False`. If set to `True` then the message contains only valid transactions. If set to False then the message either contains only invalid transactions (if option 6 is used) or it is the original message (if option 5 is used).
Number of Valid Transactions	Name of the property that holds the number of valid input transactions. The filter creates a property with this name on the output message(s) and assigns the number of valid transactions contained in the input message.
Number of Invalid Transactions	Name of the property that holds the number of invalid input transactions. The filter creates a property with this name on the output message(s) and assigns the number of invalid transactions contained in the input message. The information on the number of invalid transactions can be useful during re-batching; refer to the HIPAA 4010 Rebatcher for details.