Skip to content

Commit 0288c17

Browse files
ShawnJacksonShawnJackson
authored
Merge pull request #255882 from paulth1/four-dicom-articles
[AQ] edit pass: Four dicom articles
2 parents 3efd32b + 7139463 commit 0288c17

File tree

4 files changed

+103
-104
lines changed

4 files changed

+103
-104
lines changed

‎articles/healthcare-apis/dicom/deploy-dicom-services-in-azure.md

Lines changed: 21 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Deploy DICOM service using the Azure portal - Azure Health Data Services
3-
description: This article describes how to deploy DICOM service in the Azure portal.
2+
title: Deploy the DICOM service by using the Azure portal - Azure Health Data Services
3+
description: This article describes how to deploy the DICOM service in the Azure portal.
44
author: mmitrik
55
ms.service: healthcare-apis
66
ms.topic: how-to
@@ -11,54 +11,49 @@ ms.custom: mode-api
1111

1212
# Deploy the DICOM service
1313

14-
In this quickstart, you'll learn how to deploy the DICOM® service using the Azure portal.
14+
In this quickstart, you learn how to deploy the DICOM® service by using the Azure portal.
1515

16-
Once deployment is complete, you can use the Azure portal to navigate to the newly created DICOM service to see the details including your service URL. The service URL to access your DICOM service will be: ```https://<workspacename-dicomservicename>.dicom.azurehealthcareapis.com```. Make sure to specify the version as part of the url when making requests. More information can be found in the [API Versioning for DICOM service documentation](api-versioning-dicom-service.md).
16+
After deployment is finished, you can use the Azure portal to go to the newly created DICOM service to see the details, including your service URL. The service URL to access your DICOM service is ```https://<workspacename-dicomservicename>.dicom.azurehealthcareapis.com```. Make sure to specify the version as part of the URL when you make requests. For more information, see [API versioning for the DICOM service](api-versioning-dicom-service.md).
1717

1818
## Prerequisites
1919

2020
To deploy the DICOM service, you need a workspace created in the Azure portal. For more information, see [Deploy a workspace in the Azure portal](../healthcare-apis-quickstart.md).
2121

22-
## Deploying DICOM service
22+
## Deploy the DICOM service
2323

2424
1. On the **Resource group** page of the Azure portal, select the name of your **Azure Health Data Services workspace**.
2525

