Query/Retrieve Service Class¶

The Query/Retrieve Service Class defines a service that facilitates querying and retrieval of stored Instances.

Supported SOP Classes¶

UID	SOP Class
1.2.840.10008.5.1.4.1.2.1.1	PatientRootQueryRetrieveInformationModelFind
1.2.840.10008.5.1.4.1.2.2.1	StudyRootQueryRetrieveInformationModelFind
1.2.840.10008.5.1.4.1.2.3.1	PatientStudyOnlyQueryRetrieveInformationModelFind
1.2.840.10008.5.1.4.1.2.1.2	PatientRootQueryRetrieveInformationModelMove
1.2.840.10008.5.1.4.1.2.2.2	StudyRootQueryRetrieveInformationModelMove
1.2.840.10008.5.1.4.1.2.3.2	PatientStudyOnlyQueryRetrieveInformationModelMove
1.2.840.10008.5.1.4.1.2.4.2	CompositeInstanceRootRetrieveMove
1.2.840.10008.5.1.4.1.2.1.3	PatientRootQueryRetrieveInformationModelGet
1.2.840.10008.5.1.4.1.2.2.3	StudyRootQueryRetrieveInformationModelGet
1.2.840.10008.5.1.4.1.2.3.3	PatientStudyOnlyQueryRetrieveInformationModelGet
1.2.840.10008.5.1.4.1.2.5.3	CompositeInstanceRetrieveWithoutBulkDataGet
1.2.840.10008.5.1.4.1.2.4.3	CompositeInstanceRootRetrieveGet
1.2.840.10008.5.1.4.1.1.201.6	RepositoryQuery

DIMSE Services¶

DIMSE Service	Usage SCU/SCP
Patient Root Query Retrieve Information Model - Find
Study Root Query Retrieve Information Model - Find
Patient Study Only Query Retrieve Information Model - Find
C-FIND	Mandatory/Mandatory

DIMSE Service	Usage SCU/SCP
Patient Root Query Retrieve Information Model - Move
Study Root Query Retrieve Information Model - Move
Patient Study Only Query Retrieve Information Model - Move
Composite Instance Root Retrieve - Move
C-MOVE	Mandatory/Mandatory

DIMSE Service	Usage SCU/SCP
Patient Root Query Retrieve Information Model - Get
Study Root Query Retrieve Information Model - Get
Patient Study Only Query Retrieve Information Model - Get
Composite Instance Root Retrieve Without Bulk Data - Get
Composite Instance Root Retrieve - Get
C-GET	Mandatory/Mandatory

Statuses¶

C-FIND Statuses¶

Code (hex)	Category	Description
0x0000	Success	Success
0x0122	Failure	SOP Class not supported
0xFE00	Cancel	Processing has been terminated

Query/Retrieve (Find) Service Statuses¶

Code (hex)	Category	Description
0xA700	Failure	Out of resources
0xA710	Failure	Invalid prior record key
0xA900	Failure	Dataset does not match SOP Class
0xB001	Warning	Matching reached response limit, subsequent request may return additional matches
0xC000 to 0xCFFF	Failure	Unable to process
0xFF00	Pending	Matches are continuing
0xFF01	Pending	Matches are continuing; one or more Optional keys was not supported

pynetdicom Query/Retrieve (Find) Statuses¶

When pynetdicom is acting as a Query/Retrieve (Find) SCP it uses the following status codes values to indicate the corresponding issue has occurred to help aid in debugging.

Code (hex)	Category	Description
0xC001	Failure	Handler bound to `evt.EVT_C_FIND` yielded a status Dataset with no (0000,0900) Status element
0xC002	Failure	Handler bound to `evt.EVT_C_FIND` yielded an invalid status object (not a pydicom Dataset or an int)
0xC310	Failure	Failed to decode the dataset received from the peer
0xC311	Failure	Unhandled exception raised by the handler bound to `evt.EVT_C_FIND`
0xC312	Failure	Failed to encode the dataset received from the handler bound to `evt.EVT_C_FIND`

