pynetdicom._handlers.doc_handle_action

pynetdicom._handlers.doc_handle_action(event)[source][source]

Documentation for handlers bound to evt.EVT_N_ACTION.

Use of handlers for evt.EVT_N_ACTION is not yet supported.

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

Event

evt.EVT_N_ACTION

Supported Service Classes

Status

Parameters

event (events.Event) –

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

  • assoc : the association that is running the service that received the N-ACTION request.

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

  • description : a description of the event that occurred as str.

  • name : the name of the event that occurred as str.

  • request : the received N-ACTION request

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

Event properties are:

  • action_information : the decoded Dataset contained within the N-ACTION request’s Action Information parameter. Because pydicom uses a deferred read when decoding data, if the decode fails the returned Dataset will only raise an exception at the time of use.

Returns

  • status (pydicom.dataset.Dataset or int) – The status returned to the peer AE in the N-ACTION response. Must be a valid N-ACTION 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).

  • dataset (pydicom.dataset.Dataset or None) – If the status category is ‘Success’ or ‘Warning’ then a Dataset containing elements for the response’s Action Reply conformant to the specifications in the corresponding Service Class.

    If the status category is not ‘Success’ or ‘Warning’ then None.

Raises

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

See also

send_n_action() N_ACTION

References

DICOM Standard Part 4, Annexes H, J, P, S, CC and DD