ADT Service

Owned by Former user (Deleted)
Last updated: Feb 02, 2011 by Franz WillerVersion comment
4 min read

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.

Dependencies

Attributes

#MessageTypes

Comma separated list of Message Types handled by this service.

Default Value: ADT^A01,ADT^A04,ADT^A05,ADT^A08,ADT^A10,ADT^A23,ADT^A28,ADT^A31,ADT^A34,ADT^A40,ADT^A47

#PatientArrivingMessageType

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.

Default Value: ADT^A10

#DeletePatientMessageType

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.

Default Value: ADT^A23

#PatientMergeMessageType

Message Type 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.

Default Value: ADT^A40

#ChangePatientIdentifierListMessageType

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.

Default Value: ADT^A47

#PixUpdateNotificationMessageType

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.

Default Value: ADT^A31

#IssuersOfOnlyOtherPatientIDs

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.

Default Value: SSN

#IgnoredIssuersOfPatientIDPattern

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.

Default Value: NONE

#PatientMatching

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 received HL7 ADT message and in the matching Patient Record.

(warning) Configuration of consideration of demographic fields for the selection of existing Patient records disables the update of such Patient Demographics attributes by HL7 ADT messages! => Only change the default value of pid,issuer?, if you know, what you are doing!

Default Value: pid,issuer?

#TemplateDir

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

Default Value: conf/dcm4chee-hl7

#PidStylesheet

Stylesheet for HL7 PID to DICOM Patient Module mapping.
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/.

Default Value: pid2dcm.xsl

#MrgStylesheet

Stylesheet for HL7 MRG to DICOM Patient Module mapping.
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/.

Default Value: mrg2dcm.xsl

#IgnoreDeleteErrors

Ignore errors processing ADT^A23 messages (delete patient).

Default Value: true

#HandleEmptyMrgAsUpdate

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

Default Value: false

#HL7ServerName

Used internally - do NOT modify.

Default Value: dcm4chee.archive:service=HL7Server

#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)

Notifications