C-GET Statuses¶

Code (hex)	Category	Description
0x0000	Success	Success
0x0122	Failure	SOP Class not supported
0x0124	Failure	Not authorised
0x0210	Failure	Duplicate invocation
0x0212	Failure	Mistyped argument
0xFE00	Cancel	Sub-operations terminated

Query/Retrieve (Get) Service Statuses¶

Code (hex)	Category	Description
0xA701	Failure	Out of resources; unable to calculate number of matches
0xA702	Failure	Out of resources; unable to perform sub-operations
0xA900	Failure	Dataset does not match SOP Class
0xAA00	Failure	None of the frames requested were found in the SOP Instance
0xAA01	Failure	Unable to create new object for this SOP class
0xAA02	Failure	Unable to extract frames
0xAA03	Failure	Time-based request received for a non-time-based original SOP Instance
0xAA04	Failure	Invalid request
0xB000	Warning	Sub-operations complete, one or more or warnings
0xC000 to 0xCFFF	Failure	Unable to process
0xFF00	Pending	Sub-operations are continuing

pynetdicom Query/Retrieve (Get) Statuses¶

Code (hex)	Category	Description
0xC001	Failure	Handler bound to `evt.EVT_C_GET` yielded a status Dataset with no (0000,0900) Status element
0xC002	Failure	Handler bound to `evt.EVT_C_GET` yielded an invalid status object (not a pydicom Dataset or an int)
0xC410	Failure	Failed to decode the dataset received from the peer
0xC411	Failure	Unhandled exception raised by the handler bound to `evt.EVT_C_GET`
0xC413	Failure	The handler bound to `evt.EVT_C_GET` yielded an invalid number of sub-operations

C-MOVE Statuses¶

Code (hex)	Category	Description
0x0000	Success	Success
0x0122	Failure	SOP Class not supported
0x0124	Failure	Not authorised
0x0210	Failure	Duplicate invocation
0x0211	Failure	Unrecognised operation
0x0212	Failure	Mistyped argument
0xFE00	Cancel	Sub-operations terminated

Query/Retrieve (Move) Service Statuses¶

Code (hex)	Category	Description
0xA701	Failure	Out of resources; unable to calculate number of matches
0xA702	Failure	Out of resources; unable to perform sub-operations
0xA801	Failure	Move destination unknown
0xA900	Failure	Dataset does not match SOP Class
0xAA00	Failure	None of the frames requested were found in the SOP Instance
0xAA01	Failure	Unable to create new object for this SOP class
0xAA02	Failure	Unable to extract frames
0xAA03	Failure	Time-based request received for a non-time-based original SOP Instance
0xAA04	Failure	Invalid request
0xB000	Warning	Sub-operations complete, one or more or warnings
0xC000 to 0xCFFF	Failure	Unable to process
0xFF00	Pending	Sub-operations are continuing

pynetdicom Query/Retrieve (Move) Statuses¶

Code (hex)	Category	Description
0xC001	Failure	Handler bound to `evt.EVT_C_MOVE` yielded a status Dataset with no (0000,0900) Status element
0xC002	Failure	Handler bound to `evt.EVT_C_MOVE` yielded an invalid status object (not a pydicom Dataset or an int)
0xC510	Failure	Failed to decode the dataset received from the peer
0xC511	Failure	Unhandled exception raised by the handler bound to `evt.EVT_C_MOVE`
0xC513	Failure	The handler bound to `evt.EVT_C_MOVE` yielded an invalid number of sub-operations
0xC514	Failure	The handler bound to `evt.EVT_C_MOVE` failed to yield the (address, port) and/or the number of sub-operations
0xC515	Failure	The handler bound to `evt.EVT_C_MOVE` failed to yield a valid (address, port) pair