pynetdicom.service_class.BasicWorklistManagementServiceClass

class pynetdicom.service_class.BasicWorklistManagementServiceClass(assoc)

Implementation of the Basic Worklist Management Service Class.

__init__(assoc)

Create a new ServiceClass.

Methods

SCP(req, context) The SCP implementation for Basic Worklist Management.
__init__(assoc) Create a new ServiceClass.
is_cancelled(msg_id) Return True if a C-CANCEL message with msg_id has been received.
is_valid_status(status) Return True if status is valid for the service class.
validate_status(status, rsp) Validate status and set rsp.Status accordingly.

Attributes

BULK_DATA_KEYWORDS
ae Return the AE.
dimse Return the DIMSE service provider.
statuses
SCP(req, context)

The SCP implementation for Basic Worklist Management.

Parameters:

See also

association.Association.send_c_find()

Notes

C-FIND Request

Parameters

(M) Message ID
(M) Affected SOP Class UID
(M) Priority
(M) Identifier

Identifier

The C-FIND request Identifier shall contain:

  • Key Attributes values to be matched against the values of attributes specified in that SOP Class.
  • (0008,0005) Specific Character Set, if expanded or replacement character sets may be used in any of the Attributes in the request Identifier. It shall not be present otherwise.
  • (0008,0201) Timezone Offset From UTC, if any Attributes of time in the request Identifier are to be interpreted explicitly in the designated local time zone. It shall not be present otherwise.

C-FIND Response

Parameters

(U) Message ID
(M) Message ID Being Responded To
(U) Affected SOP Class UID
(C) Identifier
(M) Status

Identifier

The C-FIND response shall only include an Identifier when the Status is ‘Pending’. When sent, the Identifier shall contain:

  • Key Attributes with values corresponding to Key Attributes contained in the Identifier of the requeset.
  • (0008,0005) Specific Character Set, if expanded or replacement character sets may be used in any of the Attributes in the response Identifier. It shall not be present otherwise.
  • (0008,0201) Timezone Offset From UTC, if any Attributes of time in the response Identifier are to be interpreted explicitly in the designated local time zone. It shall not be present otherwise.

Status

Success
0x0000 Success
Pending
0xFF00 Matches are continuing, current match supplied
0xFF01 Matches are continuing, warning
Cancel
0xFE00 Cancel
Failure
0x0122 SOP class not supported
0xA700 Out of resources
0xA900 Dataset does not match SOP class
0xC000 to 0xCFFF Unable to process

References

ae

Return the AE.

dimse

Return the DIMSE service provider.

is_cancelled(msg_id)

Return True if a C-CANCEL message with msg_id has been received.

Parameters:msg_id (int) – The (0000,0120) Message ID Being Responded To value to use to match against.
Returns:True if a C-CANCEL message has been received with a Message ID Being Responded To corresponding to msg_id, False otherwise.
Return type:bool
is_valid_status(status)

Return True if status is valid for the service class.

Parameters:status (int) – The Status value to check for validity.
Returns:True if the status is valid, False otherwise.
Return type:bool
validate_status(status, rsp)

Validate status and set rsp.Status accordingly.

Parameters:
  • status (pydicom.dataset.Dataset or int) – A Dataset containing a Status element or an int.
  • rsp (dimse_primitive) – The response primitive to be sent to the peer.
Returns:

rsp – The response primitie to be sent to the peer (containing a valid Status parameter).

Return type:

dimse_primitive