Skip to content

Commit 7c0e42c

Browse files
committed
markdown and edit updates, author update
1 parent aea2533 commit 7c0e42c

File tree

2 files changed

+32
-32
lines changed

2 files changed

+32
-32
lines changed

articles/healthcare-apis/dicom/dicom-services-conformance-statement.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: DICOM Conformance Statement version 1 for Azure Health Data Services
33
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.
44
services: healthcare-apis
5-
author: mmitrik
5+
author: varunbms
66
ms.service: azure-health-data-services
77
ms.subservice: dicom-service
88
ms.topic: reference
99
ms.date: 10/13/2023
10-
ms.author: mmitrik
10+
ms.author: varunbms
1111
---
1212

1313
# DICOM Conformance Statement v1
@@ -30,7 +30,7 @@ The Medical Imaging Server for DICOM® supports a subset of the DICOMweb Stan
3030
* [Request Cancellation](#request-cancellation)
3131
* [Search Workitems](#search-workitems)
3232

33-
Additionally, the following nonstandard API(s) are supported:
33+
Additionally, the following nonstandard APIs are supported:
3434

3535
* [Change Feed](change-feed-overview.md)
3636
* [Extended Query Tags](dicom-extended-query-tags-overview.md)
@@ -393,7 +393,7 @@ We support the following matching types.
393393

394394
| Search Type | Supported Attribute | Example |
395395
| ----------- | ------------------- | ------- |
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. |
397397
| Exact Match | All supported attributes | `{attributeID}={value1}` |
398398
| Fuzzy Match | `PatientName`, `ReferringPhysicianName` | Matches any component of the name that starts with the value. |
399399

@@ -406,7 +406,7 @@ Tags can be encoded in several ways for the query parameter. We have partially i
406406
| `{group}{element}` | `0020000D` |
407407
| `{dicomKeyword}` | `StudyInstanceUID` |
408408

409-
Here is an example query searching for instances:
409+
Here's an example query searching for instances:
410410

411411
`../instances?Modality=CT&00280011=512&includefield=00280010&limit=5&offset=0`
412412

@@ -659,7 +659,7 @@ This transaction retrieves a Workitem. It corresponds to the UPS DIMSE N-GET ope
659659

660660
Refer to: https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_11.5
661661

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.
663663

664664
| Method | Path | Description |
665665
| ------- | ----------------------- | ------------- |
@@ -680,15 +680,15 @@ The `Accept` header is required and must have the value `application/dicom+json`
680680
#### Retrieve Workitem response payload
681681

682682
* 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.
684684

685685
### Update Workitem
686686

687687
This transaction modifies attributes of an existing Workitem. It corresponds to the UPS DIMSE N-SET operation.
688688

689689
Refer to: https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_11.6
690690

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)`.
692692

693693
| Method | Path | Description |
694694
| ------- | ------------------------------- | --------------------- |
@@ -723,9 +723,9 @@ found in [this table](https://dicom.nema.org/medical/dicom/current/output/html/p
723723

724724
#### Update Workitem transaction response payload
725725

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).
727727

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.
729729

730730
A failure response payload might contain a Status Report describing any failures, warnings, or other useful information.
731731

@@ -735,17 +735,17 @@ This transaction is used to change the state of a Workitem. It corresponds to th
735735

736736
Refer to: https://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_11.7
737737

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)
739739

740740
| Method | Path | Description |
741741
| ------- | ------------------------------- | --------------------- |
742742
| PUT | ../workitems/{workitem}/state | Change Workitem State |
743743

744744
The `Accept` header is required, and must have the value `application/dicom+json`.
745745

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:
747747

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.
749749
* **Procedure Step State (0074, 1000)**. The legal values correspond to the requested state transition. They are: `IN PROGRESS`, `COMPLETED`, or `CANCELED`.
750750

751751
#### Change Workitem state response status codes
@@ -762,7 +762,7 @@ The request payload will contain the Change UPS State Data Elements. These data
762762
#### Change Workitem state response payload
763763

764764
* 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.
766766
* A failure response payload might contain a Status Report describing any failures, warnings, or other useful information.
767767

768768
### Search Workitems
@@ -781,7 +781,7 @@ The following `Accept` header is supported for searching.
781781

782782
The following parameters for each query are supported.
783783

784-
| Key | Support Value(s) | Allowed Count | Description |
784+
| Key | Support Values | Allowed Count | Description |
785785
| ---------------- | ----------------------------- | ------------- | ----------- |
786786
| `{attributeID}=` | `{value}` | 0...N | Search for attribute/ value matching in query |
787787
| `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'. |

articles/healthcare-apis/dicom/dicomweb-standard-apis-c-sharp.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Use C# and DICOMweb Standard APIs in Azure Health Data Services
33
description: Learn how to use C# and DICOMweb Standard APIs to store, retrieve, search, and delete DICOM files in the DICOM service.
4-
author: mmitrik
4+
author: varunbms
55
ms.service: azure-health-data-services
66
ms.subservice: dicom-service
77
ms.topic: tutorial
88
ms.date: 10/18/2023
9-
ms.author: mmitrik
9+
ms.author: varunbms
1010
---
1111

1212
# Use C# and DICOMweb Standard APIs
@@ -79,7 +79,7 @@ DicomWebResponse response = await client.StoreAsync(new[] { dicomFile });
7979

8080
### Store instances for a specific study
8181

82-
Store instances for a specific study demonstrate how to upload a DICOM file into a specified study.
82+
Store instances for a specific study demonstrates how to upload a DICOM file into a specified study.
8383

8484
_Details:_
8585

@@ -96,7 +96,7 @@ Before moving on to the next part of the tutorial, upload the `green-square.dcm`
9696

9797
The code snippets show how to perform each of the retrieve queries using the DicomWebClient created previously.
9898

99-
The variables are used throughout the rest of the examples:
99+
The variables are used throughout the rest of the examples.
100100

101101
```c#
102102
string studyInstanceUid = "1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420"; //StudyInstanceUID for all 3 examples
@@ -174,7 +174,7 @@ _Details:_
174174
DicomWebResponse response = await client.RetrieveSeriesMetadataAsync(studyInstanceUid, seriesInstanceUid);
175175
```
176176

177-
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.
178178

179179
### Retrieve a single instance within a series of a study
180180

@@ -188,7 +188,7 @@ _Details:_
188188
DicomWebResponse response = await client.RetrieveInstanceAsync(studyInstanceUid, seriesInstanceUid, sopInstanceUid);
189189
```
190190

191-
This response should only return the instance red-triangle. Validate that the response has a status code of OK and that the instance is returned.
191+
The response should only return the instance red-triangle. Validate that the response has a status code of OK and that the instance is returned.
192192

193193
### Retrieve metadata of a single instance within a series of a study
194194

@@ -202,7 +202,7 @@ _Details:_
202202
DicomWebResponse response = await client.RetrieveInstanceMetadataAsync(studyInstanceUid, seriesInstanceUid, sopInstanceUid);
203203
```
204204

205-
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.
206206

207207
### Retrieve one or more frames from a single instance
208208

@@ -217,7 +217,7 @@ DicomWebResponse response = await client.RetrieveFramesAsync(studyInstanceUid, s
217217

218218
```
219219

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.
221221

222222
## Query DICOM (QIDO)
223223

@@ -237,7 +237,7 @@ string query = $"/studies?StudyInstanceUID={studyInstanceUid}";
237237
DicomWebResponse response = await client.QueryStudyAsync(query);
238238
```
239239

240-
Validates that the response includes one study, and that the response code is OK.
240+
Validate that the response includes one study, and that the response code is OK.
241241

242242
### Search for series
243243

@@ -252,7 +252,7 @@ string query = $"/series?SeriesInstanceUID={seriesInstanceUid}";
252252
DicomWebResponse response = await client.QuerySeriesAsync(query);
253253
```
254254

255-
Validates that the response includes one series, and that the response code is OK.
255+
Validate that the response includes one series, and that the response code is OK.
256256

257257
### Search for series within a study
258258

@@ -267,7 +267,7 @@ string query = $"/studies/{studyInstanceUid}/series?SeriesInstanceUID={seriesIns
267267
DicomWebResponse response = await client.QueryStudySeriesAsync(studyInstanceUid, query);
268268
```
269269

270-
Validates that the response includes one series, and that the response code is OK.
270+
Validate that the response includes one series, and that the response code is OK.
271271

272272
### Search for instances
273273

@@ -282,7 +282,7 @@ string query = $"/instances?SOPInstanceUID={sopInstanceUid}";
282282
DicomWebResponse response = await client.QueryInstancesAsync(query);
283283
```
284284

285-
Validates that the response includes one instance, and that the response code is OK.
285+
Validate that the response includes one instance, and that the response code is OK.
286286

287287
### Search for instances within a study
288288

@@ -297,7 +297,7 @@ string query = $"/studies/{studyInstanceUid}/instances?SOPInstanceUID={sopInstan
297297
DicomWebResponse response = await client.QueryStudyInstanceAsync(studyInstanceUid, query);
298298
```
299299

300-
Validates that the response includes one instance, and that the response code is OK.
300+
Validate that the response includes one instance, and that the response code is OK.
301301

302302
### Search for instances within a study and series
303303

@@ -312,7 +312,7 @@ string query = $"/studies/{studyInstanceUid}/series/{seriesInstanceUid}/instance
312312
DicomWebResponse response = await client.QueryStudySeriesInstanceAsync(studyInstanceUid, seriesInstanceUid, query);
313313
```
314314

315-
Validates that the response includes one instance, and that the response code is OK.
315+
Validate that the response includes one instance, and that the response code is OK.
316316

317317
## Delete DICOM
318318

@@ -332,7 +332,7 @@ string sopInstanceUidRed = "1.2.826.0.1.3680043.8.498.47359123102728459884412887
332332
DicomWebResponse response = await client.DeleteInstanceAsync(studyInstanceUid, seriesInstanceUid, sopInstanceUidRed);
333333
```
334334

335-
This repose deletes the red-triangle instance from the server. If it's successful, the response status code contains no content.
335+
This reponse deletes the red-triangle instance from the server. If it's successful, the response status code contains no content.
336336

337337
### Delete a specific series within a study
338338

@@ -346,7 +346,7 @@ _Details:_
346346
DicomWebResponse response = await client.DeleteSeriesAsync(studyInstanceUid, seriesInstanceUid);
347347
```
348348

349-
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.
350350

351351
### Delete a specific study
352352

@@ -360,6 +360,6 @@ _Details:_
360360
DicomWebResponse response = await client.DeleteStudyAsync(studyInstanceUid);
361361
```
362362

363-
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.
364364

365365
[!INCLUDE [DICOM trademark statement](../includes/healthcare-apis-dicom-trademark.md)]

0 commit comments

Comments
 (0)