DICOMFindMove node

The DICOMFindMove node is a Service Class User (SCU) for the Query and Retrieve service classes. The node has two closely related capabilities. The first capability is to query a remote Service Class Provider (SCP) for patients, studies, series, and images by using a DICOM C-FIND command. The search criteria are specified in an XML message that is propagated to the input terminal of the node. The result of the query is propagated to the output terminal of the node. The second capability of the DICOMFindMove node is to move the results of a query to an application entity by using a DICOM C-MOVE command. The destination of a move command can be a DICOMInput node that is configured in IBM® Integration Bus, a DICOM Picture Archiving Communications System (PACS), or any other DICOM SCP.

The DICOMFindMove node is contained in the Healthcare drawer of the message flow node palette, and is represented in the IBM Integration Toolkit by the following icon:

An example of how to use the DICOMFindMove node is shown in the Healthcare: Web service to DICOM built-in pattern in the Healthcare category in the Patterns Explorer view.

The query and move capabilities are combined in one node because they are closely related in DICOM. A move command is logically a find command followed by a copy of the results to a nominated destination. When the move operations complete, a results message is propagated to the output terminal of the DICOMFindMove node. The results message includes details of the success or failure of the move command. The results message contains a count of completed transfers, warnings, failures, error information, and a status field. If the status field contains any value other than zero, the move operation did not complete successfully.

Message schema

A single schema is used to describe all the DICOM XML messages that are sent and received by the DICOM nodes. However, only one of the complex types that are defined in the schema is used to structure each type of message. The FindMove complex type is used to define the messages that are received at the DICOMFindMove node input terminal and the Results complex type is used to define the messages that are sent from the DICOMFindMove node output terminal.

For more information about the schema, see DICOM message schema.

DICOM transactions

The DICOMFindMove node processing runs within the active transaction for the thread that is processing the DICOM image. If an error occurs, the DICOMFindMove node produces an error. Depending on the exception handling logic in the containing message flow, the error might cause the current transaction to be rolled back.

The DICOM standard defines two types of query that are known as roots. These roots, patient and study, are used by the DICOMFindMove node to identify and retrieve data.

For each root and level combination, the DICOMFindMove node defines the supported search attributes and a minimum set of attributes that the SCP should return. For information about the supported attributes, see Patient query root and Study query root.

The returned attributes are propagated by the node in the results messages from the output terminal. A query can return many results but these results are propagated as a single results message from the DICOMFindMove node. Vendors can support additional attributes to use as search criteria in the XML query message. The DICOMFindMove node allows these additional attributes to be configured in the XML query message, but they are not documented by the node (because they are vendor-specific). The DICOM standard requires that all the search attributes that are provided are also returned in responses. For information about the schema for the query and response messages, see, DICOM message schema.

<DICOM:FindMove xmins:DICOM="http://com.ibm.healthcare/DICOM">
  <QueryRoot>STUDY</QueryRoot>
  <QueryLevel>STUDY</Querylevel>
  <MoveDestination>BROKERAE</MoveDestination>
  <OperationPriority>NORMAL</OperationPriority>
  <Match>
    <Attribute Tag="PatientName">FEROVIX</Attribute>
    <Attribute Tag="AccessionNumber">1210490</Attribute>
  </Match>
  <Return>
  </Return>
</DICOM:FindMove>

<DICOM:Results xmins:DICOM="http://com.ibm.healthcare/DICOM">
  <DICOM>
    <Attribute Tag="00080005"VR="CS">ISO_IR 100</Attribute>
    <Attribute Tag="00080016"VR="UI">1.2.840.10008.5.1.4.1.1.2</Attribute>
    <Attribute Tag="00080018"VR="UI">1.3.12.2.1107.5.1.4.54203.30000004093016410718700003864</Attribute>
    <Attribute Tag="00080052"VR="CS">IMAGE</Attribute>
    <Attribute Tag="00080054"VR="AE">PACS</Attribute>
    <Attribute Tag="00080056"VR="CS">ONLINE</Attribute>
    <Attribute Tag="0020000D"VR="UI">1.3.12.2.1107.5.1.4.54203.30000004093013443132800000021</Attribute>
    <Attribute Tag="0020000E"VR="UI">1.3.12.2.1107.5.1.4.54203.30000004093016410718700003676</Attribute>
    <Attribute Tag="00200013"VR="IS">188</Attribute>
    <Attribute Tag="00880130"VR="SH"/>
    <Attribute Tag="00880140"VR="UI"/>
    <MoveResults>
      <Completed>1</Completed>
      <Failed>0</Failed>
      <Warnings>0</Warnings>
      <Status>0</Status>
      <ErrorID>0</ErrorID>
      <ErrorComment/>
    </MoveResults>
    </DICOM>
</DICOM:Results>

When you have added an instance of a DICOMFindMove node into a message flow, you can configure it.

All mandatory properties for which you must enter a value (properties that do not have a default value defined) are marked with an asterisk.

The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the broker archive (BAR) file to deploy it).