•  Understanding and Using HL7 Module
  •  About this help
    • Online Information and Support
    • Data Protection
    • Document Conventions
  •  Installing and Using HL7 Module
    •  Overview of webMethods HL7 Module
      •  What is HL7?
        •  HL7 Messaging Standards
          • HL7 Version 2.x Messaging Standard
          • HL7 Version 3.0 Messaging Standard
      • What is webMethods HL7 Module?
      • Architecture and Components
      • webMethods HL7 Module Packages
      •  Message Schemes and IS Document Types
        • Default Message Scheme
        • Custom Message Scheme
      •  HL7 Code Tables
        • Managing Standard and Customized Code Tables
        • Using Code Tables
      •  Processing HL7 Version 2.x Messages with Trading Networks
        • Processing Inbound HL7 Version 2.x Messages
        •  Processing Outbound HL7 Version 2.x Messages
          • Delivering Outbound HL7 Version 2.x Messages Using the HL7 Module Send Service
          • Submitting Outbound HL7 Version 2.x Messages to Trading Networks for Delivery
      •  webMethods HL7 Module MLLP Connections
        • Connection Types
        •  Connection Pools
          • Runtime Behavior of Connection Pools
    •  Installing webMethods HL7 Module
      • Overview
      • Requirements
      •  Installing webMethods HL7 Module 7.1 SP1
        • Before You Begin
        • Install webMethods HL7 Module 7.1 SP1
      • Uninstalling webMethods HL7 Module 7.1 SP1
    •  Steps to Set Up webMethods HL7 Module
      • Overview
      • Step 1: Configure the HL7 Module Database
      • Step 2: Create Trading Partner Profiles and Trading Partner Agreements
      • Step 3: Configure the Trading Networks Database
      • Step 4: Prepare to Send and Receive Messages
      • Step 5: View Document Transactions
    •  Configuring webMethods HL7 Module
      • Overview
      • Configuring the HL7 Module Database
      •  Generating Message Schemes
        •  Creating a Custom Message Scheme
          • Customizing the XML Schemes
          • Generating the Custom Message Scheme
        • Custom Message Schemes for HL7 Message Types with anyHL7Segment or anyZSegment
        • Associating a Trading Partner Agreement with a Message Scheme ID
        • Viewing the IS Document Types for HL7 Version 2.x Messages
        • Deleting the Message Schemes and IS Document Types for HL7 Version 2.x Messages
        • Generating HL7 Version 3 Document Types
      • Creating HL7 Clients
      •  Configuring Communication Protocols
        •  HTTP and HTTPS
          • Sending HL7 Messages Using Integration Server
          • Sending HL7 Version 2.x Messages Using Trading Networks
          • Receiving HL7 Version 2.x Messages via HTTP or HTTPS
        •  FTP
          • Sending HL7 Version 2.x Messages Using Integration Server
          • Sending HL7 Version 2.x Messages Using Trading Networks
          • Sending HL7 Version 2.x Messages Using a Third Party Application
          • Receiving HL7 Version 2.x Messages via FTP
        •  E-mail
          • Sending HL7 Version 2.x Messages Using Integration Server
          • Sending HL7 Version 2.x Messages Using Trading Networks
          • Sending HL7 Version 2.x Messages Using a Third Party Application
          • Receiving HL7 Version 2.x Messages via E-mail
        •  MLLP
          •  MLLP Connections
            • Before Configuring or Managing MLLP Connections
            • Configuring MLLP Connections
            • Enabling MLLP Connections
            • Disabling MLLP Connections
            • Viewing MLLP Connections
            • Editing MLLP Connections
            • Copying MLLP Connections
            • Deleting MLLP Connections
          • Sending HL7 Version 2.x Messages
          •  Receiving HL7 Version 2.x Messages
            • Configuring an MLLP Port
            • Viewing and Editing the MLLP Port Configuration
            • Managing the MLLP Listener
            • HL7 Module Support for Multiple MLLP Listeners
            • Receiving More Than One HL7 Version 2.x Message via a MLLP Listener
      •  Sending an Accept Acknowledgment
        • Original and Enhanced Acknowledgement Mode
        •  Synchronous and Asynchronous Mode of Sending Acknowledgments
          • Using the MLLP Transport To Send Acknowledgments
          • Using the HTTP Transport To Send Acknowledgments
        • Format of the Generated Acknowledgment Message
    •  Defining Trading Networks Information
      • Overview
      •  Defining Trading Networks Profiles
        •  Defining Your Enterprise Profile
          • Required Enterprise Profile Fields
          • Activating Your Enterprise Profile
        •  Defining Your Trading Partners' Profiles
          • Required Profile Fields
          • Activating Your Trading Partners' Profiles
      •  Defining HL7 Trading Partner Agreements
        • Using the Default TPA
        •  Creating a Partner-Specific TPA
          • Using the HL7 Module wm.ip.hl7.tn.tpa:createHL7TPA Service
          • Manually Creating a TPA
      • TN Document Types for HL7 Version 2.x Messages
      • Custom Trading Networks Attributes for HL7 Version 2.x Messages
      •  Processing Rules to Process HL7 Version 2.x Messages
        • Defining a Custom Processing Rule
    •  Processing HL7 Messages
      • Overview
      • Parsing Incoming HL7 Version 2.x Messages into IData Objects
      •  Creating Outgoing HL7 Version 2.x Messages
        • Example: HL7 ER7-Encoded Message
        • Example: HL7 XML-Encoded Message
      •  Validating HL7 Version 2.x Messages
        • Validating HL7 Version 2.x Messages without Trading Networks
        • Validating HL7 Version 2.x Messages with Trading Networks
        •  Code Table Validation Using Partner-Specific Code Tables
          • Format of the Sender Application and Receiver Application Fields
      • Retaining Empty Fields and Component Separators in HL7 Messages
    •  Viewing Information about HL7 Messages
      • Overview
      •  Viewing HL7 Version 2.x Messages
        •  Trading Networks Processing Status and HL7 Version 2.x Messages
          • Status Values When Sending HL7 Messages
          • Status Values When Receiving HL7 Messages
    •  Managing HL7 Code Tables
      • Overview
      • Before You Manage Code Tables
      •  Managing Standard Code Tables
        • Selecting the Default Trading Partner
        • Enabling Code Tables
        • Disabling Code Tables
        • Viewing Code Tables
        •  Editing Code Tables
          • Adding a Value
          • Deleting a Value
        • Adding a Code Table
        • Deleting a Code Table
      •  Managing Customized Code Tables
        •  Customizing for a Trading Partner
          • Enabling Customizing for a Trading Partner
          • Disabling Customizing for a Trading Partner
        •  Customizing Code Tables
          • Customizing a Partner Specific Code Table
          • Restoring a Customized Code Table to Default Values
          • Using Customized Tables
      • Uploading Code Table Values
      •  Formatting the Code Tables and the Code Table Values Files
        • Formatting the Code Tables File
        • Formatting the Code Table Values File
    •  Logging and Error Handling
      • Overview
      • Handling Validation Errors
      • HL7 Module Message Logging
      • HL7 Module Error Codes
    •  Using HL7 Module In a Clustered Environment
      • What is webMethods Integration Server Clustering?
      • Requirements for Each Integration Server in a Cluster
      • Considerations When Installing HL7 Module Packages
    •  webMethods HL7 Module Services
      • Overview
      •  WmHL7 Package
        • wm.ip.hl7.codetables
        • wm.ip.hl7.codetables:loadData
        • wm.ip.hl7.codetables:runScripts
        • wm.ip.hl7.service
        • wm.ip.hl7.service:convertHL7ToIData
        • wm.ip.hl7.service:convertIDataToHL7
        • wm.ip.hl7.service:generateACK
        • wm.ip.hl7.service:validate
        • wm.ip.hl7.tn
        • wm.ip.hl7.tn.service
        • wm.ip.hl7.tn.service:receive
        • wm.ip.hl7.tn.service:send
        • wm.ip.hl7.tn.tpa
        • wm.ip.hl7.tn.tpa.rec:HL7TPA
        • wm.ip.hl7.tn.tpa:createHL7TPA
        • wm.ip.hl7.tn.transport
        • wm.ip.hl7.tn.transport.rec:Listener
        • wm.ip.hl7.tn.transport.rec:ServerInfo
        • wm.ip.hl7.tn.transport:mllp
        • wm.ip.hl7.tn.transport:mllpListenerStatus
        • wm.ip.hl7.tn.utils
        • wm.ip.hl7.tn.utils:createBizDoc
        • wm.ip.hl7.utils
        • wm.ip.hl7.utils:deleteMessageScheme
        • wm.ip.hl7.utils:generateMessageScheme
      •  WmHL7DocTypes Package
        • wm.ip.hl7.docType
    •  Verifying The Message Header Segment of HL7 Messages
      • Required Fields in the Message Header Segment of HL7 Version 2.x Messages
      •  Extracting the Sender and the Receiver from the HL7 Message Header
        • Identifying a Trading Partner
        • Identifying the Sender and Receiver When Sending an HL7 Version 2.x Message
        • Identifying the Sender and Receiver When Receiving an HL7 Version 2.x Message
    •  Determining the Encoding of HL7 Messages
      • Determining the Encoding for wm.ip.hl7.tn.service:send
• Copyright

Understanding and Using HL7 Module

Copyright