pynetdicom._handlers.doc_handle_n_get

pynetdicom._handlers.doc_handle_n_get(event: Event, *args: Sequence[Any]) → tuple[int | Dataset, Dataset | None]

Documentation for handlers bound to evt.EVT_N_GET.

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

Event

evt.EVT_N_GET

Supported Service Classes

• Procedure Step

• Print Management

• Media Creation Management

• Unified Procedure Step

• RT Machine Verification

• Display System Management

Status

Success

0x0000 - Success

Failure

0x0107 - Attribute list error

0x0110 - Processing failure

0x0112 - No such SOP Instance

0x0117 - Invalid object Instance

0x0118 - No such SOP Class

0x0119 - Class-Instance conflict

0x0124 - Not authorised

0x0210 - Duplicate invocation

0x0211 - Unrecognised operation

0x0212 - Mistyped argument

0x0213 - Resource limitation

0xC112 - Applicable Machine Verification Instance not found

0xC307 - Specified SOP Instance UID doesn’t exist or is not a UPS Instance managed by this SCP

Warning

0x0001 - Requested optional Attributes are not supported

0x0107 - Attribute list error

Parameters:

• event (events.Event) –

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

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

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

  • event: the event that occurred as InterventionEvent.

  • request: the received N-GET request

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

  Event properties are:

  • attribute_identifiers: a list of attribute BaseTag contained within the N-GET request’s Attribute Identifier List parameter.

  • message_id: the N-GET 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 (pydicom.dataset.Dataset or int) – The status returned to the peer AE in the N-GET response. Must be a valid N-GET 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 matching the request’s Attribute List conformant to the specifications in the corresponding Service Class.

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

See also

send_n_get(), N_GET, DisplaySystemManagementServiceClass, MediaCreationManagementServiceClass, PrintManagementServiceClass, ProcedureStepServiceClass, RTMachineVerificationServiceClass, UnifiedProcedureStepServiceClass

References

• DICOM Standard, Part 4, Annex F

• DICOM Standard, Part 4, Annex H

• DICOM Standard, Part 4, Annex S

• DICOM Standard, Part 4, Annex CC

• DICOM Standard, Part 4, Annex DD

• DICOM Standard, Part 4, Annex EE

• DICOM Standard, Part 7, Sections 10.1.2, 10.3.2 and Annex C