Skip to content

Commit 64b9058

Browse files
author
Shashank Narang
committed
FHIR service documentation Update for Postman link removal
1 parent 6581930 commit 64b9058

15 files changed

+33
-344
lines changed

articles/healthcare-apis/access-healthcare-apis.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Access Azure Health Data Services
3-
description: Learn how to access the FHIR, DICOM, and MedTech services in Azure Health Data Services by using Postman, cURL, REST Client, and programming languages like Python and C# for efficient data management.
3+
description: Learn how to access the FHIR, DICOM, and MedTech services in Azure Health Data Services by using cURL, REST Client, and programming languages like Python and C# for efficient data management.
44
services: healthcare-apis
55
author: EXPEkesheth
66
ms.service: azure-health-data-services
@@ -13,11 +13,10 @@ ms.author: kesheth
1313

1414
# Access Azure Health Data Services
1515

16-
After you deploy a FHIR® service, DICOM® service, or MedTech service, you can then access it in your applications by using tools like Postman, cURL, REST Client in Visual Studio Code, or with programming languages such as Python or C#.
16+
After you deploy a FHIR® service, DICOM® service, or MedTech service, you can then access it in your applications by using tools like cURL, REST Client in Visual Studio Code, or with programming languages such as Python or C#.
1717

1818
## Access the FHIR service
1919

20-
- [Access the FHIR service by using Postman](././fhir/use-postman.md)
2120
- [Access the FHIR service by using cURL](././fhir/using-curl.md)
2221
- [Access the FHIR service by using REST Client](././fhir/using-rest-client.md)
2322

@@ -32,7 +31,6 @@ After you deploy a FHIR® service, DICOM® service, or MedTech service, yo
3231
The MedTech service works with the IoT Hub and Event Hubs to receive message data, and works with the FHIR service to persist the data.
3332

3433
- [Receive device data through Azure IoT Hub](iot/device-data-through-iot-hub.md)
35-
- [Access the FHIR service by using Postman](fhir/use-postman.md)
3634
- [Access the FHIR service by using cURL](fhir/using-curl.md)
3735
- [Access the FHIR service by using REST Client](fhir/using-rest-client.md)
3836

articles/healthcare-apis/azure-api-for-fhir/get-healthcare-apis-access-token-cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ curl -X GET --header "Authorization: Bearer $token" https://<FHIR ACCOUNT NAME>.
3535

3636
## Next steps
3737

38-
In this article, you learned how to obtain an access token for the Azure API for FHIR using the Azure CLI. To learn how to access the FHIR API using Postman, proceed to the Postman tutorial:
38+
In this article, you learned how to obtain an access token for the Azure API for FHIR using the Azure CLI. To learn how to access the FHIR API using REST Client:
3939

4040
>[!div class="nextstepaction"]
41-
>[Access the FHIR service using Postman](./../fhir/use-postman.md)
41+
>[Access the FHIR service using REST Client](./../fhir/using-rest-client.md)
4242
4343
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/configure-azure-rbac.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,6 @@ In the **Select** box, search for a user, service principal, or group that you w
6262

6363
## Next steps
6464

65-
[Access by using Postman](./fhir/use-postman.md)
66-
6765
[Access by using the REST Client](./fhir/using-rest-client.md)
6866

6967
[Access by using cURL](./fhir/using-curl.md)

articles/healthcare-apis/fhir/azure-ad-b2c-setup.md

Lines changed: 19 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The B2C resource application handles authentication requests from your healthcar
148148

149149
1. In the **Supported account types** list, choose **Accounts in any identity provider or organizational directory (for authenticating users with user flows)**.
150150

