Skip Navigation Links | |
Exit Print View | |
Oracle Java CAPS HL7 Binding Component User's Guide Java CAPS Documentation |
Oracle HL7 Binding Component User's Guide
About the HL7 Binding Component
The Health Level 7 Messaging Standard
HL7 Binding Component as a Consumer
HL7 Binding Component as a Provider
HL7 Binding Component Features
Using the HL7 Binding Component Wizard
Accessing the HL7 Binding Component Wizard
To Access the Wizard by Creating a New File
To Access the Wizard by Creating a New Binding
To Access the Wizard by Creating a New WSDL Document
Configuring the HL7 Binding Component in the Wizard
To Configure the HL7 Binding Component in the Wizard
MLLP Version 2 Properties (Outbound Only)
HL7 Binding WSDL Extensibility Elements
Adding HL7 Extensibility Attributes From the WSDL Editor
To add Service Level HL7 Extensibility Attributes
Service Level HL7 Extensibility Elements
HL7 protocolproperties Element
HL7 communicationcontrols Element
Dynamically Configuring HL7 Endpoints
Dynamic Addressing Using Normalized Message Properties
Enabling Dynamic Endpoint Configuration
Using Normalized Message Properties in a BPEL Process
Using Predefined Normalized Message Properties in a BPEL Process
To Use Predefined Normalized Message Properties in a BPEL Process
General Normalized Message Properties
HL7 Binding Component Normalized Message Properties for Outbound Endpoints
HL7 Binding Component Normalized Message Properties for Inbound Endpoints
HL7 Binding Component Runtime Properties
Configuring the HL7 Binding Component Runtime Properties
To Edit HL7 Binding Component Runtime Properties
Defining an HL7 Binding Component Application Configuration
To Define the HL7 Application Configuration
Defining the Application Configuration Using Other Tools
Using Application Variables to Define Name/Value Pairs
Using Application Variables for Password Protection
Creating a Password Application Variable
Using HL7 Quality of Service (QoS) Features
Quality of Service (QoS) Properties
WSDL, or Web Service Description Language, is an XML-based language used to define web services. The HL7 WSDL extensibility elements are used to construct HL7 messages by specifying the message parts, message formats, and other message related information used to properly map an HL7 message exchange. The HL7 WSDL elements also contain information that the HL7 Binding Component uses to establish connections and sessions with HL7 external systems. Various properties that affect the delivery of HL7 messages are included within the HL7 WSDL extensibility elements.
WSDL files are created using the WSDL Wizard and validated within the NetBeans IDE. The extensibility elements correspond to the properties you specify in the wizard. They are described here so you can add and modify them in the WSDL file directly.
For more information on how to use the WSDL Wizard to create and HL7 WSDL file see Using the HL7 Binding Component Wizard.
HL7 extensibility elements are divided into two sets of configuration elements:
Service Level elements are used to configure the connectivity and protocol. The Service Level extensibility elements are:
Binding Level elements are used to binding abstract WSDL messages to HL7 messages. The Binding Level extensibility elements are:
The following sections describe the HL7 extensibility elements. The tables describe the attributes for each extensibility element and its child elements. For each attribute or element the table lists the name, description, whether the attribute or element applies to both provider or consumer (Common), whether it is required, and an example of its usage.
You can add HL7 extensibility elements from the wizard when you create the WSDL file. After the WSDL file is created, you can add extensibility attributes by entering the text directly or graphically in the WSDL Editor
A new node is added under the hl7wsdlPort node.
A new hl7:address element appears in the list.
For more information about these attributes, see HL7 address Element.
A new hl7:protocolproperties element appears in the list.
For more information about these attributes, see HL7 protocolproperties Element.
A new hl7:communcationcontrols element appears in the list.
A new hl7:communicationcontrol is added under the hl7:communicationcontrols node.
Configure the following attribute properties. For more information about these attributes, see HL7 communicationcontrols Element.
name: Specifies the attribute.
value: Specifies the value associated with that attribute.
enabled: Specifies if the attribute is enabled.
recourseAction: Specifies the recourse action associated with the attribute.
The recourse actions are:
Reset: Closes the connection with the HL7 external system and throws an alert.
Resend: Resends the last sent message to the HL7 external system.
Suspend: Closes the connection with the HL7 external system, suspends the endpoint from processing the messages, and throws an alert.
Skipmessage: Remains connected but writes the message to an error queue.
Error: Throws an Exception.
The following tables list and describe the Service Level HL7 extensibility elements:
The HL7 address extensibility element specifies the information for connectivity to the HL7 external system.
Table 3 HL7 address Element Attributes
|
The following example illustrates the use of the HL7 address element defined for a service port.
<service name="SomeService"> <port name="port1" binding="tns:someBinding"> <hl7:address location="hl7://localhost:4040" transportProtocolName="tcp-ip"/> </port> </service>
The HL7 protocolproperties extensibility element specifies the protocol specific information for connecting to the HL7 external system.
Table 4 HL7 protocolproperties Element Attributes
|
The following example illustrates the use of the HL7 protocolproperties element.
<hl7:protocolproperties acknowledgmentMode="original" llpType="MLLPv1" startBlockCharacter="11" endDataCharacter="28" endBlockCharacter="13" hllpChecksumEnabled="false" seqNumEnabled="false" processingID="P" versionID="2.3.1" validateMSH="false" sendingApplication="Java CAPS HL7 BC" sendingFacility="Java CAPS HL7 BC" enabledSFT="false" softwareVendorOrganization="Oracle Corporation" softwareCertifiedVersionOrReleaseNumber="6.3" softwareProductName="HL7 Binding Component" softwareBinaryID="6.3" softwareProductInformation="It is a binding component for HL7 over TCP/IP connection" journallingEnabled="false" mllpv2RetriesCountOnNak="0" mllpv2RetryInterval="0" mllpv2TimeToWaitForAckNak="0" encodingCharacters="^~&" softwareInstallDate="" fieldSeparator="124"/>
HL7 Communication controls and recourse actions together control the data transfer over a TCP/IP connection. The configuration of these elements is defined inside the HL7 communicationcontrol extensibility element. These attributes help to establish Quality of Service (QoS) between HL7 external systems and HL7 endpoints.
The HL7 communication control attributes can be added to an endpoint from the WSDL Editor or from the Communication Controls. The HL7 communicationcontrol attributes differ for inbound or outbound endpoints.
Table 5 HL7 communicationcontrol Element Attributes
|
The HL7 extensibility elements used to bind abstract WSDL messages to HL7 messages fall into three element types. Each type signifies how the binding occurs. At the binding level, the configuration applies to the entire port type. At the operation level, the configuration applies only to the operation. At the message level, the configuration applies to that particular message, whether it's input or output.
The HL7 binding extensibility element specifies a binding that is of interest to the HL7 Binding Component. It is essentially an empty element that serves as a marker, allowing the HL7 Binding Component to gather HL7 "binding" information described by the other HL7 extensibility elements. The HL7 binding extensibility element must be specified in the WSDL to define an HL7 protocol based binding.
The following example demonstrates how the HL7 binding extensibility element is used to associate a binding with a specific HL7 protocol.
<binding name="someBinding" type="tns:somePortType"> <hl7:binding/> </binding>
The HL7 operation extensibility element specifies an operation binding that is of interest to the HL7 Binding Component.
The following example demonstrates how the HL7 operation extensibility element is used to associate an abstract operation with an HL7 operation.
<binding name="someBinding" type="tns:somePortType"> <hl7:binding/> <operation name="someOperation"> </hl7:operation/> </binding>
The HL7 message element specifies the concrete properties associated with receiving or sending an HL7 message from or to the HL7 external system. To configure the attributes, right-click the message element and then select Properties.
Table 6 HL7 message Element Attributes
|
The following example demonstrates the HL7 message extensibility element defined for one-way operation.
<binding name="someBinding" type="tns:somePortType"> <hl7:binding/> <operation name="oneWayOp"> <hl7:operation/> <input> <hl7:message part="part1" use="encoded" encodingStyle="hl7encoder-1.0"/> </input> </operation> </binding>