PS-2020a / part18

DICOM PS3.18 2020a - Web Services​ Page 141​

Table 11.10.1-1. Subscribe Transaction Resources​

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. uery Parameters by Resource​

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 shall have no payload.​

11.10.2 Behavior​

The origin server shall create and manage a Subscription to the Target Resource for the user agent. The origin server shall conform​ to the SCP behavior specified in Section CC.2.3.3 “Service Class Provider Behavior” in PS3.4.​

- Standard -​

11.10.3 Response​

The response shall have the following syntax:​

version SP status-code SP reason-phrase CRLF

[Content-Type: media-type CRLF]

[(Content-Length: uint / Content-Encoding: encoding) CRLF]

[Content-Location: url CRLF]

*(header-field CRLF)

CRLF

[status-report]

11.10.3.1 Status Codes​

Table11.10.3-1showssomecommonstatuscodescorrespondingtothistransaction.SeealsoSection8.5foradditionalstatuscodes.​

Table 11.10.3-1. Status Code Meaning​

11.10.3.2 Response Header Fields​

The origin server shall support header fields as required in Table 11.10.3-2.​

Table 11.10.3-2. Response Header Fields​

If the Create Subscription request was accepted but the Deletion Lock was not, the response shall include the following Warning​ header field:​

Warning: 299 <service>: Deletion Lock not granted.

and may include a Status Report.​

If the request was rejected with a 403 status code because Filtered Worklist Subscription is not supported, the response shall include​ the following Warning header field:​

- Standard -​

Warning: 299 <service>: Filtered Worklist Subscriptions are not supported.

See also Section 8.4.​

11.10.3.3 Response Payload​

A success response payload may contain a Status Report.​

A failure response payload may contain a Status Report describing any failures, warnings, or other useful information.​

11.11 Unsubscribe Transaction​

This transaction is used to stop the origin server from sending new Event Reports to the user agent and may also stop the origin​ server from subscribing the user agent to new Workitems.​

11.11.1 Request​

The request shall have the following syntax:​

DELETE SP {/resource} SP version CRLF

*(header-field CRLF)

CRLF

11.11.1.1 Target Resources​

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

Table 11.11.1-1. Unsubscribe Transaction Resources​

11.11.1.2 Query Parameters​

The request has no Query Parameters.​

11.11.1.3 Request Header Fields​

The request has no Mandatory header fields.​

11.11.1.4 Request Payload​

The request payload shall be empty.​

11.11.2 Behavior​

Upon receipt of an Unsubscribe request, the origin server shall attempt to remove the Workitem Subscription, Worklist Subscription,​ orFilteredWorklistSubscriptionofthespecifiedApplicationEntitywithrespecttothespecifiedWorkitemUID,WorklistUID,orFiltered​ Worklist UID as described in Section CC.2.3.3 in PS3.4 and then return an appropriate response.​

ForaWorkitemresource,thiscorrespondstotheUPSDIMSEN-ACTIONoperation"UnsubscribefromReceivingUPSEventReports".​

For a Worklist or Filtered Worklist resource this transaction corresponds to the UPS DIMSE N-ACTION operation "Unsubscribe from​ Receiving UPS Event Reports" for the Global Subscription identified by the well-known UID.​

- Standard -​

11.11.3 Response​

The response shall have the following syntax:​

version SP status-code SP reason-phrase CRLF

[Content-Type: media-type CRLF]

[(Content-Length: uint / Content-Encoding: encoding) CRLF]

[Content-Location: url CRLF]

*(header-field CRLF)

CRLF

[status-report]

11.11.3.1 Status Codes​

Table11.11.3-1showssomecommonstatuscodescorrespondingtothistransaction.SeealsoSection8.5foradditionalstatuscodes.​

Table 11.11.3-1. Status Code Meaning​

11.11.3.2 Response Header Fields​

The origin server shall support header fields as required in Table 11.11.3-2.​

Table 11.11.3-2. Response Header Fields​

11.11.3.3 Response Payload​

A success response shall have no payload.​

A failure response payload may contain a Status Report describing any failures, warnings, or other useful information.​

- Standard -​

11.12 Suspend Global Subscription Transaction​

This transaction is used to stop the origin server from automatically subscribing the User-Agent to new Workitems. This does not​ delete any existing subscriptions to specific Workitems.​

11.12.1 Request​

The request shall have the following syntax:​

POST SP {/resource} SP version CRLF

*(header-field CRLF)

CRLF

11.12.1.1 Target Resources​

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

Table 11.12.1-1. Unsubscribe Transaction Resources​

11.12.1.2 Query Parameters​

The request has no Query Parameters.​

11.12.1.3 Request Header Fields​

The request has no Mandatory header fields.​

11.12.1.4 Request Payload​

