The X12 Validator filter is used to check the validity of HIPAA X12 messages. The validator will perform validation of the Envelope, Functional Group or both and output a TA1 or 999 acknowledgment depending on the configuration of the filter and the validity of the input message. The filter can be configured to output the original message, acknowledgments and reports, always or never, or when valid or invalid.
The report that is generated is an XML document, with a detailed validation breakdown, that when used in conjunction with an XSLT stylesheet can produce a stylized HTML file. Refer to Validation Report for a sample validation report.
Configuration Properties
Property |
Description |
---|---|
X12 Project | The X12 project to use for validation. By default, the Rhapsody Default X12 Project is selected. To select an X12 project:
To manage X12 projects, use the X12 Projects Manager. |
Transaction Sets |
The transaction sets to accept and validate. If no selection is made, then all known transaction sets are validated. |
Validate |
Whether you want to validate only the envelope, only the functional groups, or both:
|
Output Original |
When to output the original message.
|
Output Acknowledgment |
When to output a TA1 or 999 acknowledgment:
|
Output Report |
When to output a report:
|
Invalid Destination |
Whether the acknowledgments and originals for an invalid message should be sent through the normal connector or error connector:
Output for valid messages always goes through the normal connector. |
Generate Invalid 999 |
Whether an invalid 999 should be generated when the GS06 is invalid:
If the original GS06 is invalid, then it is not possible to generate a useful and valid 999. This option allows creating a slightly invalid 999 that contains the bad GS06 value. |
Invalid Control Fields |
Whether ISA05, ISA06, ISA07, ISA08, GS02 or GS03 are all copied from the original message into the acknowledgment:
When they contain characters not included in the basic and extended character set, this property determines how the values are copied across to these six fields in the acknowledgment. |
ISA Control Number Counter |
The name of the JavaScript counter to use to generate unique Interchange Control Numbers (ISA13). Interchange Control Numbers are required to be unique for long periods of time. The default value is |
GS Control Number Counter |
The name of the JavaScript counter to use to generate unique Group Control Numbers (GS06). Group Control Numbers are required to be unique for long periods of time. The default value is |
ST Control Number Counter |
The name of the JavaScript counter to use to generate unique Transaction Set Control Numbers (ST02). Leave blank to number the transaction sets from 0001 within each functional group. Transaction Set Control Numbers only have to be unique within the functional group. Only set a counter if the Transaction Set Control Numbers are to be unique for long periods of time across all functional groups and interchanges. |
Output Type Property |
The name of the property to write the output type into. The property will contain |
Valid Property |
The name of the property to write whether the message is valid or invalid. The property will contain either |
Acknowledged Property |
The name of the property to write whether the message has been acknowledged. The property will contain either |
Validation Report Version |
The version of the XML validation report to be generated:
The settings for Filtered Report XML Nodes are removed when Validation Report Version is set to Version 1. |
Filtered Report XML Nodes | Which XML nodes should not be printed in the report. Refer to XML Report Filtering for details on filtering the XML report. The Filtered Report XML Nodes property is only available when Validation Report Version is set to |
Validation Options | Enables you to configure validation options through the Validation Options dialog:
|
XML Report Filtering
The XML validation report generated by the filter can be filtered so selected XML elements are not generated.
To enable filtering:
- Ensure Validation Report Version is set to Version 2. Reports generated using version 2 and have the
formatVersion
attribute set to2
in thereport
element:<report formatVersion="2">
. Reports generated using version 1 do not contain theformatVersion
attribute in thereport
element:<report>
. - Set the Filtered Report XML Nodes configuration property with the values you want filtered. There are three types of values that you can enter:
- Element names - prevent any elements with the entered names from being written to the report. For example, to remove all instances of the element
<raw>
, enter the valueraw
. - Relative paths - prevent any elements that match the entered partial paths from being written to the report. For example, to remove all instances of the element
<raw>
that are a child of the element<segment>
, enter<segment>/raw
. - Absolute paths - prevent elements that match the entered exact paths from being written to the report. For example, entering
/report/raw
. removes all instances of the element<raw>
that is the child of the top-level element<report>
.
- Element names - prevent any elements with the entered names from being written to the report. For example, to remove all instances of the element
HIPAA X12 005010 Transactions
The following table lists the implementation standards used by the filter for HIPAA X12 005010 transactions:
Transaction | Implementation | Syntactic | Semantic |
---|---|---|---|
270 | x279A1 | ||
271 | x279A1 | ||
276 | x212 | ||
277 | x212 | ||
277 | x214 | ||
278_REQ | x217 | ||
278_RES | x217 | ||
820 | x218 | ||
834 | x220A1 | ||
835 | x221A1 | ||
837P | x222A1 | ||
837I | x223A2 | ||
837D | x224A2 | ||
997 | x230 | ||
999 | x231A1 |