| DICOM PS3.18 2016b - Web Services |
|---|
This DICOM Web Service defines a RESTful interface to the UPS SOP Classes (see PS3.3 and PS3.4). It consists of the following action types:
This action requests the creation of a UPS Instance on the Origin-Server. It corresponds to the UPS DIMSE N-CREATE operation.
This action sets the attributes of a UPS Instance managed by the Origin-Server. It corresponds to the UPS DIMSE N-SET operation.
This action searches for UPS Instances known to the Origin-Server. It corresponds to the UPS DIMSE C-FIND operation.
This action retrieves a UPS Instances. It corresponds to the UPS DIMSE N-GET operation.
This action sets the state of a UPS Instance managed by the Origin-Server. It corresponds to the UPS DIMSE N-ACTION operation "Change UPS State".
This action requests the cancellation of a UPS Instance managed by the Origin-Server. It corresponds to the UPS DIMSE N-ACTION operation "Request UPS Cancel".
This action subscribes to a UPS Instance or the Global Worklist managed by the Origin-Server. It corresponds to the UPS DIMSE N-ACTION operation "Subscribe to Receive UPS Event Reports".
This action suspends an existing subscription to the Global Worklist managed by the Origin-Server. It corresponds to the UPS DIMSE N-ACTION operation "Suspend Global Subscription".
This action cancels an existing subscription to a UPS Instance or the Global Worklist managed by the Origin-Server. It corresponds to the UPS DIMSE N-ACTION operation "Unsubscribe from Receiving UPS Event Reports".
This action initiates a WebSocket connection to allow the User-Agent to start receiving Event Report messages.
This action sends an Event Report using an open WebSocket connection. It corresponds to the UPS DIMSE N-EVENT-REPORT operation.
An Origin-Server shall support all of the above action types.
The requirements for a UPS-RS Origin-Server that is also a Unified Worklist and Procedure Step SCP are described in Section CC.1 in PS3.4
Table 6.9-1. UPS Interface Mapping
The Origin-Server shall comply with all requirements placed on the SCP for the corresponding services in Annex CC “Unified Procedure Step Service and SOP Classes (Normative)” in PS3.4.
This resource allows a User-Agent to instruct an Origin-Server to create a UPS instance.
The request message shall be formed as follows:
Content-Type - The representation scheme being posted to the RESTful service. The types allowed for this request header are as follows:
Specifies that the post is DICOM PS3.19 XML metadata. See Section 6.9.1.1.1.
Specifies that the post is DICOM PS3.18 JSON metadata. See Section 6.9.1.1.1.
The request body shall convey a single Unified Procedure Step Instance. The instance shall comply with all requirements in the Req. Type N-CREATE column of Table CC.2.5-3 in PS3.4 .
The Request Message has a single part body.
The request body contains all attributes to be stored in either DICOM PS3.19 XML or DICOM JSON. Any binary data contained in the message shall be inline.
The Origin-Server shall create and maintain UPS instances as instructed by CreateUPS requests and as specified by the SCP behavior in Section CC.2.5.3 in PS3.4 .
The Origin-Server shall return the HTTP Status Line applicable to the associated request.
The Origin-Server shall return an HTTP response message.
If the Create request is successful, the Origin-Server shall return an HTTP "201 - Created" response code.
If the request fails, the Origin-Server shall return an appropriate failure status line with a response code from Table 6.9.1-1.
Table 6.9.1-1. Status Codes
If the request is successful, the HTTP response message shall include the following HTTP header:
Content-Location: {+WorkitemURL}
Where {+WorkitemURL} is the URL from which the created UPS Instance can be retrieved (see Section 6.9.4)
If the UPS instance was created with modifications, the response message shall include the following HTTP header:
| DICOM PS3.18 2016b - Web Services |
|---|