pynetdicom.dimse_primitives.N_ACTION

class pynetdicom.dimse_primitives.N_ACTION

Represents a N-ACTION primitive.

Parameter Req/ind Rsp/conf
Message ID M -
Message ID Being Responded To - M
Requested SOP Class UID M -
Requested SOP Instance UID M -
Action Type ID M C(=)
Action Information U -
Affected SOP Class UID - U
Affected SOP Instance UID - U
Action Reply - C
Status - M
(=) - The value of the parameter is equal to the value of the parameter in the column to the left
C - The parameter is conditional.
M - Mandatory
MF - Mandatory with a fixed value
U - The use of this parameter is a DIMSE service user option
UF - User option with a fixed value
MessageID

Identifies the operation and is used to distinguish this operation from other notifications or operations that may be in progress. No two identical values for the Message ID shall be used for outstanding operations.

Type:int
MessageIDBeingRespondedTo

The Message ID of the operation request/indication to which this response/confirmation applies.

Type:int
RequestedSOPClassUID

The SOP Class for which the action is to be performed.

Type:pydicom.uid.UID, bytes or str
RequestedSOPInstanceUID

The SOP Instance for which the action is to be performed.

Type:pydicom.uid.UID, bytes or str
ActionTypeID

The type of action that is to be performed.

Type:int
ActionInformation

Extra information required to perform the action.

Type:io.BytesIO
AffectedSOPClassUID

For the request/indication this specifies the SOP Class for storage. If included in the response/confirmation, it shall be equal to the value in the request/indication

Type:pydicom.uid.UID, bytes or str
AffectedSOPInstanceUID

For the request/indication this specifies the SOP Instance for storage. If included in the response/confirmation, it shall be equal to the value in the request/indication

Type:pydicom.uid.UID, bytes or str
ActionReply

The reply to the action.

Type:io.BytesIO
Status

The error or success notification of the operation.

Type:int
__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__() Initialize self.

Attributes

ActionInformation Return the Action Information as io.BytesIO.
ActionReply Return the Action Reply as io.BytesIO.
ActionTypeID Return the Action Type ID as int.
AffectedSOPClassUID Return the Affected SOP Class UID as a UID.
AffectedSOPInstanceUID Return the Affected SOP Instance UID as UID.
MessageID Return the Message ID value as an int.
MessageIDBeingRespondedTo Return the Message ID Being Responded To as an int.
REQUEST_KEYWORDS
RESPONSE_KEYWORDS
RequestedSOPClassUID Return the Requested SOP Class UID as UID.
RequestedSOPInstanceUID Return the Requested SOP Instance UID as UID.
STATUS_OPTIONAL_KEYWORDS
Status Return the Status as an int.
is_valid_request Return True if the request is valid, False otherwise.
is_valid_response Return True if the response is valid, False otherwise.
msg_type Return the DIMSE message type as str.
ActionInformation

Return the Action Information as io.BytesIO.

ActionReply

Return the Action Reply as io.BytesIO.

ActionTypeID

Return the Action Type ID as int.

AffectedSOPClassUID

Return the Affected SOP Class UID as a UID.

AffectedSOPInstanceUID

Return the Affected SOP Instance UID as UID.

MessageID

Return the Message ID value as an int.

MessageIDBeingRespondedTo

Return the Message ID Being Responded To as an int.

RequestedSOPClassUID

Return the Requested SOP Class UID as UID.

RequestedSOPInstanceUID

Return the Requested SOP Instance UID as UID.

Status

Return the Status as an int.

is_valid_request

Return True if the request is valid, False otherwise.

is_valid_response

Return True if the response is valid, False otherwise.

msg_type

Return the DIMSE message type as str.