HL7 Send Service
Description
The HL7 Send Service 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 #XDS-I Information Source Service to query the Patient Identifier Cross-reference Manager to find out the identification of a patient in different Patient Identifier Domains.
Dependencies
Attributes
#CharsetName
Charset of incoming and outgoing HL7 messages as specified by HL7 Server#CharsetName.
#SendingApplication
Sending Application in transmitted messages.
Default Value: DCM4CHEE
#SendingFacility
Sending Facility in transmitted messages.
Default Value: DCM4CHEE
#ForwardingRules
List of forwarding rules.
Syntax:
rules = rule+ | 'NONE' rule = [conditions] destination conditions = '[' condition {',' condition} ']' condition = attribute ['!'] '=' value {'|' value } value = string attribute = 'sending' | 'receiving' | 'msgtype' destination = application '^' facility application = string facility = string
Default Value: [sending=PACS_NODEXX^DCM4CHEE]PACS_CENTRAL^DCM4CHEE
#RetryIntervalls
Number and intervalls of retries of failed HL7 forward requests by a list of comma separated <number> x <interval> pairs. <interval> can be specified in seconds ({{ integer 's'}}), minutes ({{ integer 'm'}}), hours (integer 'h'
) or days (integer 'd'
).
Default Value: 5x1m,12x5m,24x1h,7x1d
#Concurrency
Maximal number of concurrent forwarded messages.
Default Value: 1
#ForwardTemplateDir
Directory where template file(s) are located to change the original HL7 message before forwarding it.
A stylesheet 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.
This directory can be <IPAddr>, %lt;hostname> or '<Sending Application>^<Sending Facility>' (In this order).
A relative path name is resolved relative to archive-install-directory/server/default/.
Default Value: conf/dcm4chee-hl7
#AcTimeout
Acknowledge timeout in ms. 0 = no timeout.
Default Value: 10000
#SoCloseDelay
Socket close delay in ms after receive of acknowledge message.
Default Value: 50
#AuditPIXQuery
Controls if Audit Records are emitted for invoked PIX Queries (HL7 QBP^Q23).
Default Value: true
#QueueName
Used internally - do NOT modify.
Default Value: HL7Send
#HL7ServerName
Used internally - do NOT modify.
Default Value: dcm4chee.archive:service=HL7Server
#TLSConfigName
Used internally - do NOT modify.
Default Value: dcm4chee.archive:service=TLSConfig
#JMSServiceName
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=JMS
#TemplatesServiceName
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=Templates
#Name
The class name of the MBean
#State
The status of the MBean
#StateString
The status of the MBean in text form
Operations
#create
Standard MBean lifecycle method
#start
The start lifecycle operation
#stop
The stop lifecycle operation
#destroy
The destroy lifecycle operation
#jbossInternalLifecycle
The detyped lifecycle operation (for internal use only)
#forward
Forward HL7 message according configured Forwarding Rules
#sendTo
Send HL7 message to specified destination
#sendHL7PatientXXX
Send/Forward HL7 message with message Type and Patient data
#sendHL7PatientMerge
Send/Forward HL7 Patient Merge message
#sendQBP_Q23
Send HL7 QBP^Q23 (=Query corresponding Patient ID) message.
#sendQBP_Q22
Send HL7 QBP^Q22 (=Query Patients, PDQ) message.
#showQBP_Q22
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.
#sendHl7FromDataset(dsFilename,xslFilename,sender,receiver)
Send HL7 message from a Dataset given in a file.
The XSL stylesheet given by filename is used to transform the dataset into a HL7 message.
#sendHl7FromDataset(ds,tpl,sender,receiver)
Send HL7 message from a Dataset to given reveiver.
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.