The request payload shall be empty.​

11.12.2 Behavior​

UponreceiptofaSuspendrequest,theoriginservershallattempttoremovetheWorklistSubscription,orFilteredWorklistSubscription​ of the specified Application Entity with respect to the specified Worklist UID, or Filtered Worklist UID as described in Section CC.2.3.3​ in PS3.4 and then return an appropriate response.​

This transaction corresponds to the UPS DIMSE N-ACTION operation "Suspend Global Subscription"​

11.12.3 Response​

The response shall have the following syntax:​

version SP status-code SP reason-phrase CRLF

[Content-Type: media-type CRLF]

[(Content-Length: uint / Content-Encoding: encoding) CRLF]

[Content-Location: url CRLF]

*(header-field CRLF)

- Standard -​

CRLF

[status-report]

11.12.3.1 Status Codes​

Table11.12.3-1showssomecommonstatuscodescorrespondingtothistransaction.SeealsoSection8.5foradditionalstatuscodes.​

Table 11.12.3-1. Status Code Meaning​

11.12.3.2 Response Header Fields​

The origin server shall support header fields as required in Table 11.12.3-2.​

Table 11.12.3-2. Response Header Fields​

11.12.3.3 Response Payload​

A success response shall have no payload.​

A failure response payload may contain a Status Report describing any failures, warnings, or other useful information.​

11.13 Workitem Event Reports​

The origin server uses the Send Event Report Transaction (see Section 8.10.5) to send a Workitem Event Report, containing the​ details of any state change in the Workitem to the user agent.​

The origin server shall send Workitem Event Reports as described in Section CC.2.4.3 in PS3.4.​

The Event Report shall contain all mandatory Attributes described in Table CC.2.4-1 “Report a Change in UPS Status - Event Report​ Information” in PS3.4 and Table 10.3-2 “N-EVENT-REPORT-RSP Message Fields” in PS3.7 .​

The following is an example application/dicom+json Workitem Event Report payload:​

{

"00000002": {"vr": "UI", "Value": ["1.2.840.10008.5.1.4.34.6.4"] },

- Standard -​

"00000110": {"vr": "US", "Value": [23] },

"00001000": {"vr": "UI", "Value": ["1.2.840.10008.5.1.4.34.6.4.2.3.44.22231"] }, "00001002": {"vr": "US", "Value": [1] },

"00404041": {"vr": "US", "Value": ["READY"] }, "00741000": {"vr": "LT", "Value": ["SCHEDULED"] } } CRLF

- Standard -​

- Standard -​

12 Non-Patient Instance Service and​ Resources​

12.1 Overview​

The Non-Patient Instance (NPI) Storage Service enables a user agent to retrieve, store, and search an origin server for instances​ that are not related to a patient.​

An NPI Storage Service manages a collection of resources belonging to the categories specified in Table 12.1.1-1.​

All NPI Storage Service origin servers shall support the Retrieve Capabilities, Retrieve, and Search transactions. Support for the​ Store transaction is optional. All NPI Storage Service user agents support one or more of the Retrieve Capabilities, Retrieve, Store,​ or Search transactions.​

12.1.1 Resource Descriptions​

An NPI Service manages resources from the same NPI Category. Target URIs have the following templates:​

/{npi-name} /{npi-name}/{uid}

Where​

Table 12.1.1-1 contains the templates for the NPI Resource Categories.​

Table 12.1.1-1. Resource Categories, URI Templates and Descriptions​

The NPI SOP Classes are listed in Table GG.3-1 “Standard SOP Classes” in PS3.4.​

- Standard -​

12.1.2 Common Query Parameters​

The origin server shall support Query Parameters as required in Table 12.1.2-1.​

The user agent shall supply in the request Query Parameters as required in Table 12.1.2-1.​

Table 12.1.2-1. Common Query Parameters​

12.1.3 Common Media Types​

The origin server shall support the media types listed as Default or Required in Table 12.1.3-1 for all NPI transactions.​

Table 12.1.3-1. Default, Required, and Optional Media Types​

12.2 Conformance​

An origin server conforming to the NPI Service shall implement the Retrieve Capabilities Transaction (see Section 8.9.1).​

The origin server shall support the transactions listed as Required in Table 12.2-1.​

Table 12.2-1. Required and Optional Transactions​

ImplementationsshallspecifyintheirConformanceStatement(seePS3.2)andtheRetrieveCapabilitiesTransaction(seeSection8.9​

and Annex H):​

•​The implementations role: origin server, user agent, or both.​

•​The supported resources (IODs) for each role.​

In addition, for each supported transaction they shall specify:​

•​The supported Query Parameters, including optional Attributes, if any​

•​The supported DICOM Media Types​

•​The supported character sets (if other than UTF-8)​

- Standard -​