JBoss

JMX MBean View
Back to Agent View Refresh MBean View

MBean 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.

List of MBean attributes:

Name Type Access Value Description
CharsetName java.lang.String R ISO-8859-1 Charset of incoming and outgoing HL7 messages as specified by the corresponding attribute of the associated HL7 Server Service.
SendingApplication java.lang.String RW Sending Application in transmitted messages.
SendingFacility java.lang.String RW Sending Facility in transmitted messages.
ForwardingRules java.lang.String RW List of forwarding rules. Format:=['['CONDITION[,..]']'](DESTINATION[,..]|NONE) CONDITION:=(sending|receiving|msgtype)[!]=value['|'...] DESTINATION:=APPLICATION^FACILITY
RetryIntervalls java.lang.String RW 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).
Concurrency int RW Maximal number of concurrent forwarded messages.
ForwardTemplateDir java.lang.String RW Directory where template file(s) are located to change the original HL7 message before forwarding it.
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 '<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/.
AcTimeout int RW Acknowledge timeout in ms. 0 = no timeout.
SoCloseDelay int RW Socket close delay in ms after receive of acknowledge message.
AuditPIXQuery boolean RW True False Controls if Audit Records are emitted for invoked PIX Queries (HL7 QBP^Q23).
QueueName java.lang.String RW Used internally - do NOT modify.
HL7ServerName javax.management.ObjectName RW View MBean Used internally - do NOT modify.
TLSConfigName javax.management.ObjectName RW View MBean Used internally - do NOT modify.
JMSServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
TemplatesServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
Name java.lang.String R HL7SendService The class name of the MBean
State int R 3 The status of the MBean
StateString java.lang.String R Started The status of the MBean in text form

List of MBean operations:

void create()

Standard MBean lifecycle method

void start()

The start lifecycle operation

void stop()

The stop lifecycle operation

void destroy()

The destroy lifecycle operation

void jbossInternalLifecycle()

The detyped lifecycle operation (for internal use only)

Param ParamType ParamValue ParamDescription
method java.lang.String The lifecycle operation

int forward()

Forward HL7 message according configured Forwarding Rules

Param ParamType ParamValue ParamDescription
hl7msg [B HL7 message as byte array

void sendTo()

Send HL7 message to specified destination and evaluate received ACK

Param ParamType ParamValue ParamDescription
hl7msg [B HL7 message as byte array
receiving java.lang.String Destination. Format: ReceivingApplication^ReceivingFacility

void sendHL7PatientXXX()

Send/Forward HL7 message with message Type and Patient data

Param ParamType ParamValue ParamDescription
patient org.dcm4che.data.Dataset Patient data (Dataset)
msgType java.lang.String Type of message (ADT^A02,ADT^A03,..)
sender java.lang.String Sending. Format: SendingApplication^SendingFacility
destination java.lang.String Destination. Format: ReceivingApplication^ReceivingFacility
useForward boolean True False Select false if the message should be sent directly or true to send via forwarding rules.

void sendHL7PatientMerge()

Send/Forward HL7 Patient Merge message.

Param ParamType ParamValue ParamDescription
dominant org.dcm4che.data.Dataset Dominant Patient data (Dataset)
priorPats [Lorg.dcm4che.data.Dataset; List of prior patients
sender java.lang.String Sending. Format: SendingApplication^SendingFacility
destination java.lang.String Destination. Format: ReceivingApplication^ReceivingFacility
useForward boolean True False Enable/disable forwarding (using forward rules) instead of send direct (local)

java.util.List sendQBP_Q23()

Send HL7 QBP^Q23 (=Query corresponding Patient ID) message.

Param ParamType ParamValue ParamDescription
PIXManager java.lang.String PIX Manager Application^Facility
PIXQueryName java.lang.String Message Query Name (QPD-1)
pid java.lang.String Patient ID
authority java.lang.String Assigning Authority: <namespace ID>&<universal ID>&<universal ID type>
domains [Ljava.lang.String; List of returned domains (What domains returned).

java.util.List sendQBP_Q22()

Send HL7 QBP^Q22 (=Query Patients, PDQ) message.

Param ParamType ParamValue ParamDescription
PDQManager java.lang.String PDQ Manager Application^Facility
params java.util.Map Query Parameters
domain java.lang.String Domain for Patient IDs returned
count int Maximum number of entries to return. Will cause the last list entry to be the next continuation code.
continuation java.lang.String Continuation flag.

java.lang.String 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.

Param ParamType ParamValue ParamDescription
PDQManager java.lang.String PDQ Manager Application^Facility
query java.lang.String Query Parameters
domain java.lang.String Domain for Patient IDs returned

boolean sendHl7FromDataset()

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.

Param ParamType ParamValue ParamDescription
dsFilename java.lang.String Filename of a Dataset file
xslFilename java.lang.String Filename of the XSLT stylesheet
sender java.lang.String Sender in format: <SendingApplication>^<SendingFacility>
receiver java.lang.String Receiver in format: <ReceivingApplication>^<ReceivingFacility>

boolean sendHl7FromDataset()

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.

Param ParamType ParamValue ParamDescription
ds org.dcm4che.data.Dataset Dataset
tpl javax.xml.transform.Templates Templates object of an XSLT stylesheet
sender java.lang.String Sender in format: <SendingApplication>^<SendingFacility>
receiver java.lang.String Receiver in format: <ReceivingApplication>^<ReceivingFacility>