pynetdicom.dimse_primitives.N_EVENT_REPORT

class pynetdicom.dimse_primitives.N_EVENT_REPORT

Represents a N-EVENT-REPORT primitive.

Parameter	Req/ind	Rsp/conf
Message ID	M	-
Message ID Being Responded To	-	M
Affected SOP Class UID	M	U(=)
Affected SOP Instance UID	M	U(=)
Event Type ID	M	C(=)
Event Information	U	-
Event 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

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

EventTypeID

The type of event being reported, depends on the Service Class specification. Shall be included if Event Reply is included.

Type

int

EventInformation

Contains information the invoking DIMSE user is able to supply about the event. An encoded DICOM dataset containing additional Service Class specific information related to the operation.

Type

io.BytesIO

EventReply

Contains the optional reply to the event report. An encoded DICOM dataset containing additional Service Class specific information.

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

AffectedSOPClassUID	Return the Affected SOP Class UID as a UID.
AffectedSOPInstanceUID	Return the Affected SOP Instance UID as UID.
EventInformation	Return the Event Information as io.BytesIO.
EventReply	Return the Event Reply as io.BytesIO.
EventTypeID	Return the Event Type ID as int.
MessageID	Return the Message ID value as an int.
MessageIDBeingRespondedTo	Return the Message ID Being Responded To as an int.
REQUEST_KEYWORDS
RESPONSE_KEYWORDS
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.

property AffectedSOPClassUID

Return the Affected SOP Class UID as a UID.

property AffectedSOPInstanceUID

Return the Affected SOP Instance UID as UID.

property EventInformation

Return the Event Information as io.BytesIO.

property EventReply

Return the Event Reply as io.BytesIO.

property EventTypeID

Return the Event Type ID as int.

property MessageID

Return the Message ID value as an int.

property MessageIDBeingRespondedTo

Return the Message ID Being Responded To as an int.

property Status

Return the Status as an int.

property is_valid_request

Return True if the request is valid, False otherwise.

property is_valid_response

Return True if the response is valid, False otherwise.

property msg_type

Return the DIMSE message type as str.