151-
1. In the **Redirect URI (recommended)** drop-down list, select ***Public client/native (mobile & desktop)**. Populate the value with the [Postman](https://www.postman.com) callback URI [https://oauth.pstmn.io/v1/callback](#create-a-new-b2c-resource-application). This callback URI is for testing purposes.
151+
1. In the **Redirect URI (recommended)** drop-down list, select ***Public client/native (mobile & desktop)**. Populate the value with the callback URI. This callback URI is for testing purposes.
152152

153153
1. In the **Permissions** section, select **Grant admin consent to openid and offline_access permissions**.
154154

@@ -295,13 +295,13 @@ az deployment group create --resource-group $resourcegroupname --template-uri ht
295295

296296
## Validate Azure AD B2C users are able to access FHIR resources
297297

298-
The validation process involves creating a patient resource in the FHIR service, linking the patient resource to the Azure AD B2C user, and configuring Postman to get an access token for B2C users. After the validation process is complete, you can fetch the patient resource by using the B2C test user.
298+
The validation process involves creating a patient resource in the FHIR service, linking the patient resource to the Azure AD B2C user, and configuring REST Client to get an access token for B2C users. After the validation process is complete, you can fetch the patient resource by using the B2C test user.
299299

300-
#### Run Postman to get an access token
300+
#### Use REST Client to get an access token
301301

302-
Run the [Postman](https://www.postman.com) application locally or in a web browser. For steps to obtain the proper access to the FHIR service, see [Access the FHIR service using Postman](use-postman.md).
302+
For steps to obtain the proper access to the FHIR service, see [Access the FHIR service using REST Client](using-rest-client.md).
303303

304-
When you follow the steps in the [Get the FHIR resource](use-postman.md#get-the-fhir-resource) section, the request returns an empty response because the FHIR service is new and doesn't have any patient resources.
304+
When you follow the steps in the [Get the FHIR patient data](using-rest-client.md#get-fhir-patient-data) section, the request returns an empty response because the FHIR service is new and doesn't have any patient resources.
305305

306306
#### Create a patient resource in the FHIR service
307307

@@ -380,28 +380,24 @@ Create an explicit link between the test user in the B2C tenant and the resource
380380

381381
:::image type="content" source="media/azure-ad-b2c-setup/graph-patch-sml.png" alt-text="Screenshot showing Graph patch." lightbox="media/azure-ad-b2c-setup/graph-patch-lrg.png":::
382382

383-
#### Configure Postman to obtain an access token for B2C users
383+
#### Configuration to obtain an access token for B2C users
384384

385-
Obtain an access token to test the authentication flow.
385+
Obtain an access token to test the authentication flow.
386386

387-
1. Launch the Postman application, and then create a new **Blank collection**. In this example, the collection is named **FHIR Patient**.
387+
>[!Note]
388+
>The `grant_type` of `authorization_code` is used to obtain an access token.
389+
>There are tools available online offering intuitive interfaces for API testing and development.
388390
389-
:::image type="content" source="media/azure-ad-b2c-setup/postman-new-collection-sml.png" alt-text="Screenshot showing Postman new collection." lightbox="media/azure-ad-b2c-setup/postman-new-collection-lrg.png":::
391+
1. Launch the API testing application.
390392

391-
1. Select the **Authorization** tab in the collection overview.
393+
1. Select the **Authorization** tab in the tool.
392394

393395
1. In the **Type** dropdown list, select **OAuth 2.0**.
394396

395-
:::image type="content" source="media/azure-ad-b2c-setup/postman-auth.png" alt-text="Screenshot showing Postman auth." lightbox="media/azure-ad-b2c-setup/postman-auth.png":::
396-
397-
1. Scroll to the **Configure New Token** section and enter the following values.
397+
1. Enter the following values.
398398

399399
- **Callback URL**. This value is configured when the B2C resource application is created.
400400

401-
```http
402-
https://oauth.pstmn.io/v1/callback
403-
```
404-
405401
- **Auth URL**. This value can be created using the name of the B2C tenant and the name of the user flow.
406402

407403
```http
@@ -428,36 +424,26 @@ Obtain an access token to test the authentication flow.
428424
{YOUR_APPLICATION_ID_URI}/patient.all.read
429425
```
430426
431-
:::image type="content" source="media/azure-ad-b2c-setup/postman-urls.png" alt-text="Screenshot showing Postman URLs." lightbox="media/azure-ad-b2c-setup/postman-urls.png":::
432-
433427
#### Fetch the patient resource by using the B2C user
434428
435429
Verify that Azure AD B2C users can access FHIR resources.
436430
437-
1. When the authorization configuration in Postman is set up to launch the B2C user flow, choose **Get New Access Token** to get an access token.
438-
439-
:::image type="content" source="media/azure-ad-b2c-setup/postman-get-token-3.png" alt-text="Screenshot showing Postman get access token." lightbox="media/azure-ad-b2c-setup/postman-get-token-3.png":::
431+
1. When the authorization configuration is set up to launch the B2C user flow, choose **Get New Access Token** to get an access token.
440432
441433
1. Use the **Test Patient** credentials to sign in.
442434
443-
:::image type="content" source="media/azure-ad-b2c-setup/postman-get-token-2.png" alt-text="Screenshot showing Postman get token." lightbox="media/azure-ad-b2c-setup/postman-get-token-2.png":::
444-
445-
1. Choose **Use Token** to use the access token for any requests in the collection.
435+
1. Copy the access token and use it in fetching the Patient data
446436
447-
:::image type="content" source="media/azure-ad-b2c-setup/postman-use-token.png" alt-text="Screenshot showing Postman use token." lightbox="media/azure-ad-b2c-setup/postman-use-token.png":::
437+
Follow the steps in the [Get the FHIR patient data](using-rest-client.md#get-fhir-patient-data) to fetch the patient resource.
448438
449-
1. Create a new request to search for patient resources in the FHIR service. Select the ellipsis button (...) next to the name of the collection, and then choose **Add request**.
439+
1. Set the method to `GET`, enter the fully qualified FHIR service URL, and then add the path `/Patient`.
450440
451-
:::image type="content" source="media/azure-ad-b2c-setup/postman-request-1-sml.png" alt-text="Screenshot showing Postman request added." lightbox="media/azure-ad-b2c-setup/postman-request-1-lrg.png":::
441+
1. Use the fetched token in the authorization parameter.
452442
453-
1. Set the method to `GET`, enter the fully qualified FHIR service URL, and then add the path `/Patient`.
454-
455-
1. Choose **Send**.
443+
1. Choose **Send Request**.
456444
457445
1. Verify that the response contains the single patient resource.
458446
459-
:::image type="content" source="media/azure-ad-b2c-setup/postman-request-2.png" alt-text="Screenshot showing Postman request response." lightbox="media/azure-ad-b2c-setup/postman-request-2.png":::
460-
461447
## Next steps
462448
463449
[Configure multiple identity providers](configure-identity-providers.md)

articles/healthcare-apis/fhir/convert-data-faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ There's an example published in the [Azure Data Factory template gallery](../../
3636
>
3737
> In a scenario with batch processing of HL7v2 messages, this template doesn't take sequencing into account. Post processing is needed if sequencing is a requirement.
3838
39-
## How can I persist the converted data into the FHIR service by using Postman?
39+
## How can I persist the converted data into the FHIR service?
4040

4141
You can use the FHIR service's APIs to persist the converted data into the FHIR service by using `POST {{fhirUrl}}/{{FHIR resource type}}` with the request body containing the FHIR resource to be persisted in JSON format.
4242

43-
For more information, see [Access the FHIR service in Azure Health Data Services by using Postman](use-postman.md).
43+
For more information, see [Access the FHIR service in Azure Health Data Services by using REST Client](using-rest-client.md).
4444

4545
## What's the difference between the $convert-data endpoint in Azure API for FHIR versus the FHIR service in Azure Health Data Services?
4646

articles/healthcare-apis/fhir/deploy-azure-portal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ To replicate settings between FHIR instance, you can follow below steps
7171

7272
## Related content
7373

74-
[Access the FHIR service by using Postman](../fhir/use-postman.md)
74+
[Access the FHIR service](../fhir/get-started-with-fhir.md#access-the-fhir-service)
7575

7676
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]
7777

articles/healthcare-apis/fhir/get-started-with-fhir.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ You can obtain a Microsoft Entra access token by using PowerShell, Azure CLI, RE
5757

5858
#### Access using existing tools
5959

60-
- [Postman](../fhir/use-postman.md)
6160
- [REST Client](../fhir/using-rest-client.md)
6261
- [cURL](../fhir/using-curl.md)
62+
- There are tools available online offering intuitive interfaces for API testing and development such as Postman for example. To use tools for accessing the FHIR service, refer to the open-source sample. [Starter collection of Postman sample queries](https://github.com/Azure-Samples/azure-health-data-services-samples/tree/main/samples/sample-postman-queries)
6363

6464
#### Load data
6565

articles/healthcare-apis/fhir/index.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ landingContent:
4040
url: fhir-service-access-token-validation.md
4141
- linkListType: tutorial
4242
links:
43-
- text: Access using Postman
44-
url: ./../fhir/use-postman.md
43+
- text: Access using REST Client
44+
url: ./../fhir/using-rest-client.md
4545
- title: FHIR search capabilities
4646
linkLists:
4747
- linkListType: overview

articles/healthcare-apis/fhir/migration-strategies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Migrate applications that were pointing to the old FHIR server.
9898

9999
- After migration, reconfigure any remaining settings in the new Azure Health Data Services FHIR service server.
100100

101-
- If you’d like to double check that the Azure Health Data Services FHIR service and Azure API for FHIR servers have the same configurations, you can check both [metadata endpoints](use-postman.md#get-the-capability-statement) to compare the two servers.
101+
- If you’d like to double check that the Azure Health Data Services FHIR service and Azure API for FHIR servers have the same configurations, you can check both metadata endpoints to compare the two servers.
102102

103103
- Set up any jobs that were previously running in your old Azure API for FHIR server (for example, `$export` jobs)
104104

articles/healthcare-apis/fhir/smart-on-fhir.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Add the reply URL to the public client application that you created previously f
105105

106106
### Step 3: Get a test patient
107107

108-
To test the FHIR service and the SMART on FHIR proxy, you need to have at least one patient in the database. If you've not used the API yet, and you don't have data in the database, see [Access the FHIR service using Postman](./../fhir/use-postman.md) to load a patient. Make a note of the ID of a specific patient.
108+
To test the FHIR service and the SMART on FHIR proxy, you need to have at least one patient in the database. If you've not used the API yet, and you don't have data in the database, see [Access the FHIR service using REST Client](./../fhir/using-rest-client.md) to load a patient. Make a note of the ID of a specific patient.
109109

110110
### Step 4: Download the SMART on FHIR app launcher
111111

0 commit comments

Comments
 (0)