You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/healthcare-apis/dicom/dicom-services-conformance-statement.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ You'll find example requests for supported transactions in the [Postman collecti
42
42
43
43
## Preamble Sanitization
44
44
45
-
The service ignores the 128-byte File Preamble, and replaces its contents with null characters. This ensures that no files passed through the service are vulnerable to the [malicious preamble vulnerability](https://dicom.nema.org/medical/dicom/current/output/chtml/part10/sect_7.5.html). However, this also means that [preambles used to encode dual format content](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6489422/) such as TIFF can't be used with the service.
45
+
The service ignores the 128-byte File Preamble, and replaces its contents with null characters. This behavior ensures that no files passed through the service are vulnerable to the [malicious preamble vulnerability](https://dicom.nema.org/medical/dicom/current/output/chtml/part10/sect_7.5.html). However, this also means that [preambles used to encode dual format content](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6489422/) such as TIFF can't be used with the service.
46
46
47
47
## Studies Service
48
48
@@ -94,12 +94,12 @@ Only transfer syntaxes with explicit Value Representations are accepted.
94
94
|`202 (Accepted)`| Some instances in the request have been stored but others have failed. |
95
95
|`204 (No Content)`| No content was provided in the store transaction request. |
96
96
|`400 (Bad Request)`| The request was badly formatted. For example, the provided study instance identifier didn't conform to the expected UID format. |
97
-
|`401 (Unauthorized)`| The client isnn't authenticated. |
97
+
|`401 (Unauthorized)`| The client isn't authenticated. |
98
98
|`403 (Forbidden)`| The user isn't authorized. |
99
99
|`406 (Not Acceptable)`| The specified `Accept` header isn't supported. |
100
100
|`409 (Conflict)`| None of the instances in the store transaction request have been stored. |
101
101
|`415 (Unsupported Media Type)`| The provided `Content-Type` isn't supported. |
102
-
|`503 (Service Unavailable)`| The service is unavailable or busy. Please try again later. |
102
+
|`503 (Service Unavailable)`| The service is unavailable or busy. Try again later. |
103
103
104
104
### Store response payload
105
105
@@ -190,15 +190,15 @@ An example response with `Accept` header `application/dicom+json`:
190
190
|`272`| The store transaction didn't store the instance because of a general failure in processing the operation. |
191
191
|`43264`| The DICOM instance failed the validation. |
192
192
|`43265`| The provided instance `StudyInstanceUID` didn't match the specified `StudyInstanceUID` in the store request. |
193
-
|`45063`| A DICOM instance Data Set does not match SOP Class. The Studies Store Transaction (Section 10.5) observed that the Data Set did not match the constraints of the SOP Class during storage of the instance. |
193
+
|`45063`| A DICOM instance Data Set doesn't match SOP Class. The Studies Store Transaction (Section 10.5) observed that the Data Set didn't match the constraints of the SOP Class during storage of the instance. |
194
194
|`45070`| A DICOM instance with the same `StudyInstanceUID`, `SeriesInstanceUID`, and `SopInstanceUID` has already been stored. If you wish to update the contents, delete this instance first. |
195
195
|`45071`| A DICOM instance is being created by another process, or the previous attempt to create has failed and the cleanup process hasn't had chance to clean up yet. Delete the instance first before attempting to create again. |
196
196
197
197
### Store Error Codes
198
198
199
199
| Code | Description |
200
200
| :---- | :---------- |
201
-
|`100`| The provided instance attributes did not meet the validation criteria. |
201
+
|`100`| The provided instance attributes didn't meet the validation criteria. |
202
202
203
203
### Retrieve (WADO-RS)
204
204
@@ -298,7 +298,7 @@ Cache validation is supported using the `ETag` mechanism. In the response to a m
298
298
|`403 (Forbidden)`| The user isn't authorized. |
299
299
|`404 (Not Found)`| The specified DICOM resource couldn't be found. |
300
300
|`406 (Not Acceptable)`| The specified `Accept` header isn't supported. |
301
-
|`503 (Service Unavailable)`| The service is unavailable or busy. Please try again later. |
301
+
|`503 (Service Unavailable)`| The service is unavailable or busy. Try again later. |
302
302
303
303
### Search (QIDO-RS)
304
304
@@ -327,7 +327,7 @@ The following parameters for each query are supported:
|`{attributeID}=`|`{value}`| 0...N | Search for attribute/ value matching in query. |
330
-
|`includefield=`|`{attributeID}`<br/>`all`| 0...N | The additional attributes to return in the response. Both, public and private tags are supported.<br/>When `all` is provided. Refer to [Search Response](#search-response) for more information about which attributes will be returned for each query type.<br/>If a mixture of `{attributeID}` and `all` is provided, the server will default to using `all`. |
330
+
|`includefield=`|`{attributeID}`<br/>`all`| 0...N | The additional attributes to return in the response. Both, public and private tags are supported.<br/>When `all` is provided, refer to [Search Response](#search-response) for more information about which attributes will be returned for each query type.<br/>If a mixture of `{attributeID}` and `all` is provided, the server will default to using `all`. |
331
331
|`limit=`|`{value}`| 0..1 | Integer value to limit the number of values returned in the response.<br/>Value can be between the range 1 >= x <= 200. Defaulted to 100. |
332
332
|`offset=`|`{value}`| 0..1 | Skip `{value}` results.<br/>If an offset is provided larger than the number of search query results, a 204 (no content) response will be returned. |
333
333
|`fuzzymatching=`|`true` / `false`| 0..1 | If true fuzzy matching is applied to PatientName attribute. It will do a prefix word match of any name part inside PatientName value. For example, if PatientName is "John^Doe", then "joh", "do", "jo do", "Doe" and "John Doe" will all match. However, "ohn" won't match. |
@@ -364,7 +364,7 @@ We support the following matching types.
364
364
365
365
#### Attribute ID
366
366
367
-
Tags can be encoded in a number of ways for the query parameter. We've partially implemented the standard as defined in [PS3.18 6.7.1.1.1](http://dicom.nema.org/medical/dicom/2019a/output/chtml/part18/sect_6.7.html#sect_6.7.1.1.1). The following encodings for a tag are supported:
367
+
Tags can be encoded in several ways for the query parameter. We've partially implemented the standard as defined in [PS3.18 6.7.1.1.1](http://dicom.nema.org/medical/dicom/2019a/output/chtml/part18/sect_6.7.html#sect_6.7.1.1.1). The following encodings for a tag are supported:
368
368
369
369
| Value | Example |
370
370
| :--------------- | :--------------- |
@@ -471,7 +471,7 @@ The query API returns one of the following status codes in the response:
471
471
|`400 (Bad Request)`| The server was unable to perform the query because the query component was invalid. Response body contains details of the failure. |
472
472
|`401 (Unauthorized)`| The client isn't authenticated. |
473
473
|`403 (Forbidden)`| The user isn't authorized. |
474
-
|`503 (Service Unavailable)`| The service is unavailable or busy. Please try again later. |
474
+
|`503 (Service Unavailable)`| The service is unavailable or busy. Try again later. |
475
475
476
476
### Additional notes
477
477
@@ -509,7 +509,7 @@ There are no restrictions on the request's `Accept` header, `Content-Type` heade
509
509
|`401 (Unauthorized)`| The client isn't authenticated. |
510
510
|`403 (Forbidden)`| The user isn't authorized. |
511
511
|`404 (Not Found)`| When the specified series wasn't found within a study or the specified instance wasn't found within the series. |
512
-
|`503 (Service Unavailable)`| The service is unavailable or busy. Please try again later. |
512
+
|`503 (Service Unavailable)`| The service is unavailable or busy. Try again later. |
513
513
514
514
### Delete response payload
515
515
@@ -549,7 +549,7 @@ If not specified in the URI, the payload dataset must contain the Workitem in th
549
549
550
550
The `Accept` and `Content-Type` headers are required in the request, and must both have the value `application/dicom+json`.
551
551
552
-
There are a number of requirements related to DICOM data attributes in the context of a specific transaction. Attributes may be required to be present, required to not be present, required to be empty, or required to not be empty. These requirements can be found [in this table](https://dicom.nema.org/medical/dicom/current/output/html/part04.html#table_CC.2.5-3).
552
+
There are several requirements related to DICOM data attributes in the context of a specific transaction. Attributes may be required to be present, required to not be present, required to be empty, or required to not be empty. These requirements can be found [in this table](https://dicom.nema.org/medical/dicom/current/output/html/part04.html#table_CC.2.5-3).
553
553
554
554
Notes on dataset attributes:
555
555
@@ -566,7 +566,7 @@ Notes on dataset attributes:
566
566
|`403 (Forbidden)`| The user isn't authorized. |
567
567
|`409 (Conflict)` |The Workitem already exists.
568
568
|`415 (Unsupported Media Type)`| The provided `Content-Type` isn't supported.
569
-
|`503 (Service Unavailable)`| The service is unavailable or busy. Please try again later.|
569
+
|`503 (Service Unavailable)`| The service is unavailable or busy. Try again later.|
570
570
571
571
#### Create Response Payload
572
572
@@ -585,7 +585,7 @@ There are [four valid Workitem states](https://dicom.nema.org/medical/dicom/curr
585
585
*`CANCELED`
586
586
*`COMPLETED`
587
587
588
-
This transaction will only succeed against Workitems in the `SCHEDULED` state. Any user can claim ownership of a Workitem by setting its Transaction UID and changing its state to `IN PROGRESS`. From then on, a user can only modify the Workitem by providing the correct Transaction UID. While UPS defines Watch and Event SOP classes that allow cancellation requests and other events to be forwarded, this DICOM service does not implement these classes, and so cancellation requests on workitems that are `IN PROGRESS` will return failure. An owned Workitem can be canceled via the [Change Workitem State](#change-workitem-state) transaction.
588
+
This transaction will only succeed against Workitems in the `SCHEDULED` state. Any user can claim ownership of a Workitem by setting its Transaction UID and changing its state to `IN PROGRESS`. From then on, a user can only modify the Workitem by providing the correct Transaction UID. While UPS defines Watch and Event SOP classes that allow cancellation requests and other events to be forwarded, this DICOM service doesn't implement these classes, and so cancellation requests on workitems that are `IN PROGRESS` will return failure. An owned Workitem can be canceled via the [Change Workitem State](#change-workitem-state) transaction.
589
589
590
590
|Method |Path| Description|
591
591
|:---|:---|:---|
@@ -708,7 +708,7 @@ The request payload shall contain the Change UPS State Data Elements. These data
708
708
|Code| Description|
709
709
|:---|:---|
710
710
|`200 (OK)`| Workitem Instance was successfully retrieved.|
711
-
|`400 (Bad Request)`|The request cannot be performed for one of the following reasons: (1) the request is invalid given the current state of the Target Workitem. (2) the Transaction UID is missing. (3) the Transaction UID is incorrect|
711
+
|`400 (Bad Request)`|The request can't be performed for one of the following reasons: (1) the request is invalid given the current state of the Target Workitem. (2) the Transaction UID is missing. (3) the Transaction UID is incorrect|
|`404 (Not Found)`| The Target Workitem wasn't found.|
@@ -794,7 +794,7 @@ The response will be an array of `0...N` DICOM datasets with the following attri
794
794
* All attributes in [DICOM PowerShell 3.4 Table CC.2.5-3](https://dicom.nema.org/medical/dicom/current/output/html/part04.html#table_CC.2.5-3) with a Return Key Type of 1 or 2
795
795
* All attributes in [DICOM PowerShell 3.4 Table CC.2.5-3](https://dicom.nema.org/medical/dicom/current/output/html/part04.html#table_CC.2.5-3) with a Return Key Type of 1C for which the conditional requirements are met
796
796
* All other Workitem attributes passed as match parameters
797
-
* All other Workitem attributes passed as includefield parameter values
797
+
* All other Workitem attributes passed as `includefield` parameter values
798
798
799
799
#### Search Response Codes
800
800
@@ -808,7 +808,7 @@ The query API will return one of the following status codes in the response:
808
808
|`400 (Bad Request)`| The was a problem with the request. For example, invalid Query Parameter syntax. The Response body contains details of the failure.|
809
809
|`401 (Unauthorized)`| The client isn't authenticated.|
810
810
|`403 (Forbidden)`| The user isn't authorized. |
811
-
|`503 (Service Unavailable)`| The service is unavailable or busy. Please try again later.|
811
+
|`503 (Service Unavailable)`| The service is unavailable or busy. Try again later.|
0 commit comments