Skip to content

Commit f17bb20

Browse files
Merge pull request #286728 from KendalBond007/FHIReditsBatch14_Sep24
FHIReditsBatch14_Sep24
2 parents 31e9428 + cd615eb commit f17bb20

File tree

4 files changed

+53
-52
lines changed

4 files changed

+53
-52
lines changed

articles/healthcare-apis/fhir/use-postman.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ To access the FHIR service, you need to create or update these variables:
4747
|--------------|-----------------|----------|
4848
| **tenantid** | Azure tenant where the FHIR service is deployed | Located on the Application registration overview |
4949
| **subid** | Azure subscription where the FHIR service is deployed | Located on the FHIR service overview |
50-
| **clientid** | Application client registration ID | - |
51-
| **clientsecret** | Application client registration secret | - |
50+
| **clientid** | Application client registration ID | |
51+
| **clientsecret** | Application client registration secret | |
5252
| **fhirurl** | The FHIR service full URL (for example, `https://xxx.azurehealthcareapis.com`) | Located on the FHIR service overview |
5353
| **bearerToken** | Stores the Microsoft Entra access token in the script | Leave blank |
5454

@@ -59,7 +59,7 @@ To access the FHIR service, you need to create or update these variables:
5959

6060
## Get the capability statement
6161

62-
Enter `{{fhirurl}}/metadata` in the `GET`request, and then choose `Send`. You should see the capability statement of the FHIR service.
62+
Enter `{{fhirurl}}/metadata` in the `GET` request, then choose `Send`. You should see the capability statement of the FHIR service.
6363

6464
:::image type="content" source="media/postman/postman-capability-statement.png" alt-text="Screenshot showing capability request parameters." lightbox="media/postman/postman-create-new-request.png":::
6565

@@ -69,7 +69,7 @@ Enter `{{fhirurl}}/metadata` in the `GET`request, and then choose `Send`. You sh
6969

7070
## Get a Microsoft Entra access token
7171

72-
Get a Microsoft Entra access token by using a service principal or a Microsoft Entra user account. Choose one of the two methods.
72+
Get a Microsoft Entra access token by choosing either a service principal, or a Microsoft Entra user account.
7373

7474
### Use a service principal with a client credential grant type
7575

