Export Studies on receive of HL7 messages - dcm4che/dcm4chee-arc-light GitHub Wiki

Overview

One can choose to export some or all studies of a patient on receive of HL7 messages for the same patient.

Configuration

Configure one or more DICOM Exporter for each destination.

Using Archive UI

Select the level on which the feature needs to be configured :
- To configure on Archive device level, go to Menu->Configuration, then on Devices page, Edit the dcm4chee-arc device. Go to Extensions and Edit extension of Device Extension. Again go to its Extensions and Edit extension of Archive device.
- To configure on Archive HL7 application extension level, go to Menu->Configuration, then on Devices page and
  Edit the dcm4chee-arc device. Go to Extensions and Edit extension of Device Extension. Go to Child Objects and select the HL7 application for which this feature needs to be configured. Go to Extensions and Edit extension of Archive HL7 Application.
In its Child Objects add HL7 Export Rule. Specify Name, Exporter ID, Suppress Duplicate Export Interval and Save.

Doing so will trigger export of studies for patients whenever any processed HL7 Message referencing this patient is received by archive.

Use Cases

Trigger export of studies only for specific HL7 message(s) conditions.

Add one or more Conditions and Save.

This ensures that studies of patient(s) referenced in processed HL7 Message(s) shall be exported only if conditions specified match with the information available in the incoming HL7 Message.

Trigger export only for some studies based on certain conditions pertaining to the study/patient

Add one or more Entity Selector and Save.

For eg. if you set value as priors=2&StudyAge=-5Y&ModalitiesInStudy=CT, it means select at most 2 prior Studies not older than 5 years containing at least one CT Series.

Always ignore the Issuer of Patient ID present in incoming HL7 message(s)

Select Ignore Assigning Authority of Patient ID as ALWAYS and Save.

This ensures that Issuer of Patient ID present in incoming HL7 message(s) will not be considered to check for studies (to be exported) of this patient in the archive's database.

Export studies of patient(s) only for a certain set of Matching or Non Matching Issuer of Patient ID(s)

Select Ignore Assigning Authority of Patient ID as MATCHING or NON_MATCHING. Add one or more Assigning Authority of Patient ID and Save.

This ensures that only the Matching or Non Matching Issuer of Patient ID(s) configured shall be matched with ones present in incoming HL7 message(s) and then for these patient(s) in archive's database studies will be exported.

Using LDAP

One may either create a LDIF file (e.g.):

To configure on Archive device level,

  version: 1
  dn: cn=Default HL7 Export Rule,dicomDeviceName=dcm4chee-arc,cn=Devices,cn=DICOM Configuration,dc=dcm4che,dc=org
  objectClass: hl7ExportRule
  cn: Default HL7 Export Rule
  dcmDuration: PT1H
  dcmExporterID: STORESCP
  dcmProperty: MSH-3=FORWARD
  dcmEntitySelector: priors=2&StudyAge=-5Y&ModalitiesInStudy=CT
  dcmNullifyIssuerOfPatientID: MATCHING
  dcmIssuerOfPatientID: CANCER-HOSPITAL-ISSUER&1.2.40.0.13.1.1.999.111.11113&ISO

To configure on Archive HL7 application level,

  version: 1
  dn: cn=Default HL7 Export Rule,hl7ApplicationName=DCM4CHEE|HL7APP,dicomDeviceName=dcm4chee-arc,cn=Devices,cn=DICOM Configuration,dc=dcm4che,dc=org
  objectClass: hl7ExportRule
  cn: Default HL7 Export Rule
  dcmDuration: PT1H
  dcmExporterID: STORESCP
  dcmProperty: MSH-3=FORWARD
  dcmEntitySelector: priors=2&StudyAge=-5Y&ModalitiesInStudy=CT
  dcmNullifyIssuerOfPatientID: MATCHING
  dcmIssuerOfPatientID: CANCER-HOSPITAL-ISSUER&1.2.40.0.13.1.1.999.111.11113&ISO

and import it to the LDAP Server by using the ldapmodify command line utility.

or directly use its New Entry... function to create corresponding HL7 Export Rule entries of Apache Directory Studio on Device Level (e.g.: dicomDeviceName=dcm4chee-arc) or on Archive HL7 Application Level (e.g: hl7ApplicationName=DCM4CHEE|HL7APP) of the Archive Configuration.

One may refer to HL7 Export Rule to understand the description of attributes.

Refer ISO-8601 Duration format for more know-how on Durations.

Go to the Control tab on Configuration page in archive UI and reload the configuration.

Testing

Required dcm4che Tools

hl7snd simulating the HL7 Sender (e.g. DSS/Order Filler), which sends the HL7 messages to archive.
storescu simulating the external object source (e.g. modality) STORESCU, from which objects are being received.
storescp simulating the external object destination (e.g. central archive) STORESCP, to which received objects are forwarded.

Verification

Start STORESCP tool.
```
   storescp -b <AET>:<port>
```

Send study to archive

   storescu -c DCM4CHEE@<hostname>:<port> /pathToStudy

Send HL7 message to the archive for the same patient.
```
   hl7snd -c <hostname>:<port>  /pathToHL7Msg
```
It can be seen in the storescp tool window that the studies of this patient have been exported to the STORESCP destination.