26-
[ ![Screenshot of select workspace resource group.](media/select-workspace-resource-group.png) ](media/select-workspace-resource-group.png#lightbox)
26+
[![Screenshot that shows selecting a workspace resource group.](media/select-workspace-resource-group.png) ](media/select-workspace-resource-group.png#lightbox)
2727

28-
2. Select **Deploy DICOM service**.
28+
1. Select **Deploy DICOM service**.
2929

30-
[ ![Screenshot of deploy DICOM service.](media/workspace-deploy-dicom-services.png) ](media/workspace-deploy-dicom-services.png#lightbox)
30+
[![Screenshot that shows deploying the DICOM service.](media/workspace-deploy-dicom-services.png) ](media/workspace-deploy-dicom-services.png#lightbox)
3131

32+
1. Select **Add DICOM service**.
3233

33-
3. Select **Add DICOM service**.
34+
[![Screenshot that shows adding the DICOM service.](media/add-dicom-service.png) ](media/add-dicom-service.png#lightbox)
3435

35-
[ ![Screenshot of add DICOM service.](media/add-dicom-service.png) ](media/add-dicom-service.png#lightbox)
36+
1. Enter a name for the DICOM service, and then select **Review + create**.
3637

38+
[![Screenshot that shows the DICOM service name.](media/enter-dicom-service-name.png) ](media/enter-dicom-service-name.png#lightbox)
3739

38-
4. Enter a name for DICOM service, and then select **Review + create**.
40+
1. (Optional) Select **Next: Tags**.
3941

40-
[ ![Screenshot of DICOM service name.](media/enter-dicom-service-name.png) ](media/enter-dicom-service-name.png#lightbox)
42+
Tags are name/value pairs used for categorizing resources. For more information about tags, see [Use tags to organize your Azure resources and management hierarchy](../../azure-resource-manager/management/tag-resources.md).
4143

44+
1. When you notice the green validation check mark, select **Create** to deploy the DICOM service.
4245

43-
(**Optional**) Select **Next: Tags >**.
46+
1. After the deployment process is finished, select **Go to resource**.
4447

45-
Tags are name/value pairs used for categorizing resources. For information about tags, see [Use tags to organize your Azure resources and management hierarchy](../../azure-resource-manager/management/tag-resources.md).
48+
[![Screenshot that shows Go to resource.](media/go-to-resource.png) ](media/go-to-resource.png#lightbox)
4649

47-
5. When you notice the green validation check mark, select **Create** to deploy DICOM service.
48-
49-
6. When the deployment process completes, select **Go to resource**.
50-
51-
[ ![Screenshot of DICOM go to resource.](media/go-to-resource.png) ](media/go-to-resource.png#lightbox)
52-
53-
The result of the newly deployed DICOM service is shown below.
54-
55-
[ ![Screenshot of DICOM finished deployment.](media/results-deployed-dicom-service.png) ](media/results-deployed-dicom-service.png#lightbox)
50+
The result of the newly deployed DICOM service is shown here.
5651

52+
[![Screenshot that shows the DICOM finished deployment.](media/results-deployed-dicom-service.png) ](media/results-deployed-dicom-service.png#lightbox)
5753

5854
## Next steps
5955

60-
[Assign roles for the DICOM service](../configure-azure-rbac.md#assign-roles-for-the-dicom-service)
61-
62-
[Use DICOMweb Standard APIs with DICOM services](dicomweb-standard-apis-with-dicom-services.md)
56+
* [Assign roles for the DICOM service](../configure-azure-rbac.md#assign-roles-for-the-dicom-service)
57+
* [Use DICOMweb Standard APIs with DICOM services](dicomweb-standard-apis-with-dicom-services.md)
6358

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

‎articles/healthcare-apis/dicom/export-dicom-files.md

Lines changed: 45 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Export DICOM files using the export API of the DICOM service
3-
description: This how-to guide explains how to export DICOM files to an Azure Blob Storage account
2+
title: Export DICOM files by using the export API of the DICOM service
3+
description: This how-to guide explains how to export DICOM files to an Azure Blob Storage account.
44
author: mmitrik
55
ms.service: healthcare-apis
66
ms.subservice: fhir
@@ -9,63 +9,63 @@ ms.date: 10/14/2022
99
ms.author: mmitrik
1010
---
1111

12-
# Export DICOM Files
12+
# Export DICOM files
1313

14-
The DICOM service provides the ability to easily export DICOM data in a file format, simplifying the process of using medical imaging in external workflows, such as AI and machine learning. DICOM studies, series, and instances can be exported in bulk to an [Azure Blob Storage account](../../storage/blobs/storage-blobs-introduction.md) using the export API. DICOM data that is exported to a storage account will be exported as a `.dcm` file in a folder structure that organizes instances by `StudyInstanceID` and `SeriesInstanceID`.
14+
The DICOM&reg; service provides the ability to easily export DICOM data in a file format. The service simplifies the process of using medical imaging in external workflows, such as AI and machine learning. You can use the export API to export DICOM studies, series, and instances in bulk to an [Azure Blob Storage account](../../storage/blobs/storage-blobs-introduction.md). DICOM data that's exported to a storage account is exported as a `.dcm` file in a folder structure that organizes instances by `StudyInstanceID` and `SeriesInstanceID`.
1515

16-
There are three steps to exporting data from the DICOM service:
16+
There are three steps to exporting data from the DICOM service:
1717

18-
- Enable a system assigned managed identity for the DICOM service.
19-
- Configure a new or existing storage account and give permission to the system managed identity.
18+
- Enable a system-assigned managed identity for the DICOM service.
19+
- Configure a new or existing storage account and give permission to the system-assigned managed identity.
2020
- Use the export API to create a new export job to export the data.
2121

2222
## Enable managed identity for the DICOM service
2323

24-
The first step to export data from the DICOM service is to enable a system managed identity. This managed identity is used to authenticate the DICOM service and give permission to the storage account used as the destination for export. For more information about managed identities in Azure, see [About managed identities for Azure resources](../../active-directory/managed-identities-azure-resources/overview.md).
24+
The first step to export data from the DICOM service is to enable a system-assigned managed identity. This managed identity is used to authenticate the DICOM service and give permission to the storage account used as the destination for export. For more information about managed identities in Azure, see [About managed identities for Azure resources](../../active-directory/managed-identities-azure-resources/overview.md).
2525

2626
1. In the Azure portal, browse to the DICOM service that you want to export from and select **Identity**.
2727

28-
:::image type="content" source="media/dicom-export-identity.png" alt-text="Screenshot showing selection of Identity view." lightbox="media/dicom-export-identity.png":::
28+
:::image type="content" source="media/dicom-export-identity.png" alt-text="Screenshot that shows selection of Identity view." lightbox="media/dicom-export-identity.png":::
2929

30-
2. Set the **Status** option to **On**, and then select **Save**.
30+
1. Set the **Status** option to **On**, and then select **Save**.
3131

32-
:::image type="content" source="media/dicom-export-enable-system-identity.png" alt-text="Screenshot of system assigned identity toggle." lightbox="media/dicom-export-enable-system-identity.png":::
32+
:::image type="content" source="media/dicom-export-enable-system-identity.png" alt-text="Screenshot that shows the system-assigned identity toggle." lightbox="media/dicom-export-enable-system-identity.png":::
3333

34-
3. Select **Yes** in the confirmation dialog that appears.
34+
1. Select **Yes** in the confirmation dialog that appears.
3535

36-
:::image type="content" source="media/dicom-export-confirm-enable.png" alt-text="Screenshot of dialog confirming enabling system identity." lightbox="media/dicom-export-confirm-enable.png":::
36+
:::image type="content" source="media/dicom-export-confirm-enable.png" alt-text="Screenshot that shows the dialog confirming enabling system identity." lightbox="media/dicom-export-confirm-enable.png":::
3737

38-
It will take a few minutes to create the system managed identity. When the system identity has been enabled, an **Object (principal) ID** will be displayed.
38+
It takes a few minutes to create the system-assigned managed identity. After the system identity is enabled, an **Object (principal) ID** appears.
3939

40-
## Give storage account permissions to the system managed identity
40+
## Give storage account permissions to the system-assigned managed identity
4141

42-
The system managed identity will need **Storage Blob Data Contributor** permission to write data to the destination storage account.
42+
The system-assigned managed identity needs **Storage Blob Data Contributor** permission to write data to the destination storage account.
4343

44-
1. Under **Permissions** select **Azure role assignments**.
44+
1. Under **Permissions**, select **Azure role assignments**.
4545

46-
:::image type="content" source="media/dicom-export-azure-role-assignments.png" alt-text="Screenshot of Azure role assignments button on Identity view." lightbox="media/dicom-export-azure-role-assignments.png":::
46+
:::image type="content" source="media/dicom-export-azure-role-assignments.png" alt-text="Screenshot that shows the Azure role assignments button on the Identity view." lightbox="media/dicom-export-azure-role-assignments.png":::
4747

48+
1. Select **Add role assignment**. On the **Add role assignment** pane, make the following selections:
4849

49-
2. Select **Add role assignment**. On the **Add role assignment** panel, make the following selections:
5050
* Under **Scope**, select **Storage**.
51-
* Under **Resource**, select the destination storage account for the export operation.
52-
* Under **Role**, select **Storage Blob Data Contributor**.
51+
* Under **Resource**, select the destination storage account for the export operation.
52+
* Under **Role**, select **Storage Blob Data Contributor**.
5353

54-
:::image type="content" source="media/dicom-export-add-role-assignment.png" alt-text="Screenshot of Add Role Assignment panel." lightbox="media/dicom-export-add-role-assignment.png":::
54+
:::image type="content" source="media/dicom-export-add-role-assignment.png" alt-text="Screenshot that shows the Add role assignment pane." lightbox="media/dicom-export-add-role-assignment.png":::
5555

56-
3. Select **Save** to add the permission to the system managed identity.
56+
1. Select **Save** to add the permission to the system-assigned managed identity.
5757

5858
## Use the export API
5959

60-
The export API exposes one `POST` endpoint for exporting data.
60+
The export API exposes one `POST` endpoint for exporting data.
6161

6262
```
6363
POST <dicom-service-url>/<version>/export
6464
```
6565

66-
Given a *source*, the set of data to be exported, and a *destination*, the location to which data will be exported, the endpoint returns a reference to a new, long-running export operation. The duration of this operation depends on the volume of data to be exported. See [Operation Status](#operation-status) below for more details about monitoring progress of export operations.
66+
Given a *source*, the set of data to be exported, and a *destination*, the location to which data will be exported, the endpoint returns a reference to a new, long-running export operation. The duration of this operation depends on the volume of data to be exported. For more information about monitoring progress of export operations, see the [Operation status](#operation-status) section.
6767

68-
Any errors encountered while attempting to export will be recorded in an error log. See [Errors](#errors) below for details.
68+
Any errors encountered while you attempt to export are recorded in an error log. For more information, see the [Errors](#errors) section.
6969

7070
## Request
7171

@@ -96,23 +96,24 @@ The only setting is the list of identifiers to export.
9696

9797
| Property | Required | Default | Description |
9898
| :------- | :------- | :------ | :---------- |
99-
| `Values` | Yes | | A list of one or more DICOM studies, series, and/or SOP instances identifiers in the format of `"<StudyInstanceUID>[/<SeriesInstanceUID>[/<SOPInstanceUID>]]"`. |
99+
| `Values` | Yes | | A list of one or more DICOM studies, series, and/or SOP instance identifiers in the format of `"<StudyInstanceUID>[/<SeriesInstanceUID>[/<SOPInstanceUID>]]"` |
100100

101101
### Destination settings
102102

103-
The connection to the Azure Blob storage account is specified with a `BlobContainerUri`.
103+
The connection to the Blob Storage account is specified with `BlobContainerUri`.
104104

105105
| Property | Required | Default | Description |
106106
| :------------------- | :------- | :------ | :---------- |
107-
| `BlobContainerUri` | No | `""` | The complete URI for the blob container. |
108-
| `UseManagedIdentity` | Yes | `false` | A required flag indicating whether managed identity should be used to authenticate to the blob container. |
107+
| `BlobContainerUri` | No | `""` | The complete URI for the blob container |
108+
| `UseManagedIdentity` | Yes | `false` | A required flag that indicates whether managed identity should be used to authenticate to the blob container |
109109

110110
### Example
111111

112-
The below example requests the export of the following DICOM resources to the blob container named `export` in the storage account named `dicomexport`:
113-
- All instances within the study whose `StudyInstanceUID` is `1.2.3`.
114-
- All instances within the series whose `StudyInstanceUID` is `12.3` and `SeriesInstanceUID` is `4.5.678`.
115-
- The instance whose `StudyInstanceUID` is `123.456`, `SeriesInstanceUID` is `7.8`, and `SOPInstanceUID` is `9.1011.12`.
112+
The following example requests the export of the following DICOM resources to the blob container named `export` in the storage account named `dicomexport`:
113+
114+
- All instances within the study whose `StudyInstanceUID` is `1.2.3`
115+
- All instances within the series whose `StudyInstanceUID` is `12.3` and `SeriesInstanceUID` is `4.5.678`
116+
- The instance whose `StudyInstanceUID` is `123.456`, `SeriesInstanceUID` is `7.8`, and `SOPInstanceUID` is `9.1011.12`
116117

117118
```http
118119
POST /export HTTP/1.1
@@ -143,7 +144,7 @@ Content-Type: application/json
143144

144145
The export API returns a `202` status code when an export operation is started successfully. The body of the response contains a reference to the operation, while the value of the `Location` header is the URL for the export operation's status (the same as `href` in the body).
145146

146-
Inside of the destination container, the DCM files can be found with the following path format: `<operation id>/results/<study>/<series>/<sop instance>.dcm`
147+
Inside the destination container, use the path format `<operation id>/results/<study>/<series>/<sop instance>.dcm` to find the DCM files.
147148

148149
```http
149150
HTTP/1.1 202 Accepted
@@ -155,7 +156,8 @@ Content-Type: application/json
155156
```
156157

157158
### Operation status
158-
The above `href` URL can be polled for the current status of the export operation until completion. Once the job has reached a terminal state, the API will return a 200 status code instead of 202, and the value of its status property will be updated accordingly.
159+
160+
Poll the preceding `href` URL for the current status of the export operation until completion. After the job has reached a terminal state, the API returns a 200 status code instead of 202. The value of its status property is updated accordingly.
159161

160162
```http
161163
HTTP/1.1 200 OK
@@ -176,19 +178,21 @@ Content-Type: application/json
176178

177179
## Errors
178180

179-
If there are any user errors when exporting a DICOM file, then the file is skipped and its corresponding error is logged. This error log is also exported alongside the DICOM files and can be reviewed by the caller. The error log can be found at `<export blob container uri>/<operation ID>/errors.log`.
181+
If there are any user errors when you export a DICOM file, the file is skipped and its corresponding error is logged. This error log is also exported alongside the DICOM files and the caller can review it. You can find the error log at `<export blob container uri>/<operation ID>/errors.log`.
180182

181183
### Format
182184

183-
Each line of the error log is a JSON object with the following properties. A given error identifier may appear multiple times in the log as each update to the log is processed *at least once*.
185+
Each line of the error log is a JSON object with the following properties. A given error identifier might appear multiple times in the log as each update to the log is processed *at least once*.
184186

185187
| Property | Description |
186188
| ------------ | ----------- |
187-
| `Timestamp` | The date and time when the error occurred. |
188-
| `Identifier` | The identifier for the DICOM study, series, or SOP instance in the format of `"<study instance UID>[/<series instance UID>[/<SOP instance UID>]]"`. |
189-
| `Error` | The detailed error message. |
189+
| `Timestamp` | The date and time when the error occurred |
190+
| `Identifier` | The identifier for the DICOM study, series, or SOP instance in the format of `"<study instance UID>[/<series instance UID>[/<SOP instance UID>]]"` |
191+
| `Error` | The detailed error message |
190192

191193
## Next steps
192194

193195
>[!div class="nextstepaction"]
194196
>[Overview of the DICOM service](dicom-services-overview.md)
197+
198+
[!INCLUDE [DICOM trademark statement](../includes/healthcare-apis-dicom-trademark.md)]

0 commit comments

Comments
 (0)