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/export-files.md
+10-15Lines changed: 10 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,9 @@ title: Export DICOM files by using the export API of the DICOM service
3
3
description: This how-to guide explains how to export DICOM files to an Azure Blob Storage account.
4
4
author: mmitrik
5
5
ms.service: healthcare-apis
6
-
ms.subservice: fhir
6
+
ms.subservice: dicom
7
7
ms.topic: how-to
8
-
ms.date: 10/14/2022
8
+
ms.date: 10/30/2023
9
9
ms.author: mmitrik
10
10
---
11
11
@@ -37,7 +37,7 @@ The first step to export data from the DICOM service is to enable a system-assig
37
37
38
38
It takes a few minutes to create the system-assigned managed identity. After the system identity is enabled, an **Object (principal) ID** appears.
39
39
40
-
## Give storage account permissions to the system-assigned managed identity
40
+
## Assign storage account permissions
41
41
42
42
The system-assigned managed identity needs **Storage Blob Data Contributor** permission to write data to the destination storage account.
43
43
@@ -67,7 +67,7 @@ Given a *source*, the set of data to be exported, and a *destination*, the locat
67
67
68
68
Any errors encountered while you attempt to export are recorded in an error log. For more information, see the [Errors](#errors) section.
69
69
70
-
## Request
70
+
####Request
71
71
72
72
The request body consists of the export source and destination.
73
73
@@ -90,15 +90,15 @@ The request body consists of the export source and destination.
90
90
}
91
91
```
92
92
93
-
### Source settings
93
+
####Source settings
94
94
95
95
The only setting is the list of identifiers to export.
96
96
97
97
| Property | Required | Default | Description |
98
98
| :------- | :------- | :------ | :---------- |
99
99
|`Values`| Yes || A list of one or more DICOM studies, series, and/or SOP instance identifiers in the format of `"<StudyInstanceUID>[/<SeriesInstanceUID>[/<SOPInstanceUID>]]"`|
100
100
101
-
### Destination settings
101
+
####Destination settings
102
102
103
103
The connection to the Blob Storage account is specified with `BlobContainerUri`.
104
104
@@ -107,7 +107,7 @@ The connection to the Blob Storage account is specified with `BlobContainerUri`.
107
107
|`BlobContainerUri`| No |`""`| The complete URI for the blob container |
108
108
|`UseManagedIdentity`| Yes |`false`| A required flag that indicates whether managed identity should be used to authenticate to the blob container |
109
109
110
-
### Example
110
+
####Example
111
111
112
112
The following example requests the export of the following DICOM resources to the blob container named `export` in the storage account named `dicomexport`:
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).
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.
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`.
182
182
183
-
### Format
183
+
####Format
184
184
185
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*.
186
186
@@ -190,9 +190,4 @@ Each line of the error log is a JSON object with the following properties. A giv
190
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
191
|`Error`| The detailed error message |
192
192
193
-
## Next steps
194
-
195
-
>[!div class="nextstepaction"]
196
-
>[Overview of the DICOM service](dicom-services-overview.md)
0 commit comments