Skip to content

Commit 5758183

Browse files
author
Pooja Adhikari
committed
Updated document
1 parent ee22f45 commit 5758183

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

articles/healthcare-apis/dicom/dicom-proxy-url-support.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ ms.author: buchvarun
1212
# What is URL manipulation
1313
Using URL manipulation allows you to customize the URL of the image location that is in the response object.
1414

15-
For the following API operations the DICOM service returns the fully qualified URL of the image location in the response object, under a DICOM tag (UR) in the response object.
15+
For the following API operations the DICOM service returns the fully qualified URL of the image location in the response object under a DICOM tag (UR) in the response object.
1616
1. Retrieve Instance
1717
2. Retrieve WorkItems
1818
3. Retrieve OperationStatus
1919
4. Resolve QueryTag
2020
5. Resolve QueryTagError
2121

22-
The following is an example of a fully qualified image location URL. This could be found in the standard response for a STOW operation for a DICOM service that has data partition enabled, with partition name "foo".
22+
Here is an example of a fully qualified image location URL. The URL could be found in the standard response for a STOW operation for a DICOM service that has data partition enabled, with partition name "foo".
2323

2424
`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`
2525

@@ -30,21 +30,25 @@ The following is an example of a fully qualified image location URL. This could
3030

3131
This feature allows you to customize the path of the image URL, if directed by the client, based on the request headers provided.
3232

33-
# How it works
34-
The modified URL will be based on following two headers.
33+
## How it works
34+
The modified URL is based on following two headers.
3535
1. X-Forwarded-Host: The domain name of the original host (the one the client requested before the proxy or load balancer handled the request). For example: `X-Forwarded-Host: www.example.com`
3636

3737
2. X-Forwarded-Prefix: the original URL path or prefix that was part of the client’s request before the proxy forwarded or changed the request. For example: `X-Forwarded-Prefix: /prefix`
3838

39-
These headers are a part of [.net core standard forwarded headers](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/proxy-load-balancer?view=aspnetcore-8.0#forwarded-headers).
39+
These headers are a part of [.net core standard forwarded headers](https://learn.microsoft.com/aspnet/core/host-and-deploy/proxy-load-balancer).
4040

4141
If `x-forwarded-host` header is present in the request object, it replaces the host name with the value provided.
4242

4343
If `x-forwarded-prefix` header is present in the request object, it replaces the path with the value provided.
4444

45-
# List of API's that can use forwarded headers for URL manipulation
45+
## List of services that can use forwarded headers for URL manipulation
4646

47-
### STOW, WADO, worklist, operation status, querytag and querytagerror APIs
47+
1. Store(STOW-RS): Upload DICOM objects to the server.
48+
2. Retrieve(WADO-RS): Download DICOM objects from the server.
49+
3. Worklist Service (UPS Push and Pull SOPs): Manage and track medical imaging workflows.
50+
4. Extended query tags: Define custom tags for querying DICOM data.
51+
3. Operation Status
4852

4953
Here are the details of a request header for a STOW operation with the forwarded headers:
5054
* Path: ../studies/{study}
@@ -58,13 +62,13 @@ Here are the details of a request header for a STOW operation with the forwarded
5862
* Body:
5963
* Content-Type: application/DICOM for each file uploaded, separated by a boundary value
6064

61-
## Example:
62-
The following is an example of a DICOM tag with VR = UR for a STOW operation when the above headers are not provided:
65+
### Example:
66+
An example of a DICOM tag with VR = UR for a STOW operation when the forwarded headers are not provided is shown below.
6367

6468
`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`
6569

6670

67-
The following is an example of a DICOM tag with VR = UR for a STOW operation when the above headers are provided:
71+
An example of a DICOM tag with VR = UR for a STOW operation when the forwarded headers are provided is shown below.
6872

6973
Sample Request object:
7074
* Path: https://localhost:63838/v2/partitions/foo/studies/studies/{study}
@@ -83,7 +87,7 @@ URL of image:
8387
`https://API.powershare.com/newbasePath/studies/1.2.826.0.1.3680043.8.498.13230779778012324449356534479549187420/series/1.2.826.0.1.3680043.8.498.45787841905473114233124723359129632652/instances/1.2.826.0.1.3680043.8.498.12714725698140337137334606354172323212`
8488

8589

86-
# Things to remember
90+
## Things to remember
8791
1. Forwarded headers do not have to be used together. If there is a need to, simply replace hostname and not path. Only the forwarded host header can be used. Similarly, if there is a need to replace the path, only the forwarded prefix header can be used.
8892

8993
2. The client is responsible for mapping the hostname and path provided in forwarded headers to the correct DICOM service hostname and pathbase.

0 commit comments

Comments
 (0)