|
1 | 1 | ---
|
2 |
| -title: Support for url manipulation for the DICOM service in Azure Health Data Services |
3 |
| -description: Learn how to customize or manipulate the url of the image location that is in response object. |
| 2 | +title: Support for url customization for the DICOM service in Azure Health Data Services |
| 3 | +description: Learn how to customize the url of the image location that is in response object. |
4 | 4 | author: varunbms
|
5 | 5 | ms.service: azure-health-data-services
|
6 | 6 | ms.subservice: fhir
|
7 | 7 | ms.topic: overview
|
8 |
| -ms.date: 03/26/2024 |
| 8 | +ms.date: 10/17/2024 |
9 | 9 | ms.author: buchvarun
|
10 | 10 | ---
|
11 | 11 |
|
12 | 12 | # What is URL manipulation
|
13 |
| -URl manipulation allows customizing the url of the image location that is in response object. |
| 13 | +URl manipulation allows customizing url of the image location that is in response object. |
14 | 14 |
|
15 |
| -The Dicom service returns the fully qualified url of the imae location in the response object in the dicom tag (UR) in following api resonse: |
| 15 | +Dicom service returns the fully qualified url of the image location in response object under dicom tag (UR) in the response object of following api operations: |
16 | 16 | 1. Retrieve Instance
|
17 | 17 | 2. Retrieve WorkItems
|
18 | 18 | 3. Retrieve OperationStatus
|
19 | 19 | 4. Resolve QueryTag
|
20 | 20 | 5. Resolve QueryTagError
|
21 | 21 |
|
22 |
| -An example of a standard response for a stow operatoin is as below: |
| 22 | +An example of fully qualified image location of url in the standard response for a stow operation for a dicom service that has data partition enabled with partition name "foo" is as below: |
23 | 23 |
|
24 | 24 | `https://localhost:63838/v2/partitions/foo/studies/1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420/series/1.2.826.0.1.3680043.8.498.77033797676425927098669402985243398207/instances/1.2.826.0.1.3680043.8.498.13273713909719068980354078852867170114`
|
25 | 25 |
|
26 |
| -Here, the url in the response contains a dicom tag "UR" with the value represents the location of the image. |
27 |
| - |
28 |
| - The hostname of this Url represents the dicom service that is being used. |
29 |
| - |
30 |
| - To breakdown the structure of the above urlm it consists of |
31 |
| - 1. hostname -> `https://localhost:63838` |
32 |
| - 2. path -> `v2/partitions/foo` |
| 26 | + To breakdown the structure of the above url, it consists of following three parts: |
| 27 | + 1. hostname -> `https://localhost:63838` (the hostname of dicom service) |
| 28 | + 2. path -> `v2/partitions/foo` (path that represents the version of dicom service being used and the datapartition name if it enabled) |
33 | 29 | 3. Dicom web standard path -> `studies/1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420/series/1.2.826.0.1.3680043.8.498.77033797676425927098669402985243398207/instances/1.2.826.0.1.3680043.8.498.13273713909719068980354078852867170114`
|
34 | 30 |
|
35 |
| - The feature allows to manipuate the hostname and the path of the response object if needed. |
| 31 | + This feature will allow to customize the path of the image url, if directed by client based on the request headers they have provided. |
36 | 32 |
|
37 | 33 | # How it works
|
38 |
| - This feature will allow modify the path of response url if directed by client based on the request headers they provided. |
39 |
| -The modified header will be based on following two headers: |
| 34 | +The modified url will be based on following two headers: |
40 | 35 | 1. X-Forwarded-Host: This represents the domain name of the original host (the one the client requested before the proxy or load balancer handled the request). Example: `X-Forwarded-Host: www.example.com`
|
41 | 36 |
|
42 | 37 | 2. X-Forwarded-Prefix: This represents the original URL path or prefix that was part of the client’s request before the proxy forwarded or changed the request.
|
@@ -93,8 +88,6 @@ Url of image:
|
93 | 88 | # Things to remember
|
94 | 89 | 1. Forwarded headers donot have to be used together. If there is a need to just replace hostname and not path, only forwarded host header can be used. Similarly, if there is a need to just replace path, only forwared prefix header can be used.
|
95 | 90 |
|
96 |
| - 2. This is only url manipulation. Client is responsible for mapping the headers and path provided in forwarded headers with the actual dicom service hostname and pathbase. |
97 |
| - |
98 |
| - |
| 91 | + 2. Client is responsible for mapping the hostname and path provided in forwarded headers with correct dicom service hostname and pathbase. |
99 | 92 |
|
100 | 93 | [!INCLUDE [DICOM trademark statement](../includes/healthcare-apis-dicom-trademark.md)]
|
0 commit comments