JMX MBean View

MBean Name:	Domain Name:	dcm4chee.archive
	service:	HL7Service
	type:	ADT
MBean Java Class:	org.jboss.mx.modelmbean.XMBean

Back to Agent View

Refresh MBean View

MBean description:

ADT HL7 Service. Receives and processes incoming ADT messages, based on which messages are accepted as defined in the MessageTypes attribute. If a patient record does not exist in the database about the patient in the incoming ADT message, one is created.
Note that ADT^A10 messages do not affect the patient record, but instead checks if pending worklist items exist for this patient in the worklist managed by the archive, and if so, changes the status of worklist item to ARRIVED.

List of MBean attributes:

Name Type Access Value Description

MessageTypes java.lang.String RW Comma separated list of Message Types handled by this service.

PatientArrivingMessageType java.lang.String RW Message Type for Patient Arriving. Messages of this type will cause to change the status of Scheduled Procedure Steps for this patient in the modality worklist from SCHEDULED to ARRIVED
The message type must be also listed in configured MessageTypes handled by this service.

DeletePatientMessageType java.lang.String RW Message Type for deletion of a Patient record. Messages of this type will cause to delete a Patient, which all associated entities, in particular including his/her studies, from the system.
The message type must be also listed in configured MessageTypes handled by this service.

PatientMergeMessageTypes java.lang.String RW Comma separated list of message types for merge of two Patients. Messages of this type will cause to merge two Patients.
The message type must be also listed in configured MessageTypes handled by this service.

ChangePatientIdentifierListMessageType java.lang.String RW Message Type for change of the Patient Identifier List of one Patient.
The message type must be also listed in configured MessageTypes handled by this service.

PixUpdateNotificationMessageType java.lang.String RW Message Type for PIX Update Notification. Messages of this type and without (non-whitespace) Patient Name (PID-5) will be interpreted as PIX Update Notification according IHE Transaction ITI-10 specified in the IHE IT Infrastructure Technical Framework. IHE Transaction ITI-10 specifies ADT^A31 as message type for PIX Update Notification.
The message type must be also listed in configured MessageTypes handled by this service.

IssuersOfOnlyOtherPatientIDs java.lang.String RW Comma separated list of Issuers/Authorities, which only qualifies Other Patient IDs - and NOT primary Patient IDs. Patient IDs in PIX Update Notifications with such Issuer/Authority will NOT cause to create a new Patient Record, in the case that there is no Patient Record with such primary Patient ID

IgnoredIssuersOfPatientIDPattern java.lang.String RW A regular expression of Issuer patterns to ignore in PIX Update Notifications, or "NONE". Any Issuer of Patient ID that matches the pattern will be removed from the list of patient identifiers before the updates are applied to the database.

PatientMatching java.lang.String RW Defines which Patient Attributes in received HL7 ADT messages are considered for selecting existing Patient records in the archive.
Format: 'pid'['?']',issuer'['?'][',' ['['] demograhic-matches [']'] ]
demograhic-matches ::= demograhic-match['|' ...]
demograhic-match ::= [ignore',']demograhic-fields
ignore ::= 'ignore("' regular-expression '")'
demograhic-fields ::= demograhic-field['?'][',' ...]
demograhic-field ::= 'familyname'['(1)'] | 'givenname'['(1)'] | 'middlename'['(1)'] | 'nameprefix'['(1)'] | 'namesuffix'['(1)'] | birthdate | sex
Multiple alternative demograhic-matches can be specified using '|' as delimiter.
Substrings specified by 'ignore("' regular-expression '")' will be ignored for matching patient name components.
A '(1)' suffix of the attribute name specifies that only the first character need to match.
A question mark('?') after a field name specifies that a missing value in received HL7 ADT messages will match with any value for that field in existing Patient Records, as Patient Records with missing values for that field will match with any value for that field in received HL7 ADT messages. Field names without question marks specifies, that HL7 ADT messages without values for such fields will not match any existing Patient Record, and Patient Records without values for such fields will not get selected on receive of any HL7 ADT message.
Surrounding demograhic-match by brackets('[]') defines, that demographic fields shall *not* be considered for the selection of an existing Patient record, if the Patient ID is qualified by an Issuer/Authority in the HL7 ADT message *and* in the matching Patient Record.
Warning:Improper configuration may cause update/deletion of wrong patient or creation of doublets.
Furthermore, the consideration of demographic fields for the selection of existing Patient records disables the update of such Patient Demographics attributes by HL7 ADT messages!
Default: pid,issuer?

TemplateDir java.lang.String RW Directory where template file(s) are located.
A style sheet can be 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/.

PidStylesheet java.lang.String RW Stylesheet for HL7 PID to DICOM Patient Module mapping.
Base dir: TemplateDir
If this name contains a '/' or '\' the configured TemplateDir will be NOT applied! In this case the name is the full path of the stylesheet and a relative path name is resolved relative to archive-install-directory/server/default/.

MrgStylesheet java.lang.String RW Stylesheet for HL7 MRG to DICOM Patient Module mapping.
Base dir: TemplateDir
If this name contains a '/' or '\' the configured TemplateDir will be NOT applied! In this case the name is the full path of the stylesheet and a relative path name is resolved relative to archive-install-directory/server/default/.

IgnoreDeleteErrors boolean RW True False Ignore errors processing ADT^A23 messages (delete patient).

HandleEmptyMrgAsUpdate boolean RW True False Handle ADT messages with empty MGR segment as update.
This will allow processing of update/delete/arrived messages wich contains an irregular empty MRG segment. (Missing MRG-1: Prior Patient ID)

