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
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
title: DICOM Conformance Statement version 1 for Azure Health Data Services
3
3
description: Read about the features and specifications of the DICOM service v1 API, which supports a subset of the DICOMweb Standard for medical imaging data. A DICOM Conformance Statement is a technical document that describes how a device or software implements the DICOM standard.
4
4
services: healthcare-apis
5
-
author: mmitrik
5
+
author: varunbms
6
6
ms.service: azure-health-data-services
7
7
ms.subservice: dicom-service
8
8
ms.topic: reference
9
9
ms.date: 10/13/2023
10
-
ms.author: mmitrik
10
+
ms.author: varunbms
11
11
---
12
12
13
13
# DICOM Conformance Statement v1
@@ -30,7 +30,7 @@ The Medical Imaging Server for DICOM® supports a subset of the DICOMweb Stan
30
30
*[Request Cancellation](#request-cancellation)
31
31
*[Search Workitems](#search-workitems)
32
32
33
-
Additionally, the following nonstandard API(s) are supported:
33
+
Additionally, the following nonstandard APIs are supported:
@@ -393,7 +393,7 @@ We support the following matching types.
393
393
394
394
| Search Type | Supported Attribute | Example |
395
395
| ----------- | ------------------- | ------- |
396
-
| Range Query |`StudyDate`/`PatientBirthDate`|`{attributeID}={value1}-{value2}`. For date/time values, we support an inclusive range on the tag. This is mapped to `attributeID >= {value1} AND attributeID <= {value2}`. If `{value1}` isn't specified, all occurrences of dates/times prior to and including `{value2}` are matched. Likewise, if `{value2}` isn't specified, all occurrences of `{value1}` and subsequent dates/times are matched. However, one of these values has to be present. `{attributeID}={value1}-` and `{attributeID}=-{value2}` are valid, however, `{attributeID}=-` is invalid. |
396
+
| Range Query |`StudyDate`/`PatientBirthDate`|`{attributeID}={value1}-{value2}`. For date/time values, we support an inclusive range on the tag, which is mapped to `attributeID >= {value1} AND attributeID <= {value2}`. If `{value1}` isn't specified, all occurrences of dates/times prior to and including `{value2}` are matched. Likewise, if `{value2}` isn't specified, all occurrences of `{value1}` and subsequent dates/times are matched. However, one of these values has to be present. `{attributeID}={value1}-` and `{attributeID}=-{value2}` are valid, however, `{attributeID}=-` is invalid. |
397
397
| Exact Match | All supported attributes |`{attributeID}={value1}`|
398
398
| Fuzzy Match |`PatientName`, `ReferringPhysicianName`| Matches any component of the name that starts with the value. |
399
399
@@ -406,7 +406,7 @@ Tags can be encoded in several ways for the query parameter. We have partially i
@@ -659,7 +659,7 @@ This transaction retrieves a Workitem. It corresponds to the UPS DIMSE N-GET ope
659
659
660
660
Refer to: https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_11.5
661
661
662
-
If the Workitem exists on the origin server, the Workitem will be returned in an Acceptable Media Type. The returned Workitem will not contain the Transaction UID (0008,1195) Attribute. This is necessary to preserve the attribute's role as an access lock.
662
+
If the Workitem exists on the origin server, the Workitem is returned in an Acceptable Media Type. The returned Workitem won't contain the Transaction UID (0008,1195) Attribute. This is necessary to preserve the attribute's role as an access lock.
@@ -680,15 +680,15 @@ The `Accept` header is required and must have the value `application/dicom+json`
680
680
#### Retrieve Workitem response payload
681
681
682
682
* A success response has a single part payload containing the requested Workitem in the Selected Media Type.
683
-
* The returned Workitem will not contain the Transaction UID (0008, 1195) attribute of the Workitem, since that should only be known to the Owner.
683
+
* The returned Workitem won't contain the Transaction UID (0008, 1195) attribute of the Workitem, since that should only be known to the Owner.
684
684
685
685
### Update Workitem
686
686
687
687
This transaction modifies attributes of an existing Workitem. It corresponds to the UPS DIMSE N-SET operation.
688
688
689
689
Refer to: https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_11.6
690
690
691
-
To update a Workitem currently in the `SCHEDULED` state, the `Transaction UID` attribute should not be present. For a Workitem in the `IN PROGRESS` state, the request must include the current Transaction UID as a query parameter. If the Workitem is already in the `COMPLETED` or `CANCELED` states, the response is `400 (Bad Request)`.
691
+
To update a Workitem currently in the `SCHEDULED` state, the `Transaction UID` attribute shouldn't be present. For a Workitem in the `IN PROGRESS` state, the request must include the current Transaction UID as a query parameter. If the Workitem is already in the `COMPLETED` or `CANCELED` states, the response is `400 (Bad Request)`.
@@ -723,9 +723,9 @@ found in [this table](https://dicom.nema.org/medical/dicom/current/output/html/p
723
723
724
724
#### Update Workitem transaction response payload
725
725
726
-
The origin server will support header fields as required in [Table 11.6.3-2](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#table_11.6.3-2).
726
+
The origin server supports header fields as required in [Table 11.6.3-2](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#table_11.6.3-2).
727
727
728
-
A success response will have either no payload, or a payload containing a Status Report document.
728
+
A success response has either no payload, or a payload containing a Status Report document.
729
729
730
730
A failure response payload might contain a Status Report describing any failures, warnings, or other useful information.
731
731
@@ -735,17 +735,17 @@ This transaction is used to change the state of a Workitem. It corresponds to th
735
735
736
736
Refer to: https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_11.7
737
737
738
-
If the Workitem exists on the origin server, the Workitem will be returned in an Acceptable Media Type. The returned Workitem will not contain the Transaction UID (0008,1195) attribute. This is necessary to preserve this Attribute's role as an access lock as described [here.](https://dicom.nema.org/medical/dicom/current/output/html/part04.html#sect_CC.1.1)
738
+
If the Workitem exists on the origin server, the Workitem is returned in an Acceptable Media Type. The returned Workitem won't contain the Transaction UID (0008,1195) attribute. This is necessary to preserve this Attribute's role as an access lock as described [here.](https://dicom.nema.org/medical/dicom/current/output/html/part04.html#sect_CC.1.1)
| PUT | ../workitems/{workitem}/state | Change Workitem State |
743
743
744
744
The `Accept` header is required, and must have the value `application/dicom+json`.
745
745
746
-
The request payload will contain the Change UPS State Data Elements. These data elements are:
746
+
The request payload contains the Change UPS State Data Elements. These data elements are:
747
747
748
-
***Transaction UID (0008, 1195)**. The request payload will include a Transaction UID. The user agent creates the Transaction UID when requesting a transition to the `IN PROGRESS` state for a given Workitem. The user agent provides that Transaction UID in subsequent transactions with that Workitem.
748
+
***Transaction UID (0008, 1195)**. The request payload includes a Transaction UID. The user agent creates the Transaction UID when requesting a transition to the `IN PROGRESS` state for a given Workitem. The user agent provides that Transaction UID in subsequent transactions with that Workitem.
749
749
***Procedure Step State (0074, 1000)**. The legal values correspond to the requested state transition. They are: `IN PROGRESS`, `COMPLETED`, or `CANCELED`.
750
750
751
751
#### Change Workitem state response status codes
@@ -762,7 +762,7 @@ The request payload will contain the Change UPS State Data Elements. These data
762
762
#### Change Workitem state response payload
763
763
764
764
* Responses include the header fields specified in [section 11.7.3.2](https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_11.7.3.2).
765
-
* A success response will have no payload.
765
+
* A success response has no payload.
766
766
* A failure response payload might contain a Status Report describing any failures, warnings, or other useful information.
767
767
768
768
### Search Workitems
@@ -781,7 +781,7 @@ The following `Accept` header is supported for searching.
781
781
782
782
The following parameters for each query are supported.
783
783
784
-
| Key | Support Value(s)| Allowed Count | Description |
784
+
| Key | Support Values| Allowed Count | Description |
|`{attributeID}=`|`{value}`| 0...N | Search for attribute/ value matching in query |
787
787
|`includefield=`|`{attributeID}`<br/>`all`| 0...N | The other attributes to return in the response; Only top-level attributes can be included - not attributes that are part of sequences. Both public and private tags are supported. When `all` is provided, see [Search Response](#search-response) for more information about which attributes are returned for each query type. If a mixture of `{attributeID}` and `all` is provided, the server defaults to using 'all'. |
This series has two instances (green-square and red-triangle), so the response should return metadata for both instances. Validate that the response has a status code of OK and that both instances of the metadata are returned.
177
+
The series has two instances (green-square and red-triangle), so the response should return metadata for both instances. Validate that the response has a status code of OK and that both instances of the metadata are returned.
178
178
179
179
### Retrieve a single instance within a series of a study
This response should only return the metadata for the instance red-triangle. Validate that the response has a status code of OK and that the metadata is returned.
205
+
The response should only return the metadata for the instance red-triangle. Validate that the response has a status code of OK and that the metadata is returned.
206
206
207
207
### Retrieve one or more frames from a single instance
208
208
@@ -217,7 +217,7 @@ DicomWebResponse response = await client.RetrieveFramesAsync(studyInstanceUid, s
217
217
218
218
```
219
219
220
-
This response should return the only frame from the red-triangle. Validate that the response has a status code of OK and that the frame is returned.
220
+
The response should return the only frame from the red-triangle. Validate that the response has a status code of OK and that the frame is returned.
This response deletes the green-square instance (it's the only element left in the series) from the server. If it's successful, the response status code contains no content.
349
+
The response deletes the green-square instance from the server (it's the only element left in the series). If it's successful, the response status code contains no content.
This response deletes the blue-circle instance (it's the only element left in the series) from the server. If it's successful, the response status code contains no content.
363
+
The response deletes the blue-circle instance from the server (it's the only element left in the series). If it's successful, the response status code contains no content.
0 commit comments