Topics: |
This topic provides step-by-step instructions on how to configure a basic outbound 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 XML format to HIPAA format.
The outbound configuration that is described in this topic represents the simplest possible route and is not equivalent to the outbound configuration that is described in Working With HIPAA Inbound and Outbound Applications Using iWay Integration Tools (iIT). The outbound configuration in the quick start topic processes different HIPAA versions. The outbound 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.
For instructions, see Accessing the iWay Service Manager Administration Console.
How to: |
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 transaction set 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.
Tip: If you already added an Ebix to the Registry as described in Adding an Ebix to the Registry, you do not need to add it again for outbound processing. You can go directly to Defining an Inlet.
For example, HIPAA_5010X212_pipeline.ebx.
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.
How to: |
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.
To add a special register set to your channel:
The Channels pane opens.
The Assign register pane opens.
How to: |
You will add a listener to the Registry, then associate that listener with a new inlet.
Select File from the Type drop-down list and click Next.
The configuration parameters pane opens.
Parameter |
Value |
---|---|
Input Path * |
sreg(Hipaa_XML.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_XML.ValidationReport)\validation__sreg(basename)_*.xml This value is a special register that uses a defined directory in which output messages are received. Note: The double underscore characters are used in the destination to escape the underscore. Make sure that you have created this directory; otherwise, errors will occur during deployment. |
Removal Destination |
sreg(Hipaa_XML.Archive) This value is a special register that uses a defined directory to which output 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 |
xml Input files with the extension .xml are allowed. |
Suffix Out |
x12 In this example, the extension for output files is .x12. |
Parameter |
Value |
---|---|
Name * |
XmlToHipaa_Ebix |
Description |
XML to Hipaa file listener |
Parameter |
Value |
---|---|
Name * |
XmlToHipaa_Ebix |
Description |
The file inlet contains a file listener for XML to HIPAA processing. |
The next pane prompts you to select a listener.
The listener is added to the inlet.
How to: |
For this sample channel configuration, you will define a route that will invoke the XML to HIPAA validation process flow. The outcome of the validation process flow will place valid HIPAA data in a defined output folder. Invalid HIPAA data will be routed to an errors folder. A validation report will also be sent to the appropriate folder.
This section describes how to create a validation process flow using iIT Designer and bind it to a sample outbound channel as a route.
To create a new project and start the process flow using iIT Designer:
The Designer Project Information dialog box opens, prompting you for a project name and optional description.
In the Description field, type a brief description (optional) to describe the project.
The Designer Project Bindings dialog box opens.
The iWay Process Configuration dialog box opens.
In the Description field, type a brief description (optional).
You are ready to build the XMLToHipaa_Ebix 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.
%_^_XML_HIPAA.xch
XMLtoHIPAA_%_^.xch
The new Service object (XMLtoHipaaTransformAgent) 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.
The New File Object dialog box opens.
The File Type dialog box opens.
The new File object (Write To Error Dir) appears in the workspace.
The Line Configuration dialog box opens.
The End Name and Description dialog box opens.
The End Name Schema dialog box opens.
The Properties dialog box opens.
The new End_Fail object appears in the workspace.
The Line Configuration dialog box opens.
The New Service Object dialog box opens.
The Service Type dialog box opens.
The Properties dialog box opens.
The new Service object (XDHipaaValidationReportAgent) appears in the workspace.
The Line Configuration dialog box opens.
The New Test Object dialog box opens.
XPATH(/documents/ValidationReport/Report/Errors/error)
The new Decision Test object appears in the workspace.
The Line Configuration dialog box opens.
The New File Object dialog box opens.
The File Type dialog box opens.
XPATH(/documents/output)
sreg(Hipaa_XML.Output)
sreg(basename)_*.x12
The new File object (Write Good File) appears in the workspace.
The Line Configuration dialog box opens.
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.
The Line Configuration dialog box opens.
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 * |
XmltoHipaaEbix |
Description |
This route will invoke the XML to HIPAA validation process. The outcome of the validation process will place valid HIPAA data in your valid outbound folder. Invalid HIPAA will be routed to an errors folder. A validation report will also be sent to the 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.
How to: |
For the iWay Integration Solution for HIPAA, you will add an emitter to the Registry, then associate it with a new outlet.
To add an emitter that will emit an error validation report and error file due to the XML to HIPAA validation process:
The next pane prompts you for the emitter type.
sreg(Hipaa_XML.Error)\error__sreg(basename)_*.xml
Parameter |
Value |
---|---|
Name * |
XmltoHipaaEbix_XML_error |
Description |
XmltoHipaa Ebix_XML error |
To add an emitter that will emit a valid validation report due to the XML to HIPAA validation process:
The next pane prompts you for the emitter type.
sreg(Hipaa_XML.ValidationReport)\validation_sreg(basename)_*.xml
Parameter |
Value |
---|---|
Name * |
XmltoHipaaEbix_XML_validation |
Description |
XmltoHipaaEbix_XML validation report |
Now that you have added two emitters to the Registry, you are ready to define the required outlets. Each emitter will be associated with a corresponding outlet.
Parameter |
Value |
---|---|
Name * |
XmltoHipaaEbix_XML_error |
Description |
Outlet which will contain error validation report and error file due to the XML to HIPAA validation process. |
The next pane prompts you for the component type.
The next pane prompts you to select an emitter.
Parameter |
Value |
---|---|
Name * |
XmltoHipaaEbix_XML_validation |
Description |
Outlet which will contain valid validation report produced by the validation process. |
The next pane prompts you for the component type.
The next pane prompts you to select an emitter.
How to: |
Now that you have defined the required components for the outbound channel, you are ready to add the channel to the Registry and associate the conduits with it. At this time you will also add the route to the channel.
To define a channel:
You are prompted to associate components with the channel.
The inlet is associated with the channel. Now you need to associate a route with the channel and set it to the default.
The next pane prompts you for the component type.
On the next pane, you are prompted to select a route.
The Construct Channel pane reopens.
The Set Condition pane opens.
The following table lists the expression that must be entered for each outlet.
Outlet |
Expression |
---|---|
XmltoHipaaEbix_XML_ validation |
_isxml() and sreg(iwaf.validationSuccess) = true |
XmltoHipaaEbix_XML_ error |
_isxml() and sreg(iwaf.validationSuccess) != true |
For details on supported conditions, see the topic on using functions in the iWay Service Manager User's Guide.
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.
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 HIPAA 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 | |
Feedback |