HL7 Module 7.1 | Understanding and Using HL7 Module | Installing and Using HL7 Module | Configuring webMethods HL7 Module | Generating Message Schemes | Custom Message Schemes for HL7 Message Types with anyHL7Segment or anyZSegment
 
Custom Message Schemes for HL7 Message Types with anyHL7Segment or anyZSegment
A number of HL7 message types contain references to anyHL7Segment and anyZSegment, the two placeholders defined in the hl7.org-supplied XML Schema to serve as indicators that you must provide a valid HL7 segment or Z segment in their place. The XML Schema for the HL7 message types with such references is included in HL7 Module. However, by default HL7 Module does not generate IS document types for these message types, because they are not enabled in the message.properties file. The messages.properties file is included with the XML Schema for every supported HL7 version under the Integration Server_directory \packages\WmHL7\data\xsd\wm.ip.hl7.docTypes\v<version_number\> directory and determines the default generation of HL7 messages. HL7 Module does not generate IS document types for HL7 message types not enabled in the messages.properties file.
To generate IS document types for HL7 message types with references to anyHL7Segment and anyZSegment, you must first customize the XML Schema definition for these message types by replacing the reference to anyHL7Segment or anyZSegment with a valid segment identifier for the respective HL7 version. After you customize the XML Schema of any of the message type definitions, you can uncomment the HL7 message type name or include it in the messages.properties file. The wm.ip.hl7.utils:generateMessageScheme service will then be able to generate the IS document types.
Note:
If you attempt to generate IS document types for HL7 message types with references to anyHL7Segment and anyZSegment without customizing the XML Schema, HL7 Module returns an error.
Following is an example for HL7 message version 2.3.1. The message.properties file includes the following definition:
## ====================================================================
## v2.3.1 Message types containing anyHL7Segment or anyZSegment,
## requires customization before usage
##
## MFN_M01=MFN_M01
## MFN_M03=MFN_M03
## MFR_M01=MFR_M01
This definition means that HL7 Module will not generate an IS document type for message types MFN_M01, MFN_M03, and MFR_M01 because they contain the placeholders anyHL7Segment or anyZSegment. To generate IS document types for these message types, you must edit the corresponding XML Schema definition for each message type. For example, for the MFN_M01 message type, you must edit the MFN_M01.xsd file and replace the occurrences of anyHL7Segment and/or anyZSegment with a valid segment identifier, defined in the segments.xsd file.
For the steps in customizing an XML Schema and generating a custom message scheme, see Creating a Custom Message Scheme.
The following table lists the HL7 Module message types that contain direct references to anyHL7Segment and anyZSegment:
HL7 Version
anyHL7Segment
anyZSegment
2.1
None.
None.
2.2
None.
MFN_M01, MFN_M02, MFN_M03, MFR_M01, MFR_M02, MFR_M03
2.3
MFN_M03
None.
2.3.1
MFN_M03
MFN_M01, MFR_M01
2.4
MFN_M03
MFN_M01, MFR_M01, QBP_Q13, QBP_Q15, QVR_Q17, RSP_K11
2.5
MFN_M01, MFN_M03, MFR_M01, PGL_PC6, PPG_PCG, PPP_PCB, PPT_PCL, PPV_PCA, PRR_PC5, PTR_PCF, QBP_Q15, QVR_Q17
None.
2.5.1
MFN_M01, MFN_M03, MFR_M01, PGL_PC6, PPG_PCG, PPP_PCB, PPT_PCL, PPV_PCA, PRR_PC5, PTR_PCF, QVR_Q17
None.
2.6
MFN_M01, MFN_M03, MFR_M01, PGL_PC6, PPG_PCG, PPP_PCB, PPT_PCL, PPV_PCA, PRR_PC5, PTR_PCF, QVR_Q17
None.
2.7
MFN_Znn, PGL_PC6, PPG_PCG, PPP_PCB, PPR_PC1, PPT_PCL, PPV_PCA, PRR_PC5, PTR_PCF, QBP_Q11, QBP_Q13, QBP_Q15, QVR_Q17, RSP_K11, RTB_Knn
None.