Description
The HL7 Server receives all messages from the other HL7 services: Dispatch incoming HL7 messages to registered HL7 services. When configuring, select the TCP listening port, the security protocol for communication, timeouts, and the maximum number of connected HL7 senders.
Dependencies
Attributes
...
#CharsetName
Anchor | ||||
---|---|---|---|---|
|
Specifies Charset of incoming and outgoing HL7 messages by its name as listed in the IANA Charset Registry (e.g. ISO-8859-1
).
Default Value: ISO-8859-1
#Port
Anchor | ||||
---|---|---|---|---|
|
TCP listening port. This is the most important value in the service, and by default is set to 2575.
...
.
Default Value: 2575
#LocalAddress
Anchor | ||||
---|---|---|---|---|
|
Local interface IP address to listen for TCP communication. 0.0.0.0 indicates all active interfaces.
Default Value: 0.0.0.0
#ProtocolName
Anchor | ||||
---|---|---|---|---|
|
Enable Transport Security Layer (TLS) mode: mllp,
mllp
- plain Minimal Lower Level Protocol; no TLSmllp-tls
...
- - accept TLS connections; offer AES or DES encryption
mllp-tls.aes
...
- - accept TLS connections; force AES or DES encryption
mllp-tls.3des
...
- - accept TLS connections; force DES encryption
mllp-tls.nodes
...
- - accept TLS connections without encryption
Default Value: mllp
#SoTimeout
Anchor | ||||
---|---|---|---|---|
|
Socket timeout in ms. 0 = no timeout. This value determines how long the timeout is between messages. HL7 server is waiting for receiving the next message on an open connection before it closes the idle connection.
HL7 senders typically keeps the connection open , unlike DICOM, so the timeout value can be quite large, although it depends on the RIS system.
...
between emitted messages, and some interprets a close of the idle connection by the server as serious system failure. So the timeout may be set to a quite large value. Default: 600000 (=10min).
Default Value: 600000
#NoopMessageTypes
Anchor | ||||
---|---|---|---|---|
|
Comma separated list of Message Types which are accepted even if no HL7 Service is configured registered to actual process the message. By setting this value, you avoid receiving an "unsupported" message back.
...
to reject messages, which are not processed by the application.
Default Value: ADT^A02,ADT^A03,ADT^A06,ADT^A07,ADT^A12,ADT^A13
#SuppressErrorResponse
Anchor | ||||
---|---|---|---|---|
|
Activates suppression of Application Reject or Application Error as acknowledgment code but always returns acknowledgment code AA
(=Application Accept), even if the processing of the message fails.
Default Value: false
#SendNotification
Anchor | ||||
---|---|---|---|---|
|
Activates notification of registered listeners about received HL7 messages. Required for message forwarding by HL7 Send service.
...
#HL7 Send Service and for prefetch of studies on receive of ORM^O01 messages by the #Prefetch Service.
Default Value: true
#FileReceivedHL7
Anchor | ||||
---|---|---|---|---|
|
Activates writing received HL7 messages into file (format: hl7-######.hl7
, with ######
as the sequence number of the received message since last application start)) in log directory. All services use stylesheets to extract elements from HL7 messages. Activate this value if you want to use the message to construct a stylesheet.
...
Useful to analyse HL7 encoding errors in incoming messages, which causes the conversion of the message to XML for further processing to fail.
Default Value: false
#FileReceivedHL7OnError
Anchor | ||||
---|---|---|---|---|
|
Activates writing received HL7 messages, which were rejected or which processing failed, into file (format: hl7-######.hl7, with ###### as the sequence number of the received message since last application start) in directory specified by #ErrorLogDirectory.
Default Value: false
#ErrorLogDirectory
Anchor | ||||
---|---|---|---|---|
|
Directory to which HL7 messages which are rejected or which processing fails are filed. Only effective if #FileReceivedHL7OnError = true
.
A relative path name is resolved relative to archive-install-directory/server/default/
.
Default Value: log/hl7err
#FileReceivedHL7AsXML
Anchor | ||||
---|---|---|---|---|
|
Activates writing received and XMLized HL7 messages into file (format: hl7-######.xml
, with ######
as the sequence number of the received message since last application start) in log directory. All services use stylesheets to extract elements from HL7 messages. Activate this value if you want to use the message to construct a stylesheet.
...
Useful to test customized XSL stylesheets used by individual HL7 Services.
Default Value: false
#TcpNoDelay
Anchor | ||||
---|---|---|---|---|
|
Send packets as quickly as possible (Disable Nagle's algorithmn). This should increase performance on a Windows operating system.
Default Value: true
#SendBufferSize
Anchor | ||||
---|---|---|---|---|
|
Buffer size used for socket output. 0 = use platform default.
Default Value: 0
#ReceiveBufferSize
Anchor | ||||
---|---|---|---|---|
|
Buffer size used for socket input. 0 = use platform default.
Default Value: 0
#MaxClients
Anchor | ||||
---|---|---|---|---|
|
Maximal number of simultaneously connected HL7 clientssenders.
...
Default Value: 50
#NumClients
Anchor | ||||
---|---|---|---|---|
|
Current number of connected HL7 clientssenders.
...
#MaxIdleThreads
Anchor | ||||
---|---|---|---|---|
|
Maximal number of idle threads.
Default Value: 5
...
#NumIdleThread
Anchor | ||||
---|---|---|---|---|
|
Current number of idle threads.
...
#NumberOfReceivedMessages
Anchor | ||||
---|---|---|---|---|
|
Number of received HL7 messages since last restart of the application.
...
Used for naming of log files, if logging of incoming HL7 messages is activated by #FileReceivedHL7 or #FileReceivedHL7AsXML.
#AckStylesheet
Anchor |
---|
...
|
...
|
Stylesheet for generated ACK messages.
A relative path name is resolved relative to archive-install-directory/server/default/
.
Default Value: conf/dcm4chee-hl7/msh2ack.xsl
...
#LogStylesheet
Anchor |
---|
...
|
...
|
Stylesheet for logging of received HL7 messages.
...
A relative path name is resolved relative to archive-install-directory/server/default/
.
Default Value: conf/dcm4chee-hl7/logmsg.xsl
#PreprocessTemplateDir
Anchor | ||||
---|---|---|---|---|
|
Directory where template file(s) are located to preprocess the received HL7 message.
A stylesheet can be message type specific ("preprocess_<MSG Type>^<Event Type>.xsl" or "preprocess_<MSG Type>.xsl") or generic "preprocess.xsl" and placed in this directory or in a sub-directory to select a style sheet according to the sender.
This sub-directory can be <IPAddr>, <hostname> or '<Sending Application>^<Sending Facility>' (In this order).
(See also UseHostSubdirs attribute in HL7Server service to enable IP/hostname selection)
A relative path name is resolved relative to archive-install-directory/server/default/.
Default Value: conf/dcm4chee-hl7
#UseHostSubdirs
Anchor | ||||
---|---|---|---|---|
|
Enable selection of style sheets depending on IP address/hostname.
If disabled, only Sending Application and Sending Facility can be used to select style sheet depending on message sender but eliminates need of DNS lookup to get hostname.
Default Value: false
#TLSConfigName
Anchor | ||||
---|---|---|---|---|
|
Used internally - do NOT modify.
...
Default Value: dcm4chee.archive:service=TLSConfig
#AuditLoggerName
Anchor | ||||
---|---|---|---|---|
|
Used internally - do NOT modify.
...
Default Value: dcm4chee.archive:service=AuditLogger
#TemplatesServiceName
Anchor | ||||
---|---|---|---|---|
|
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=Templates
#Name
Anchor | ||||
---|---|---|---|---|
|
The class name of the MBean
...
#State
Anchor | ||||
---|---|---|---|---|
|
The status of the MBean
...
#StateString
Anchor | ||||
---|---|---|---|---|
|
The status of the MBean in text form
Operations
...
#create
Anchor | ||||
---|---|---|---|---|
|
Standard MBean lifecycle method
...
#start
Anchor | ||||
---|---|---|---|---|
|
The start lifecycle operation
...
#stop
Anchor | ||||
---|---|---|---|---|
|
The stop lifecycle operation
...
#destroy
Anchor | ||||
---|---|---|---|---|
|
The destroy lifecycle operation
...
#jbossInternalLifecycle
Anchor | ||||
---|---|---|---|---|
|
The detyped lifecycle operation (for internal use only)
...
Reload Stylesheets
...
Get precompiled stylesheet
...
#registerService
Anchor | ||||
---|---|---|---|---|
|
Register HL7 Service