@@ -89,9 +89,9 @@ Create a new `POST` request:
8989
> [!NOTE]
9090
> In scenarios where the FHIR service audience parameter isn't mapped to the FHIR service endpoint URL, the resource parameter value should be mapped to the audience value on the FHIR service **Authentication** pane.
9191
92-
3. Select the **Test** tab and enter in the text section: `pm.environment.set("bearerToken", pm.response.json().access_token);` To make the value available to the collection, use the pm.collectionVariables.set method. For more information on the set method and its scope level, see [Using variables in scripts](https://learning.postman.com/docs/sending-requests/variables/#defining-variables-in-scripts).
92+
3. Select the **Test** tab and enter `pm.environment.set("bearerToken", pm.response.json().access_token);` in the text section. To make the value available to the collection, use the pm.collectionVariables.set method. For more information on the set method and its scope level, see [Using variables in scripts](https://learning.postman.com/docs/sending-requests/variables/#defining-variables-in-scripts).
9393
4. Select **Save** to save the settings.
94-
5. Select **Send**. You should see a response with the Microsoft Entra access token, which is saved to the variable `bearerToken` automatically. You can then use it in all FHIR service API requests.
94+
5. Select **Send**. You should see a response with the Microsoft Entra access token, which is automatically saved to the variable `bearerToken`. You can then use it in all FHIR service API requests.
9595

9696
:::image type="content" source="media/postman/postman-send-button.png" alt-text="Screenshot showing the send button." lightbox="media/postman/postman-send-button.png":::
9797

@@ -101,7 +101,7 @@ You can examine the access token using online tools such as [https://jwt.ms](htt
101101

102102
## Use a user account with the authorization code grant type
103103

104-
You can get the Microsoft Entra access token by using your Entra account credentials and following the listed steps.
104+
You can get the Microsoft Entra access token by using your Microsoft Entra account credentials and following the listed steps.
105105

106106
1. Verify that you're a member of Microsoft Entra tenant with the required access permissions.
107107

@@ -115,7 +115,7 @@ You can get the Microsoft Entra access token by using your Entra account credent
115115

116116
:::image type="content" source="media/postman/app-registration-permissions-2.png" alt-text="Screenshot showing application registration permissions screen." lightbox="media/postman/app-registration-permissions-2.png":::
117117

118-
1. In the Postman, select the **Authorization** tab of either a collection or a specific REST Call, select **Type** as OAuth 2.0 and under **Configure New Token** section, set these values:
118+
1. In Postman, select the **Authorization** tab of either a collection or a specific REST Call, select **Type** as OAuth 2.0 and under **Configure New Token** section, set these values:
119119
- **Callback URL**: `https://oauth.pstmn.io/v1/callback`
120120

121121
- **Auth URL**: `https://login.microsoftonline.com/{{tenantid}}/oauth2/v2.0/authorize`
@@ -134,9 +134,9 @@ You can get the Microsoft Entra access token by using your Entra account credent
134134

135135
1. Choose **Get New Access Token** at the bottom of the page.
136136

137-
1. You're asked for User credentials for sign-in.
137+
1. Provide User credentials for sign-in.
138138

139-
1. You receive the token. Choose **Use Token.**
139+
1. Once you receive the token, choose **Use Token.**
140140

141141
1. Ensure the token is in the **Authorization Header** of the REST call.
142142

@@ -148,7 +148,7 @@ Open Postman, select the **workspace**, **collection**, and **environment** you
148148

149149
:::image type="content" source="media/postman/postman-create-new-request.png" alt-text="Screenshot showing creation of new request." lightbox="media/postman/postman-create-new-request.png":::
150150

151-
To perform health check on FHIR service, enter `{{fhirurl}}/health/check` in the GET request, and then choose **Send**. You should be able to see the `Status of FHIR service - HTTP Status` code response with 200 and OverallStatus as **Healthy** in response, which means your health check is successful.
151+
To perform a health check on the FHIR service, enter `{{fhirurl}}/health/check` in the GET request, and then choose **Send**. You should be able to see the `Status of FHIR service - HTTP Status` code response with 200 and OverallStatus as **Healthy** in response, which means your health check is successful.
152152

153153
## Get the FHIR resource
154154

@@ -162,11 +162,11 @@ Select **Bearer Token** as authorization type. Enter `{{bearerToken}}` in the **
162162

163163
After you obtain a Microsoft Entra access token, you can create or update the FHIR data. For example, you can create a new patient or update an existing patient.
164164

165-
Create a new request, change the method to **Post**, and then enter the value in the request section.
165+
Create a new request, change the method to **Post**, and enter the value in the request section.
166166

167167
`{{fhirurl}}/Patient`
168168

169-
Select **Bearer Token** as the authorization type. Enter `{{bearerToken}}` in the **Token** section. Select the **Body** tab. Select the **raw** option and **JSON** as body text format. Copy and paste the text to the body section.
169+
Select **Bearer Token** as the authorization type. Enter `{{bearerToken}}` in the **Token** section. Select the **Body** tab. Select the **raw** option and **JSON** as body text format. Copy and paste the following text to the body section.
170170

171171

172172
```
@@ -211,7 +211,7 @@ Select **Bearer Token** as authorization type. Enter `{{bearerToken}}` in the **
211211

212212
- **Prefer**: `respond-async`
213213

214-
Select **Send**. You should notice a `202 Accepted` response. Select the **Headers** tab of the response and make a note of the value in the **Content-Location**. You can use the value to query the export job status.
214+
Select **Send**. You should notice a `202 Accepted` response. Select the **Headers** tab of the response and make a note of the value in the **Content-Location**. You can use this value to query the export job status.
215215

216216
:::image type="content" source="media/postman/postman-202-accepted-response.png" alt-text="Screenshot showing selection 202 accepted response." lightbox="media/postman/postman-202-accepted-response.png":::
217217

articles/healthcare-apis/fhir/using-curl.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,22 @@ ms.author: kesheth
1111

1212
# Access the Azure Health Data Services with cURL
1313

14-
In this article, you'll learn how to access Azure Health Data Services with cURL.
14+
In this article, you learn how to access Azure Health Data Services with cURL.
1515

1616
## Prerequisites
1717

1818
### PowerShell
1919

2020
* An Azure account with an active subscription. [Create one for free](https://azure.microsoft.com/free/).
21-
* If you want to run the code locally, install [PowerShell](/powershell/module/powershellget/) and [Azure Az PowerShell](/powershell/azure/install-azure-powershell).
21+
* If you want to run the code locally, install [PowerShell](/powershell/module/powershellget/) and [Azure Az PowerShell module PowerShell](/powershell/azure/install-azure-powershell).
2222
* Optionally, you can run the scripts in Visual Studio Code with the REST Client extension. For more information, see [Make a link to the REST Client doc](using-rest-client.md).
2323
* Download and install [cURL](https://curl.se/download.html).
2424

2525
### CLI
2626

2727
* An Azure account with an active subscription. [Create one for free](https://azure.microsoft.com/free/).
2828
* If you want to run the code locally, install [Azure CLI](/cli/azure/install-azure-cli).
29-
* Optionally, install a Bash shell, such as Git Bash, which it's included in [Git for Windows](https://gitforwindows.org/).
29+
* Optionally, install a Bash shell, such as Git Bash, which is included in [Git for Windows](https://gitforwindows.org/).
3030
* Optionally, run the scripts in Visual Studio Code with the REST Client extension. For more information, see [Make a link to the REST Client doc](using-rest-client.md).
3131
* Download and install [cURL](https://curl.se/download.html).
3232

@@ -78,7 +78,7 @@ token=$(az account get-access-token --resource=$dicomtokenurl --query accessToke
7878

7979
---
8080
> [!NOTE]
81-
> In the scenarios where the FHIR service audience parameter is not mapped to the FHIR service endpoint url. The resource parameter value should be mapped to Audience value under FHIR Service Authentication blade.
81+
> When the FHIR® service audience parameter is not mapped to the FHIR service endpoint url, the resource parameter value should be mapped to Audience value under the FHIR Service Authentication blade.
8282
8383
## Access data in the FHIR service
8484

@@ -127,4 +127,4 @@ To learn about how to access Azure Health Data Services data using REST Client e
127127
>[!div class="nextstepaction"]
128128
>[Access Azure Health Data Services using REST Client](using-rest-client.md)
129129
130-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
130+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/fhir/using-rest-client.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,28 @@ ms.author: kesheth
1111

1212
# Accessing Azure Health Data Services using the REST Client Extension in Visual Studio Code
1313

14-
In this article, you'll learn how to access Azure Health Data Services using [REST Client extension in Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).
14+
In this article, you learn how to access Azure Health Data Services using [REST Client extension in Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).
1515

1616
## Install REST Client extension
1717

1818
Select the Extensions icon on the left side panel of your Visual Studio Code, and search for "REST Client". Find the [REST Client extension](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) and install.
1919

20-
[ ![REST Client VSCode extension](media/rest-install.png) ](media/rest-install.png#lightbox)
20+
[![REST Client VSCode extension](media/rest-install.png)](media/rest-install.png#lightbox)
2121

2222
## Create a `.http` file and define variables
2323

2424
Create a new file in Visual Studio Code. Enter a `GET` request command line in the file, and save it as `test.http`. The file suffix `.http` automatically activates the REST Client environment. Select `Send Request` to get the metadata.
2525

26-
[ ![Send Request](media/rest-send-request.png) ](media/rest-send-request.png#lightbox)
26+
[![Send Request](media/rest-send-request.png)](media/rest-send-request.png#lightbox)
2727

2828
## Get client application values
2929

3030
> [!Important]
31-
> Before calling the FHIR server REST API (other than getting the metadata), you must complete [application registration](../register-application.md). Make a note of your Azure **tenant ID**, **client ID**, **client secret** and the **service URL**.
31+
> Before calling the FHIR® server REST API (other than getting the metadata), you must complete [application registration](../register-application.md). Make a note of your Azure **tenant ID**, **client ID**, **client secret** and the **service URL**.
3232
3333
While you can use values such as the client ID directly in calls to the REST API, it's a good practice that you define a few variables for these values and use the variables instead.
3434

35-
In your `test.http` file, include the following information obtained from registering your application:
35+
In your `test.http` file, include the following information obtained from registering your application.
3636

3737
```
3838
### REST Client
@@ -46,7 +46,7 @@ In your `test.http` file, include the following information obtained from regist
4646

4747
## Get Microsoft Entra access token
4848

49-
After including the information below in your `test.http` file, hit `Send Request`. You'll see an HTTP response that contains your access token.
49+
After including the following information in your `test.http` file, hit `Send Request`. You'll see an HTTP response that contains your access token.
5050

5151
The line starting with `@name` contains a variable that captures the HTTP response containing the access token. The variable, `@token`, is used to store the access token.
5252

@@ -72,11 +72,11 @@ grant_type=client_credentials
7272
[ ![Get access token](media/rest-config.png) ](media/rest-config.png#lightbox)
7373

7474
> [!NOTE]
75-
> In the scenarios where the FHIR service audience parameter is not mapped to the FHIR service endpoint url. The resource parameter value should be mapped to Audience value under FHIR Service Authentication blade.
75+
> When the FHIR service audience parameter is not mapped to the FHIR service endpoint url, the resource parameter value should be mapped to the Audience value under the FHIR Service Authentication blade.
7676
77-
## `GET` FHIR Patient data
77+
## Get FHIR Patient data
7878

79-
You can now get a list of patients or a specific patient with the `GET` request. The line with `Authorization` is the header info for the `GET` request. You can also send `PUT` or `POST` requests to create/update FHIR resources.
79+
You can now get a list of patients or a specific patient with the `GET` request. The line with `Authorization` is the header info for the `GET` request. You can also send `PUT` or `POST` requests to create and update FHIR resources.
8080

8181
```
8282
### GET Patient
@@ -98,19 +98,20 @@ You can run PowerShell or CLI scripts within Visual Studio Code. Press `CTRL` an
9898

9999
## Troubleshooting
100100

101-
If you're unable to get the metadata, which doesn't require access token based on the HL7 specification, check that your FHIR server is running properly.
101+
If you're unable to get the metadata (which doesn't require access token based on the HL7 specification) check that your FHIR server is running properly.
102102

103103
If you're unable to get an access token, make sure that the client application is registered properly and you're using the correct values from the application registration step.
104104

105105
If you're unable to get data from the FHIR server, make sure that the client application (or the service principal) has been granted access permissions such as "FHIR Data Contributor" to the FHIR server.
106106

107107
## Next steps
108108

109-
In this article, you learned how to access Azure Health Data Services data using the using the REST Client extension in Visual Studio Code.
109+
In this article, you learned how to access Azure Health Data Services data using the REST Client extension in Visual Studio Code.
110110

111111
To learn about how to validate FHIR resources against profiles in Azure Health Data Services, see
112112

113113
>[!div class="nextstepaction"]
114114
>[Validate FHIR resources against profiles in Azure Health Data Services](validation-against-profiles.md)
115115
116-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
116+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]
117+

0 commit comments

Comments
 (0)