In this section: |
This topic provides step-by-step instructions on how to configure a basic inbound message flow for the iWay Integration Solution for HIPAA. This message flow represents the movement and tasks that are performed during the conversion of a message from HIPAA format to XML format and an acknowledgement of the message.
The inbound configuration that is described in this topic represents the simplest possible route and is not equivalent to the inbound configuration that is described in Working With SWIFT Inbound and Outbound Applications Using iWay Integration Tools (iIT). The inbound configuration in the quick start topic processes different HIPAA versions. The inbound configuration in this topic processes a single HIPAA version.
If you plan to modify the message flow that is described in this section and want more information on the supported iWay business components that you can use during the construction of a channel, see the iWay Service Manager User's Guide.
To access the iWay Service Manager Administration Console, you must first make sure that the iWay Service Manager service is running.
For instructions on starting iWay Service Manager, see the iWay Service Manager User's Guide.
or,
from a browser such as Microsoft Internet Explorer, enter the following URL,
http://host:port
where:
The following image shows the URL with the default values.
Note: The default user name and password is iway.
The iWay Service Manager Administration Console opens, as shown in the following image.
The iWay e-Business Information Exchange (Ebix) framework supplies several Ebix files for the iWay Integration Solution for HIPAA.
An Ebix file for HIPAA is named HIPAA_Version.ebx, where Version is the HIPAA version number. For example, the Ebix file for HIPAA version 4010A1 is named HIPAA_4010A1.ebx.
For details on the supported HIPAA versions and transaction sets, see Ebix-Supported Transaction Sets.
This topic describes how to add an Ebix to the Registry on Windows and UNIX.
The Ebix pane opens, as shown in the following image.
You are prompted for the name of the Ebix and an optional description.
On the Ebix pane, you will see that the Ebix was successfully added. Later you will associate it with the channel for inbound processing.
Note: This procedure must be repeated for each HIPAA message set that will be processed by this channel. For example, if HIPAA 997 messages are packaged in the HIPAA_5010_pipeline.ebx file and if your channel will be processing 997 messages, then this Ebix file must be added to the Registry.
Depending on your system configuration, there are two methods that you can use to add an Ebix to the Registry on UNIX.
In iWay Service Manager, a special register is a name-value pair that defines a variable that is carried throughout the system. Once defined, this variable is available to all components of the system. Within the HIPAA components, a best practice is to use special registers to define inputs and outputs. When packages containing channels are migrated between systems, the only changes required to deploy in the new location is to modify these special registers and build the channel. Channels may have many locations and this practice will minimize the effort required to migrate. For a complete list of system special registers that are provided, see the iWay Service Manager Programmer's Guide. For more information on defining a special register of your own, see the iWay Service Manager User's Guide.
The sample inbound channel uses a set of special registers defined as HIPAA. For example:
To add a special register set to your channel:
The Channels pane opens.
The Assign register pane opens.
An inlet defines how a message enters a channel. It typically contains a:
Select File from the Type drop-down list and click Next.
The configuration parameters pane opens.
Parameter |
Value |
---|---|
Input Path * |
sreg(Hipaa.Input) This value is a special register that uses a defined directory in which input messages are received. Make sure that you have created this directory; otherwise, errors will occur during deployment. |
Destination * |
sreg(Hipaa.GoodOutput) This value is a special register that uses a defined directory in which output files are stored after transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. |
Removal Destination |
sreg(Hipaa.Archive) This value is a special register that uses a defined directory to which input messages are moved if they fail during transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. It is recommended to configure a removal destination when you are constructing a basic channel. |
Suffix In |
* Input files with any file extension are allowed. |
Suffix Out |
xml The extension for output files is .xml. |
You are prompted for the name of the listener and an optional description.
The HipaaSplitterPreParser parses a HIPAA input file with one or more ISAs and multiple transaction sets (STs), and creates multiple XML output files. One XML output file is produced for each transaction set. You can also use the HipaaSplitterPreParser if there is only one transaction set in an ISA.
The Preparsers configuration parameters pane opens.
The following table lists and describes the available configuration parameters for the preparser:
Parameter |
Description |
---|---|
Template |
Used to locate the template in the Ebix used in the transformation from HIPAA format to XML format. |
Debug |
If enabled, the transformation components are written to files in the local directory. This parameter is set to False by default. |
Segment Terminator |
The control character that marks the end of a specific variable-length segment. To view a list of segment terminator characters, see Separators and Terminators. |
Element Delimiter |
The control character used to separate elements in a segment. It follows the segment identifier and each data element in a segment except the last. To view a list of element delimiter characters, see Separators and Terminators. |
Component Element Delimiter |
The control character used to separate sub-elements/components in a composite element. To view a list of component element delimiter characters, see Separators and Terminators. |
Escape Character |
The escape character is necessary if any of the HIPAA document separators is part of the actual value of an attribute. |
Timestamp |
Disabled by default, this option writes a timestamp to the log file. When enabled, the log file will display the start and end time of the file transformation and the input file name that is used. This feature is useful in development or debugging environments when processing batches of files. When the transaction log is not in use (for example, in a production mode) then this information is available in the Activity Log. Note: To use this feature, logging must be enabled in the Log Settings section of the iWay Service Manager Administration Console. |
XML Transformer |
Enabled by default, this parameter sets the HipaaSplitterPreParser to transform the individual documents that are split from the incoming message into XML format. Note: Use any of the following standalone EDI batch splitter preparsers if you do not require an XML transformation to be called:
|
Insert Group Loop |
Inserts a Group loop tag in the XML document. Group loop tags are displayed in activity logs and validation processing reports. Note: Ensure that this parameter is set to false. By default, this parameter is set to true. |
Node 'delimiters' |
If set to true, node delimiters are added to the generated XML document. For example: <?xml version="1.0" encoding="ISO-8859-1" ?> <HIPAA271> <delimiters> <_01_Element_Terminator>2A</_01_Element_Terminator> <_02_Segment_Terminator>0D0A</_02_Segment_Terminator> </delimiters> <ISA> By default, this parameter is set to false. |
%_^_HIPAA_XML.xch
HIPAA_%_^toXML.xch
For example, if the message type of the HIPAA input document is 835 and the version is 004010x091A1, then the constructed template name is:
835_004010X091A1_HIPAA_XML.xch
If the message type of the HIPAA input document is 276 and the version is 005010X212, then the constructed template name is:
HIPAA_276_005010X212toXML.xch
You are prompted for a name and optional description for the new preparser.
Now that you have added a File listener and splitter preparser to the Registry, you are ready to add and define an inlet. You will associate the previously created listener and preparser with the inlet.
Parameter |
Value |
---|---|
Name * |
HipaaToXML_Ebix |
Description |
The file inlet contains the file listener and edi splitter preparser for Hipaa to XML processing |
The next pane prompts you to select a listener.
The listener is associated with the inlet. Now you need to associate the preparser created earlier with the inlet.
The next pane prompts you for the component type.
On the next pane, you are prompted to select a preparser.
You have now successfully completed definition of the inlet.
For this sample channel configuration, you will define a route that will invoke the HIPAA to XML validation process flow. The outcome of the validation process flow will place valid transformed XML data in a defined output folder. Invalid transformed data will be routed to an errors folder. A HIPAA functional acknowledgement and a validation report will be sent to their designated output folder defined in the sample channel.
iWay Integration Tools (iIT) Designer (previously known as iWay Designer) is a GUI tool that is delivered as a plugin with iIT. For more information, see the iWay Integration Tools Designer User's Guide.
This section describes how to create a validation process flow using iIT Designer and bind it to a sample inbound channel as a route.
To create a new project and start the process flow using iIT Designer:
The New Process Flow Configuration Wizard opens, as shown in the following image.
In the Description field, type a brief description (optional).
The new HIPAAtoXML_pflow_AckRpt node appears under the Flows folder, and the workspace displays a Start and End object with a relation established in between.
You are ready to build the HIPAAtoXML_pflow_AckRpt validation process flow by configuring objects to it and specifying their relationships.
To configure objects for the process flow using iIT Designer:
The New Service Object dialog box opens.
The Service Type dialog box opens.
The Properties dialog box opens.
The new Service object (ValidationReport) appears in the workspace.
The Line Configuration dialog box opens.
This option indicates that there are no conditions that affect the path, and that the path between the two objects will always be followed.
A line appears between the objects to indicate that a relationship has been established.
The New File Object dialog box opens.
The File Type dialog box opens.
The Properties dialog box opens.
The new File object (Write To Rpt Dir) appears in the workspace.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
The End Name and Description dialog box opens.
The End Name Schema dialog box opens.
The Properties dialog box opens.
The new End_Rpt object appears in the workspace.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
The New Service Object dialog box opens.
The Service Type dialog box opens.
The Properties dialog box opens. The configuration parameters for HIPAAAckAgent are displayed. The following table lists and describes the configuration parameters.
Parameter |
Description |
---|---|
Protocol |
Protocol on which to make acknowledgment copies. Select one of the following options from the drop-down list:
|
Location |
Location for acknowledgment copies. |
End Tag |
The surrounding XML tag. |
Preemitter |
Determines whether the preemitter should be run on acknowledgment output. |
Error |
Determines whether to send an error. |
ISA Control Number |
Element location of ISA control number. Select one of the following locations from the drop-down list:
|
GS Control Number |
Element location of GS control number. Select one of the following locations from the drop-down list:
|
ST Control Number |
Element location of ST control number. Select one of the following locations from the drop-down list:
|
Stream Acknowledgment |
Determines the level of acknowledgment information to return. Select one of the following acknowledgment levels from the drop-down list:
|
Acknowledgment Type |
The functional acknowledgment message type to be returned (X12 997/HIPAA 999) after the incoming HIPAA document is validated. Select one of the following message types from the drop-down list:
Note: If the input document is HIPAA version 4010 version, then only a 997 functional acknowledgment message type is generated. |
The new Service object (HIPAAAckAgent) appears in the workspace.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
The New Set Object dialog box opens.
The Define Events dialog box opens.
The new Set object appears in the workspace.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
The End Name and Description dialog box opens.
The End Name Schema dialog box opens.
The Properties dialog box opens.
The new End_Success object appears in the workspace.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
The New Sync Object dialog box opens.
The Sync Expression Builder dialog box opens.
Default values are entered in this row.
The Timeout dialog box opens.
The new SynchAckStatus object appears in the workspace.
The Line Configuration dialog box opens.
This option indicates that there are no conditions that affect the path, and that the path between the two objects will always be followed.
A line appears between the objects to indicate that a relationship has been established.
The New Decision Switch Object dialog box opens.
The Switch Expression dialog box opens.
sreg(hipaa.ackstatus)
The Switch Cases dialog box opens.
Case |
Description |
---|---|
A |
HIPAA Good |
R |
HIPAA Reject |
E |
HIPAA Error |
P |
HIPAA Partial |
The new Decision Switch object appears in the workspace.
The Line Configuration dialog box opens.
This option indicates that there are no conditions that affect the path, and that the path between the two objects will always be followed.
A line appears between the objects to indicate that a relationship has been established.
The New File Object dialog box opens.
The File Type dialog box opens.
The Properties dialog box opens.
sreg(HIPAA.GoodOutput)
sreg(basename)_*.xml
The new File object (Good File) appears in the workspace.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
The New File Object dialog box opens.
The File Type dialog box opens.
The Properties dialog box opens.
sreg(HIPAA.BadOutput)
sreg(basename)_*.xml
The new File object (Bad File) appears in the workspace.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
The Line Configuration dialog box opens.
The Line Configuration dialog box opens.
A line appears between the objects to indicate that a relationship has been established.
The process flow is now complete.
Now you need to validate the process flow and publish it to the Registry of the iWay Service Manager Administration Console for use in the route of a channel for outbound processing.
Validating a process flow ensures that its structure is correct. Publishing a process flow makes it available in the Registry for use in a channel configuration. For instructions on validating and publishing the process flow, see the iWay Integration Tools Designer User's Guide.
Your next step is to add a new route to the Registry using the iWay Service Manager Administration Console and associate the process flow with it.
To define a route and associate the process flow with It:
Parameter |
Value |
---|---|
Name * |
HIPAAtoXML_Route |
Description |
This route will invoke the HIPAA to XML validation process. The outcome of this process will place valid HIPAA transformed data in your valid inbound folder. Invalid HIPAA transformed data will be routed to its appropriate folder. A validation report will also be generated and sent to its appropriate folder. |
You are prompted for the type of component to associate with the route.
The route, with its associated process flow, has been successfully defined.
An outlet defines how a message leaves a channel. An emitter is a transport protocol that sends a document to its recipient. In the sample configuration, we will use a File emitter. For details on supported protocols, see the iWay Service Manager Protocol Guide.
For the channel in this example, you will add three emitters to the Registry. Then you will define three outlets, associating one emitter with each outlet.
When you associate the outlets with the channel in later steps, you will apply a condition to each one to dynamically direct the flow of the output document based on its content.
In the example, you will add:
The configuration parameters pane opens.
Parameter |
Value |
---|---|
Destination * |
sreg(Hipaa.GoodOutput)/SREG(basename)_*.xml This value is the directory where the valid XML output is placed. sreg(Hipaa.GoodOutput) is a special register value that uses a defined directory in which valid output files are stored after transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. SREG(basename) is a special register reserved by iWay Service Manager, which uses a file name without an extension. For more information on how to configure a special register (SREG), see the iWay Service Manager User's Guide. On output, an asterisk (*) in the destination file name is replaced by a date and time stamp. Since you are using the HipaaSplitterPreParser, include an asterisk in the file name to create each XML output file with a unique name. |
Create Directory |
false |
Parameter |
Value |
---|---|
Name * |
HipaaFileOut |
Description |
Hipaa file output |
The configuration parameters pane opens.
Parameter |
Value |
---|---|
Destination * |
sreg(Hipaa.Ack)/SREG(basename)*.txt This value is the directory where the acknowledgement output is placed. You can use an extension other than .txt, for example, .edi or .data. sreg(Hipaa.Ack) is a special register value that uses a defined directory in which output files are stored after transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. On output, an asterisk (*) in the destination file name is replaced by a date and time stamp. For details on the special register (SREG) used in the preceding file name, see the iWay Service Manager User's Guide. |
Create Directory |
false |
Parameter |
Value |
---|---|
Name * |
HipaaAckOut |
Description |
Hipaa Acknowledgement Out |
The configuration parameters pane opens.
Parameter |
Value |
---|---|
Destination * |
sreg(Hipaa.BadOutput)/SREG(basename)_*.xml This value is the directory where the invalid XML output is placed. sreg(Hipaa.BadOutput) is a special register value that uses a defined directory in which invalid output files are stored after transformation. Make sure that you have created this directory; otherwise, errors will occur during deployment. SREG(basename) is a special register reserved by iWay Service Manager, which uses a file name without an extension. For more information on how to configure a special register (SREG), see the iWay Service Manager User's Guide. On output, an asterisk (*) in the destination file name is replaced by a date and time stamp. Since you are using the HipaaSplitterPreParser, include an asterisk in the file name to create each XML output file with a unique name. |
Create Directory |
false |
Parameter |
Value |
---|---|
Name * |
HipaaBadFileOut |
Description |
Hipaa Bad Output File |
Now that you have added the required emitters to the Registry, you are ready to add and define the outlets. You will associate the previously created emitters with the outlets (one emitter for each outlet).
Parameter |
Value |
---|---|
Name * |
HipaaAckOut |
Description |
Outlet containing Hipaa Acknowledgement to be sent to your trading partner |
The next pane prompts you for the component type.
The next pane prompts you to select an emitter.
The acknowledgement emitter is associated with the acknowledgement outlet.
Parameter |
Value |
---|---|
Name * |
HipaaBadFileOut |
Description |
Outlet containing converted Hipaa data that failed rules validation |
The next pane prompts you to select an emitter.
The invalid XML output emitter is associated with the invalid XML output outlet.
Parameter |
Value |
---|---|
Name * |
HipaaFileOut |
Description |
Outlet containing converted Hipaa data into XML format |
The next pane prompts you for the component type.
The next pane prompts you to select an emitter.
The valid XML output emitter is associated with the valid XML output outlet.
Now that you have defined the inlet, route, and outlets for the channel, you are ready to add the channel to the Registry and associate the conduits with it.
Parameter |
Value |
---|---|
Name * |
HipaaToXML_Ebix |
Description |
Processing channel - Hipaa inbound data to XML. Channel uses SREG (Special Registers) to define destination paths. Ebix files should be attached to this channel before deployment. |
You are prompted to associate components with the channel.
The inlet is added to the channel. Now you need to associate the route defined earlier with the channel.
The next pane prompts you for the component type.
On the next pane, you are prompted to select a route.
The Set Condition pane opens.
The following table lists the expression that must be entered for each outlet.
Outlet |
Expression |
---|---|
HipaaAckOut |
_isflat() |
HipaaBadFileOut |
_isXML() AND COND(SREG(edi.ackstatus),NE,'A') |
HipaaFileOut |
_isXML() AND COND(SREG(edi.ackstatus),EQ,'A') |
For details on supported conditions, see the topic on using functions in the iWay Service Manager User's Guide.
The results of the build are displayed on the right pane.
If an error or errors are displayed in the Message column, take the appropriate action as instructed.
Deployment is the mechanism by which a channel moves from being stored in the Registry to becoming active in iWay Service Manager. For more information on deployment, see the iWay Service Manager User's Guide.
The Channel Management pane reopens.
The red X under Status changes to a green check mark to indicate that the channel has been started. If an error or errors are displayed, take the appropriate action as instructed.
To make sure that the channel is working as expected, perform the following steps.
For more information on obtaining HIPAA sample files for testing purposes, see Extracting SWIFT User Samples.
Using the Archive Manager feature of iWay Service Manager, you can archive your channel configuration with its associated components and import them into another Registry. They will then be available from that Registry for modification or reuse.
For details on this feature, see the iWay Service Manager User's Guide.
iWay Software |