KeepPriorPatientAfterMerge boolean RW True False Keep prior patient after Patient Merge.
This will allow to get correct patient information even the received DICOM objects contains a patient id of an merged patient.
If disabled, the prior patient will be deleted.

ContentEditServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.

HL7ServerName 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 ADTService 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

Name	Type	Access	Value	Description
MessageTypes	java.lang.String	RW		Comma separated list of Message Types handled by this service.
PatientArrivingMessageType	java.lang.String	RW		Message Type for Patient Arriving. Messages of this type will cause to change the status of Scheduled Procedure Steps for this patient in the modality worklist from SCHEDULED to ARRIVED The message type must be also listed in configured MessageTypes handled by this service.
DeletePatientMessageType	java.lang.String	RW		Message Type for deletion of a Patient record. Messages of this type will cause to delete a Patient, which all associated entities, in particular including his/her studies, from the system. The message type must be also listed in configured MessageTypes handled by this service.
PatientMergeMessageTypes	java.lang.String	RW		Comma separated list of message types for merge of two Patients. Messages of this type will cause to merge two Patients. The message type must be also listed in configured MessageTypes handled by this service.
ChangePatientIdentifierListMessageType	java.lang.String	RW		Message Type for change of the Patient Identifier List of one Patient. The message type must be also listed in configured MessageTypes handled by this service.
PixUpdateNotificationMessageType	java.lang.String	RW		Message Type for PIX Update Notification. Messages of this type and without (non-whitespace) Patient Name (PID-5) will be interpreted as PIX Update Notification according IHE Transaction ITI-10 specified in the IHE IT Infrastructure Technical Framework. IHE Transaction ITI-10 specifies `ADT^A31` as message type for PIX Update Notification. The message type must be also listed in configured MessageTypes handled by this service.
IssuersOfOnlyOtherPatientIDs	java.lang.String	RW		Comma separated list of Issuers/Authorities, which only qualifies Other Patient IDs - and NOT primary Patient IDs. Patient IDs in PIX Update Notifications with such Issuer/Authority will NOT cause to create a new Patient Record, in the case that there is no Patient Record with such primary Patient ID
IgnoredIssuersOfPatientIDPattern	java.lang.String	RW		A regular expression of Issuer patterns to ignore in PIX Update Notifications, or "NONE". Any Issuer of Patient ID that matches the pattern will be removed from the list of patient identifiers before the updates are applied to the database.
PatientMatching	java.lang.String	RW		Defines which Patient Attributes in received HL7 ADT messages are considered for selecting existing Patient records in the archive. Format: 'pid'['?']',issuer'['?'][',' ['['] demograhic-matches [']'] ] demograhic-matches ::= demograhic-match['\|' ...] demograhic-match ::= [ignore',']demograhic-fields ignore ::= 'ignore("' regular-expression '")' demograhic-fields ::= demograhic-field['?'][',' ...] demograhic-field ::= 'familyname'['(1)'] \| 'givenname'['(1)'] \| 'middlename'['(1)'] \| 'nameprefix'['(1)'] \| 'namesuffix'['(1)'] \| birthdate \| sex Multiple alternative demograhic-matches can be specified using '\|' as delimiter. Substrings specified by 'ignore("' regular-expression '")' will be ignored for matching patient name components. A '(1)' suffix of the attribute name specifies that only the first character need to match. A question mark('?') after a field name specifies that a missing value in received HL7 ADT messages will match with any value for that field in existing Patient Records, as Patient Records with missing values for that field will match with any value for that field in received HL7 ADT messages. Field names without question marks specifies, that HL7 ADT messages without values for such fields will not match any existing Patient Record, and Patient Records without values for such fields will not get selected on receive of any HL7 ADT message. Surrounding demograhic-match by brackets('[]') defines, that demographic fields shall not be considered for the selection of an existing Patient record, if the Patient ID is qualified by an Issuer/Authority in the HL7 ADT message and in the matching Patient Record. Warning:Improper configuration may cause update/deletion of wrong patient or creation of doublets. Furthermore, the consideration of demographic fields for the selection of existing Patient records disables the update of such Patient Demographics attributes by HL7 ADT messages! Default: `pid,issuer?`
TemplateDir	java.lang.String	RW		Directory where template file(s) are located. A style sheet can be 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/.
PidStylesheet	java.lang.String	RW		Stylesheet for HL7 PID to DICOM Patient Module mapping. Base dir: `TemplateDir` If this name contains a '/' or '\' the configured `TemplateDir` will be NOT applied! In this case the name is the full path of the stylesheet and a relative path name is resolved relative to archive-install-directory/server/default/.
MrgStylesheet	java.lang.String	RW		Stylesheet for HL7 MRG to DICOM Patient Module mapping. Base dir: `TemplateDir` If this name contains a '/' or '\' the configured `TemplateDir` will be NOT applied! In this case the name is the full path of the stylesheet and a relative path name is resolved relative to archive-install-directory/server/default/.
IgnoreDeleteErrors	boolean	RW	True False	Ignore errors processing ADT^A23 messages (delete patient).
HandleEmptyMrgAsUpdate	boolean	RW	True False	Handle ADT messages with empty MGR segment as update. This will allow processing of update/delete/arrived messages wich contains an irregular empty MRG segment. (Missing MRG-1: Prior Patient ID)
KeepPriorPatientAfterMerge	boolean	RW	True False	Keep prior patient after Patient Merge. This will allow to get correct patient information even the received DICOM objects contains a patient id of an merged patient. If disabled, the prior patient will be deleted.
ContentEditServiceName	javax.management.ObjectName	RW	View MBean	Used internally. Do NOT modify.
HL7ServerName	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	ADTService	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