426 lines
16 KiB
XML
426 lines
16 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE mbean PUBLIC
|
|
"-//JBoss//DTD JBOSS XMBEAN 1.1//EN"
|
|
"http://www.jboss.org/j2ee/dtd/jboss_xmbean_1_1.dtd">
|
|
|
|
<mbean>
|
|
<description><![CDATA[The <b>HL7 Send Service</b> emits messages to HL7
|
|
receivers. It can be configured to forward messages received by the
|
|
[#HL7 Server] to other systems. It is also used by the <i>XDS-I Information
|
|
Source Service</i> to query the <i>Patient Identifier Cross-reference
|
|
Manager</i> to find out the identification of a patient in different Patient
|
|
Identifier Domains.]]>
|
|
</description>
|
|
<descriptors>
|
|
<persistence persistPolicy="OnUpdate"/>
|
|
<persistence-manager value="org.jboss.mx.persistence.DelegatingPersistenceManager" />
|
|
</descriptors>
|
|
|
|
<class>org.dcm4chex.archive.hl7.HL7SendService</class>
|
|
|
|
<constructor>
|
|
<description>The default constructor</description>
|
|
<name>HL7SendService</name>
|
|
</constructor>
|
|
|
|
<!-- Attributes -->
|
|
<attribute access="read-only" getMethod="getCharsetName">
|
|
<description><![CDATA[Charset of incoming and outgoing HL7 messages as
|
|
specified by the corresponding attribute of the associated HL7 Server
|
|
Service.]]>
|
|
</description>
|
|
<name>CharsetName</name>
|
|
<type>java.lang.String</type>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getSendingApplication"
|
|
setMethod="setSendingApplication">
|
|
<description>Sending Application in transmitted messages.
|
|
</description>
|
|
<name>SendingApplication</name>
|
|
<type>java.lang.String</type>
|
|
<descriptors>
|
|
<value value="ABPACS" />
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getSendingFacility"
|
|
setMethod="setSendingFacility">
|
|
<description>Sending Facility in transmitted messages.
|
|
</description>
|
|
<name>SendingFacility</name>
|
|
<type>java.lang.String</type>
|
|
<descriptors>
|
|
<value value="ABPACS" />
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getForwardingRules"
|
|
setMethod="setForwardingRules">
|
|
<description>List of forwarding rules.
|
|
Format:=['['CONDITION[,..]']'](DESTINATION[,..]|NONE)
|
|
CONDITION:=(sending|receiving|msgtype)[!]=value['|'...]
|
|
DESTINATION:=APPLICATION^FACILITY
|
|
</description>
|
|
<name>ForwardingRules</name>
|
|
<type>java.lang.String</type>
|
|
<descriptors>
|
|
<value value="[sending=PACS_NODEXX^ABPACS]PACS_CENTRAL^ABPACS" />
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getRetryIntervalls"
|
|
setMethod="setRetryIntervalls">
|
|
<description>Number and intervalls of retries of failed
|
|
HL7 forward requests by a list of comma separated NUMBERxINTERVAL pairs.
|
|
The intervall can be specified in seconds (##s), minutes (##m),
|
|
hours (##h) or days (##d).
|
|
</description>
|
|
<name>RetryIntervalls</name>
|
|
<type>java.lang.String</type>
|
|
<descriptors>
|
|
<value value="5x1m,12x5m,24x1h,7x1d" />
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getConcurrency"
|
|
setMethod="setConcurrency">
|
|
<description>Maximal number of concurrent forwarded messages.
|
|
</description>
|
|
<name>Concurrency</name>
|
|
<type>int</type>
|
|
<descriptors>
|
|
<value value="1" />
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getForwardTemplateDir"
|
|
setMethod="setForwardTemplateDir">
|
|
<description><![CDATA[Directory where template file(s) are located
|
|
to change the original HL7 message before forwarding it.<br />
|
|
A style sheet can be message type specific ("hl7forward_<MSG Type>^<Event Type>.xsl" or "hl7forward_<MSG Type>.xsl")
|
|
or generic "hl7forward.xsl"
|
|
and placed in this directory or in a sub-directory to select a style sheet according to the sender.<br />
|
|
This sub-directory can be <IPAddr>, <hostname> or '<Receiving Application>^<Receiving Facility>' (In this order).<br />
|
|
(See also UseHostSubdirs attribute in HL7Server service to enable IP/hostname selection)<br />
|
|
A relative path name is resolved relative to
|
|
<i>archive-install-directory</i>/server/default/.]]>
|
|
</description>
|
|
<name>ForwardTemplateDir</name>
|
|
<type>java.lang.String</type>
|
|
<descriptors>
|
|
<value value="conf/dcm4chee-hl7"/>
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getAcTimeout"
|
|
setMethod="setAcTimeout">
|
|
<description>Acknowledge timeout in ms. 0 = no timeout.
|
|
</description>
|
|
<name>AcTimeout</name>
|
|
<type>int</type>
|
|
<descriptors>
|
|
<value value="10000" />
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getSoCloseDelay"
|
|
setMethod="setSoCloseDelay">
|
|
<description>Socket close delay in ms after receive of acknowledge message.
|
|
</description>
|
|
<name>SoCloseDelay</name>
|
|
<type>int</type>
|
|
<descriptors>
|
|
<value value="50" />
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="isAuditPIXQuery"
|
|
setMethod="setAuditPIXQuery">
|
|
<description>
|
|
Controls if Audit Records are emitted for invoked PIX Queries (HL7
|
|
QBP^Q23).
|
|
</description>
|
|
<name>AuditPIXQuery</name>
|
|
<type>boolean</type>
|
|
<descriptors>
|
|
<value value="true" />
|
|
</descriptors>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getQueueName"
|
|
setMethod="setQueueName">
|
|
<description>Used internally - do NOT modify.
|
|
</description>
|
|
<name>QueueName</name>
|
|
<type>java.lang.String</type>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getHL7ServerName"
|
|
setMethod="setHL7ServerName">
|
|
<description>Used internally - do NOT modify.
|
|
</description>
|
|
<name>HL7ServerName</name>
|
|
<type>javax.management.ObjectName</type>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getTLSConfigName"
|
|
setMethod="setTLSConfigName">
|
|
<description>Used internally - do NOT modify.
|
|
</description>
|
|
<name>TLSConfigName</name>
|
|
<type>javax.management.ObjectName</type>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getJmsServiceName"
|
|
setMethod="setJmsServiceName">
|
|
<description>Used internally. Do NOT modify.
|
|
</description>
|
|
<name>JMSServiceName</name>
|
|
<type>javax.management.ObjectName</type>
|
|
</attribute>
|
|
<attribute access="read-write"
|
|
getMethod="getTemplatesServiceName"
|
|
setMethod="setTemplatesServiceName">
|
|
<description>Used internally. Do NOT modify.
|
|
</description>
|
|
<name>TemplatesServiceName</name>
|
|
<type>javax.management.ObjectName</type>
|
|
</attribute>
|
|
&defaultAttributes;
|
|
|
|
<!-- Operations -->
|
|
&defaultOperations;
|
|
<operation impact="ACTION">
|
|
<description>Forward HL7 message according configured Forwarding Rules</description>
|
|
<name>forward</name>
|
|
<parameter>
|
|
<description>HL7 message as byte array</description>
|
|
<name>hl7msg</name>
|
|
<type>[B</type>
|
|
</parameter>
|
|
<return-type>int</return-type>
|
|
</operation>
|
|
<operation impact="ACTION">
|
|
<description>Send HL7 message to specified destination and evaluate received ACK</description>
|
|
<name>sendTo</name>
|
|
<parameter>
|
|
<description>HL7 message as byte array</description>
|
|
<name>hl7msg</name>
|
|
<type>[B</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Destination. Format: ReceivingApplication^ReceivingFacility</description>
|
|
<name>receiving</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<return-type>void</return-type>
|
|
</operation>
|
|
<operation impact="ACTION">
|
|
<description>Send/Forward HL7 message with message Type and Patient data</description>
|
|
<name>sendHL7PatientXXX</name>
|
|
<parameter>
|
|
<description>Patient data (Dataset)</description>
|
|
<name>patient</name>
|
|
<type>org.dcm4che.data.Dataset</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Type of message (ADT^A02,ADT^A03,..)</description>
|
|
<name>msgType</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Sending. Format: SendingApplication^SendingFacility</description>
|
|
<name>sender</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Destination. Format: ReceivingApplication^ReceivingFacility</description>
|
|
<name>destination</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Select false if the message should be sent directly or true to send via forwarding rules.</description>
|
|
<name>useForward</name>
|
|
<type>boolean</type>
|
|
</parameter>
|
|
<return-type>void</return-type>
|
|
</operation>
|
|
<operation impact="ACTION">
|
|
<description>Send/Forward HL7 Patient Merge message.</description>
|
|
<name>sendHL7PatientMerge</name>
|
|
<parameter>
|
|
<description>Dominant Patient data (Dataset)</description>
|
|
<name>dominant</name>
|
|
<type>org.dcm4che.data.Dataset</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>List of prior patients</description>
|
|
<name>priorPats</name>
|
|
<type>[Lorg.dcm4che.data.Dataset;</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Sending. Format: SendingApplication^SendingFacility</description>
|
|
<name>sender</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Destination. Format: ReceivingApplication^ReceivingFacility</description>
|
|
<name>destination</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Enable/disable forwarding (using forward rules) instead of send direct (local)</description>
|
|
<name>useForward</name>
|
|
<type>boolean</type>
|
|
</parameter>
|
|
<return-type>void</return-type>
|
|
</operation>
|
|
<operation impact="ACTION">
|
|
<description>Send HL7 QBP^Q23 (=Query corresponding Patient ID) message.</description>
|
|
<name>sendQBP_Q23</name>
|
|
<parameter>
|
|
<description>PIX Manager Application^Facility</description>
|
|
<name>PIXManager</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Message Query Name (QPD-1)</description>
|
|
<name>PIXQueryName</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Patient ID</description>
|
|
<name>pid</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description><![CDATA[Assigning Authority:
|
|
<namespace ID>&<universal ID>&<universal ID type>]]>
|
|
</description>
|
|
<name>authority</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>List of returned domains (What domains returned).
|
|
</description>
|
|
<name>domains</name>
|
|
<type>[Ljava.lang.String;</type>
|
|
</parameter>
|
|
<return-type>java.util.List</return-type>
|
|
</operation>
|
|
|
|
<operation impact="ACTION">
|
|
<description>Send HL7 QBP^Q22 (=Query Patients, PDQ) message.</description>
|
|
<name>sendQBP_Q22</name>
|
|
<parameter>
|
|
<description>PDQ Manager Application^Facility</description>
|
|
<name>PDQManager</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Query Parameters</description>
|
|
<name>params</name>
|
|
<type>java.util.Map</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Domain for Patient IDs returned</description>
|
|
<name>domain</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Maximum number of entries to return. Will cause the last list entry to be the next continuation code.</description>
|
|
<name>count</name>
|
|
<type>int</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Continuation flag.</description>
|
|
<name>continuation</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<return-type>java.util.List</return-type>
|
|
</operation>
|
|
|
|
<operation impact="ACTION">
|
|
<description>Show HL7 QBP^Q22 (=Query Patients, PDQ) message response. Intended for test purposes
|
|
to ensure the service is working - use the sendQBP_Q22 method from code.</description>
|
|
<name>showQBP_Q22</name>
|
|
<parameter>
|
|
<description>PDQ Manager Application^Facility</description>
|
|
<name>PDQManager</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Query Parameters</description>
|
|
<name>query</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Domain for Patient IDs returned</description>
|
|
<name>domain</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<return-type>java.lang.String</return-type>
|
|
</operation>
|
|
|
|
<operation impact="ACTION">
|
|
<description><![CDATA[Send HL7 message from a Dataset given in a file.<br/>
|
|
The XSL stylesheet given by filename is used to transform the dataset into a HL7 message.
|
|
]]></description>
|
|
<name>sendHl7FromDataset</name>
|
|
<parameter>
|
|
<description>Filename of a Dataset file</description>
|
|
<name>dsFilename</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Filename of the XSLT stylesheet</description>
|
|
<name>xslFilename</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description><![CDATA[Sender in format: <SendingApplication>^<SendingFacility>]]></description>
|
|
<name>sender</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description><![CDATA[Receiver in format: <ReceivingApplication>^<ReceivingFacility>]]>
|
|
</description>
|
|
<name>receiver</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<return-type>boolean</return-type>
|
|
</operation>
|
|
<operation impact="ACTION">
|
|
<description><![CDATA[Send HL7 message from a Dataset to given reveiver.<br/>
|
|
The receiver (except LOCAL^LOCAL) must be configured in AE Managment!
|
|
The XSL stylesheet given as Templates object is used to transform the Dataset into a HL7 message.
|
|
]]></description>
|
|
<name>sendHl7FromDataset</name>
|
|
<parameter>
|
|
<description>Dataset</description>
|
|
<name>ds</name>
|
|
<type>org.dcm4che.data.Dataset</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description>Templates object of an XSLT stylesheet</description>
|
|
<name>tpl</name>
|
|
<type>javax.xml.transform.Templates</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description><![CDATA[Sender in format: <SendingApplication>^<SendingFacility>]]></description>
|
|
<name>sender</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<parameter>
|
|
<description><![CDATA[Receiver in format: <ReceivingApplication>^<ReceivingFacility>]]>
|
|
</description>
|
|
<name>receiver</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
<return-type>boolean</return-type>
|
|
</operation>
|
|
|
|
</mbean>
|
|
|