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.]]>
org.dcm4chex.archive.hl7.HL7SendService
The default constructor
HL7SendService
CharsetName
java.lang.String
Sending Application in transmitted messages.
SendingApplication
java.lang.String
Sending Facility in transmitted messages.
SendingFacility
java.lang.String
List of forwarding rules.
Format:=['['CONDITION[,..]']'](DESTINATION[,..]|NONE)
CONDITION:=(sending|receiving|msgtype)[!]=value['|'...]
DESTINATION:=APPLICATION^FACILITY
ForwardingRules
java.lang.String
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).
RetryIntervalls
java.lang.String
Maximal number of concurrent forwarded messages.
Concurrency
int
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.
This sub-directory can be <IPAddr>, <hostname> or '<Receiving Application>^<Receiving 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/.]]>
ForwardTemplateDir
java.lang.String
Acknowledge timeout in ms. 0 = no timeout.
AcTimeout
int
Socket close delay in ms after receive of acknowledge message.
SoCloseDelay
int
Controls if Audit Records are emitted for invoked PIX Queries (HL7
QBP^Q23).
AuditPIXQuery
boolean
Used internally - do NOT modify.
QueueName
java.lang.String
Used internally - do NOT modify.
HL7ServerName
javax.management.ObjectName
Used internally - do NOT modify.
TLSConfigName
javax.management.ObjectName
Used internally. Do NOT modify.
JMSServiceName
javax.management.ObjectName
Used internally. Do NOT modify.
TemplatesServiceName
javax.management.ObjectName
&defaultAttributes;
&defaultOperations;
Forward HL7 message according configured Forwarding Rules
forward
HL7 message as byte array
hl7msg
[B
int
Send HL7 message to specified destination and evaluate received ACK
sendTo
HL7 message as byte array
hl7msg
[B
Destination. Format: ReceivingApplication^ReceivingFacility
receiving
java.lang.String
void
Send/Forward HL7 message with message Type and Patient data
sendHL7PatientXXX
Patient data (Dataset)
patient
org.dcm4che.data.Dataset
Type of message (ADT^A02,ADT^A03,..)
msgType
java.lang.String
Sending. Format: SendingApplication^SendingFacility
sender
java.lang.String
Destination. Format: ReceivingApplication^ReceivingFacility
destination
java.lang.String
Select false if the message should be sent directly or true to send via forwarding rules.
useForward
boolean
void
Send/Forward HL7 Patient Merge message.
sendHL7PatientMerge
Dominant Patient data (Dataset)
dominant
org.dcm4che.data.Dataset
List of prior patients
priorPats
[Lorg.dcm4che.data.Dataset;
Sending. Format: SendingApplication^SendingFacility
sender
java.lang.String
Destination. Format: ReceivingApplication^ReceivingFacility
destination
java.lang.String
Enable/disable forwarding (using forward rules) instead of send direct (local)
useForward
boolean
void
Send HL7 QBP^Q23 (=Query corresponding Patient ID) message.
sendQBP_Q23
PIX Manager Application^Facility
PIXManager
java.lang.String
Message Query Name (QPD-1)
PIXQueryName
java.lang.String
Patient ID
pid
java.lang.String
authority
java.lang.String
List of returned domains (What domains returned).
domains
[Ljava.lang.String;
java.util.List
Send HL7 QBP^Q22 (=Query Patients, PDQ) message.
sendQBP_Q22
PDQ Manager Application^Facility
PDQManager
java.lang.String
Query Parameters
params
java.util.Map
Domain for Patient IDs returned
domain
java.lang.String
Maximum number of entries to return. Will cause the last list entry to be the next continuation code.
count
int
Continuation flag.
continuation
java.lang.String
java.util.List
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.
showQBP_Q22
PDQ Manager Application^Facility
PDQManager
java.lang.String
Query Parameters
query
java.lang.String
Domain for Patient IDs returned
domain
java.lang.String
java.lang.String
The XSL stylesheet given by filename is used to transform the dataset into a HL7 message.
]]>
sendHl7FromDataset
Filename of a Dataset file
dsFilename
java.lang.String
Filename of the XSLT stylesheet
xslFilename
java.lang.String
sender
java.lang.String
receiver
java.lang.String
boolean
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.
]]>
sendHl7FromDataset
Dataset
ds
org.dcm4che.data.Dataset
Templates object of an XSLT stylesheet
tpl
javax.xml.transform.Templates
sender
java.lang.String
receiver
java.lang.String
boolean