pynetdicom._handlers.doc_handle_delete

pynetdicom._handlers.doc_handle_delete(event: Event, *args: Sequence[Any]) → Union[int, Dataset]

Documentation for handlers bound to evt.EVT_N_DELETE.

User implementation of this event handler is required if one or more services that use N-DELETE are to be supported. If a handler is not implemented and bound to evt.EVT_N_DELETE then the N-DELETE request will be responded to using a Status value of 0x0110 - Processing failure.

Event

evt.EVT_N_DELETE

Supported Service Classes

• Print Management

• RT Machine Verification

Status

Success

0x0000 - Success

Failure

0x0110 - Processing failure

0x0112 - No such SOP Instance

0x0117 - Invalid object Instance

0x0118 - Not such SOP Class

0x0119 - Class-Instance conflict

0x0124 - Not authorised

0x0210 - Duplicate invocation

0x0211 - Unrecognised operation

0x0212 - Mistyped argument

0x0213 - Resource limitation

Parameters

• event (events.Event) –

  The event representing a service class receiving a N-DELETE request message. Event attributes are:

  • assoc: the Association that is running the service that received the N-DELETE request.

  • context: the presentation context the request was sent under as a PresentationContextTuple.

  • event: the event that occurred as InterventionEvent.

  • request: the received N-DELETE request

  • timestamp: the date and time that the N-DELETE request was processed by the service as datetime.datetime.

  Event properties are:

  • message_id: the N-DELETE request’s Message ID as int.

• args – If the handler was bound to the event using bind(event, handler, args) or by passing evt_handlers=[(event, handler, args), ...], where args is a list then there will be one or more optional extra parameters matching the contents of args.

Returns

status – The status returned to the peer AE in the N-DELETE response. Must be a valid N-DELETE status value for the applicable Service Class as either an int or a Dataset object containing (at a minimum) a (0000,0900) Status element. If returning a Dataset object then it may also contain optional elements related to the Status (as in DICOM Standard, Part 7, Annex C).

Return type

pydicom.dataset.Dataset or int

Raises

NotImplementedError – If the handler has not been implemented and bound to evt.EVT_N_DELETE by the user.

See also

send_n_delete(), N_DELETE, PrintManagementServiceClass, RTMachineVerificationServiceClass

References

• DICOM Standard, Part 4, Annex H

• DICOM Standard, Part 4, Annex DD

• DICOM Standard, Part 7, Sections 10.1.6, 10.3.6 and Annex C