Skip to content

Commit 5a67e78

Browse files
author
Pooja Adhikari
committed
Fix the code caps
1 parent b01f0af commit 5a67e78

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed
Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
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.
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.
44
author: varunbms
55
ms.service: azure-health-data-services
66
ms.subservice: fhir
@@ -10,28 +10,28 @@ ms.author: buchvarun
1010
---
1111

1212
# What is URL manipulation
13-
URl manipulation allows customizing 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.
1414

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:
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:
1616
1. Retrieve Instance
1717
2. Retrieve WorkItems
1818
3. Retrieve OperationStatus
1919
4. Resolve QueryTag
2020
5. Resolve QueryTagError
2121

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

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)
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`
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)
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`
3030

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

3333
# How it works
34-
The modified url will be based on following two headers:
34+
The modified URL will be based on following two headers:
3535
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`
3636

3737
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.
@@ -45,49 +45,49 @@ If x-forwarded-host header is present in the request object, it would replace th
4545

4646
if x-forwarded-prefix header is present in the request object, it would replace the path with the value provided.
4747

48-
# List of API that can use forwarded headers for url manipulation
48+
# List of API that can use forwarded headers for URL manipulation
4949

5050
### STOW, WADO, worklist, operation status, querytag and querytagerror APIs
5151

52-
Details of a request header for a stow operation with the forwarded headers:
52+
Details of a request header for a STOW operation with the forwarded headers:
5353

5454
* Path: ../studies/{study}
5555
* Method: POST
5656
* Headers:
57-
* Accept: application/dicom+json
58-
* Content-Type: multipart/related; type="application/dicom"
57+
* Accept: application/DICOM+json
58+
* Content-Type: multipart/related; type="application/DICOM"
5959
* Authorization: Bearer {token value}
6060
* X-Forwarded-Host: {Domain name of the original host}
61-
* X-Forwarded-Prefix: {the original url path}
61+
* X-Forwarded-Prefix: {the original URL path}
6262
* Body:
63-
* Content-Type: application/dicom for each file uploaded, separated by a boundary value
63+
* Content-Type: application/DICOM for each file uploaded, separated by a boundary value
6464

6565
## Example:
66-
### Value of dicom tag with VR = UR for a stow operation when the above headers are not provided:
66+
### Value of DICOM tag with VR = UR for a STOW operation when the above headers are not provided:
6767
`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`
6868

69-
### Value of dicom tag with VR = UR for a stow operation when the above headers are provided:
69+
### Value of DICOM tag with VR = UR for a STOW operation when the above headers are provided:
7070

7171
Sample Request object:
7272
* Path: https://localhost:63838/v2/partitions/foo/studies/studies/{study}
7373
* Method: POST
7474
* Headers:
75-
* Accept: application/dicom+json
76-
* Content-Type: multipart/related; type="application/dicom"
75+
* Accept: application/DICOM+json
76+
* Content-Type: multipart/related; type="application/DICOM"
7777
* Authorization: Bearer {token value}
78-
* X-Forwarded-Host: api.powershare.com
78+
* X-Forwarded-Host: API.powershare.com
7979
* X-Forwarded-Prefix: /newbasePath
8080
* Body:
81-
* Content-Type: application/dicom for each file uploaded, separated by a boundary value
81+
* Content-Type: application/DICOM for each file uploaded, separated by a boundary value
8282

8383

84-
Url of image:
85-
`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`
84+
URL of image:
85+
`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`
8686

8787

8888
# Things to remember
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.
89+
1. Forwarded headers do not 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.
9090

91-
2. Client is responsible for mapping the hostname and path provided in forwarded headers with correct dicom service hostname and pathbase.
91+
2. Client is responsible for mapping the hostname and path provided in forwarded headers with correct DICOM service hostname and pathbase.
9292

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

0 commit comments

Comments
 (0)