11.10 Subscribe Transaction

11.10 Subscribe Transaction (Current)
Prev	11 Worklist Service and Resources	Next

This transaction creates a Subscription to a Worklist or Workitem resource. It corresponds to the UPS DIMSE N-ACTION operation "Subscribe to Receive UPS Event Reports".

Once a Subscription has been created the user agent will receive notifications containing Event Reports for events associated with the Subscription's resource. To receive the notifications generated by Subscriptions, the user agent must have first opened a Notification Connection between itself and the origin server using the Open Notification Connection transaction; see Section 8.10.4.

11.10.1 Request

The request shall have the following syntax:

POST SP /workitems/{resource}/subscribers/{aetitle}{?deletionlock}{&filter} SP version CRLF

*(header-field CRLF)

CRLF

The user agent shall conform to the SCU behavior specified in Section CC.2.3.2 “Service Class User Behavior” in PS3.4.

11.10.1.1 Target Resources

The origin server shall support the resources in Table 11.10.1-1.

Table 11.10.1-1. Subscribe Transaction Resources

Resource	URI Template
Worklist Subscription	/workitems/1.2.840.10008.5.1.4.34.5/subscribers/{aetitle}
Filtered Worklist Subscription	/workitems/1.2.840.10008.5.1.4.34.5.1/subscribers/{aetitle}
Workitem Subscription	/workitems/{workitem}/subscribers/{aetitle}

11.10.1.2 Query Parameters

The origin server shall support Query Parameters as required in Table 11.10.1-2.

The user agent shall supply in the request Query Parameters as required in Table 11.10.1-2.

Table 11.10.1-2. Query Parameters by Resource

Key	Value	Resource	Usage		Description
Key	Value	Resource	User Agent	Origin Server	Description
accept	media type	Worklist, Filtered Worklist, Workitem	O	M
charset	charset	Worklist, Filtered Worklist, Workitem	O	M
deletionlock	true/false	Worklist, Filtered Worklist, Workitem	O	M
filter	1#(attribute"=" value)	Filtered Worklist	C	M	Shall be present if the Target Resource is the Filtered Worklist.

The Deletion Lock Query Parameter has the following syntax:

deletionlock = "deletionlock=" true / false

If present with a value of true the Subscription will be created with a Deletion Lock (see Section CC.2.3.1 “Action Information” in PS3.4).

The Filter Query Parameter has the following syntax:

filter = 1#(attribute "=" value)

It is a comma-separated list of one or more matching keys (attribute/value pairs). A Workitem Subscription will be created for any existing and future Workitem that matches the attribute/value pairs of the filter. The valid Attributes for this Query Parameter are defined by the UPS IOD (see Section B.26.2 “IOD Modules” in PS3.3).

See Section 8.3.4.1 for the syntax of matching keys.

11.10.1.3 Request Header Fields

The request has no mandatory header fields. See Section 8.4.

11.10.1.4 Request Payload

The request has no payload.

Prev	Up	Next
11.9.3.3 Response Payload	Home	11.10.2 Behavior