Skip to content

Commit b2e5213

Browse files
committed
markdown and clarity edits
1 parent 10823fc commit b2e5213

File tree

4 files changed

+53
-49
lines changed

4 files changed

+53
-49
lines changed

articles/healthcare-apis/azure-api-for-fhir/fhir-paas-cli-quickstart.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Quickstart: Deploy Azure API for FHIR using Azure CLI'
3-
description: In this quickstart, you'll learn how to deploy Azure API for FHIR in Azure using the Azure CLI.
3+
description: In this quickstart, you learn how to deploy Azure API for FHIR in Azure using the Azure CLI.
44
services: healthcare-apis
55
author: expekesheth
66
ms.service: azure-health-data-services
@@ -13,29 +13,29 @@ ms.custom: devx-track-azurecli, mode-api
1313

1414
# Quickstart: Deploy Azure API for FHIR using Azure CLI
1515

16-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
16+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1717

18-
In this quickstart, you'll learn how to deploy Azure API for FHIR in Azure using the Azure CLI.
18+
In this quickstart, you learn how to deploy Azure API for FHIR in Azure using the Azure CLI.
1919

20-
[!INCLUDE [quickstarts-free-trial-note](~/reusable-content/ce-skilling/azure/includes/quickstarts-free-trial-note.md)]
20+
[!INCLUDE[quickstarts-free-trial-note](~/reusable-content/ce-skilling/azure/includes/quickstarts-free-trial-note.md)]
2121

22-
[!INCLUDE [azure-cli-prepare-your-environment.md](~/reusable-content/azure-cli/azure-cli-prepare-your-environment.md)]
22+
[!INCLUDE[azure-cli-prepare-your-environment.md](~/reusable-content/azure-cli/azure-cli-prepare-your-environment.md)]
2323

2424
## Add Azure Health Data Services (for example, HealthcareAPIs) extension
2525

2626
```azurecli-interactive
2727
az extension add --name healthcareapis
2828
```
2929

30-
Get a list of commands for HealthcareAPIs:
30+
To get a list of commands for HealthcareAPIs:
3131

3232
```azurecli-interactive
3333
az healthcareapis --help
3434
```
3535

3636
## Create Azure Resource Group
3737

38-
Pick a name for the resource group that will contain the Azure API for FHIR and create it:
38+
Pick a name for the resource group that contains the Azure API for FHIR and create it:
3939

4040
```azurecli-interactive
4141
az group create --name "myResourceGroup" --location westus2
@@ -49,23 +49,23 @@ az healthcareapis create --resource-group myResourceGroup --name nameoffhiraccou
4949

5050
## Fetch FHIR API capability statement
5151

52-
Obtain a capability statement from the FHIR API with:
52+
Obtain a capability statement from the FHIR API with the following command:
5353

5454
```azurecli-interactive
5555
curl --url "https://nameoffhiraccount.azurehealthcareapis.com/metadata"
5656
```
5757

5858
## Clean up resources
5959

60-
If you're not going to continue to use this application, delete the resource group with the following steps:
60+
If you're not going to continue to use this application, delete the resource group with the following steps.
6161

6262
```azurecli-interactive
6363
az group delete --name "myResourceGroup"
6464
```
6565

6666
## Next steps
6767

68-
In this quickstart guide, you've deployed the Azure API for FHIR into your subscription. For information about how to register applications and the Azure API for FHIR configuration settings, see
68+
In this quickstart guide, you deployed the Azure API for FHIR into your subscription. For information about how to register applications, and the Azure API for FHIR configuration settings, see the following.
6969

7070

7171
>[!div class="nextstepaction"]
@@ -89,4 +89,4 @@ In this quickstart guide, you've deployed the Azure API for FHIR into your subsc
8989
>[!div class="nextstepaction"]
9090
>[Configure Private Link](configure-private-link.md)
9191
92-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
92+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/azure-api-for-fhir/fhir-paas-portal-quickstart.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Quickstart: Deploy Azure API for FHIR using Azure portal'
3-
description: In this quickstart, you'll learn how to deploy Azure API for FHIR and configure settings using the Azure portal.
3+
description: In this quickstart, you learn how to deploy Azure API for FHIR and configure settings using the Azure portal.
44
services: healthcare-apis
55
author: expekesheth
66
ms.service: azure-health-data-services
@@ -13,9 +13,9 @@ ms.custom: mode-api
1313

1414
# Quickstart: Deploy Azure API for FHIR using Azure portal
1515

16-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
16+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1717

18-
In this quickstart, you'll learn how to deploy Azure API for FHIR using the Azure portal.
18+
In this quickstart, you learn how to deploy Azure API for FHIR using the Azure portal.
1919

2020
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
2121

@@ -39,21 +39,21 @@ Select **Create** to create a new Azure API for FHIR account:
3939

4040
## Enter account details
4141

42-
Select an existing resource group or create a new one, choose a name for the account, and finally select **Review + create**:
42+
Select an existing resource group or create a new one. Choose a name for the account, and finally select **Review + create**:
4343

4444
:::image type="content" source="media/quickstart-paas-portal/portal-new-healthcare-apis-details.png" alt-text="New healthcare api details":::
4545

4646
Confirm creation and await FHIR API deployment.
4747

4848
## Additional settings (optional)
4949

50-
You can also select **Next: Additional settings** to view the authentication settings. The default configuration for the Azure API for FHIR is to [use Azure RBAC for assigning data plane roles](configure-azure-rbac.md). When configured in this mode, the "Authority" for the FHIR service will be set to the Microsoft Entra tenant of the subscription:
50+
You can also select **Next: Additional settings** to view the authentication settings. The default configuration for the Azure API for FHIR is to [use Azure role-based access control (RBAC) for assigning data plane roles](configure-azure-rbac.md). When configured in this mode, the "Authority" for the FHIR service is set to the Microsoft Entra tenant of the subscription.
5151

5252
:::image type="content" source="media/rbac/confirm-azure-rbac-mode-create.png" alt-text="Default Authentication settings":::
5353

5454
Notice that the box for entering allowed object IDs is grayed out, since we use Azure RBAC for configuring role assignments in this case.
5555

56-
If you wish to configure the FHIR service to use an external or secondary Microsoft Entra tenant, you can change the Authority and enter object IDs for user and groups that should be allowed access to the server. For more information, see the [local RBAC configuration](configure-local-rbac.md) guide.
56+
If you wish to configure the FHIR service to use an external or secondary Microsoft Entra tenant, you can change the Authority and enter object IDs for users and groups that should be allowed access to the server. For more information, see the [local RBAC configuration](configure-local-rbac.md) guide.
5757

5858
## Fetch FHIR API capability statement
5959

@@ -65,7 +65,7 @@ When no longer needed, you can delete the resource group, Azure API for FHIR, an
6565

6666
## Next steps
6767

68-
In this quickstart guide, you've deployed the Azure API for FHIR into your subscription. For information about how to register applications and the Azure API for FHIR configuration settings, see
68+
In this quickstart guide, you deployed the Azure API for FHIR into your subscription. For information about how to register applications and the Azure API for FHIR configuration settings, see
6969

7070

7171
>[!div class="nextstepaction"]
@@ -89,4 +89,4 @@ In this quickstart guide, you've deployed the Azure API for FHIR into your subsc
8989
>[!div class="nextstepaction"]
9090
>[Configure Private Link](configure-private-link.md)
9191
92-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
92+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/azure-api-for-fhir/fhir-paas-powershell-quickstart.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Quickstart: Deploy Azure API for FHIR using PowerShell'
3-
description: In this quickstart, you'll learn how to deploy Azure API for FHIR using PowerShell.
3+
description: In this quickstart, you learn how to deploy Azure API for FHIR using PowerShell.
44
services: healthcare-apis
55
author: expekesheth
66
ms.service: azure-health-data-services
@@ -13,19 +13,19 @@ ms.custom: devx-track-azurepowershell
1313

1414
# Quickstart: Deploy Azure API for FHIR using PowerShell
1515

16-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
16+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1717

18-
In this quickstart, you'll learn how to deploy Azure API for FHIR using PowerShell.
18+
In this quickstart, you learn how to deploy Azure API for FHIR using PowerShell.
1919

2020
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
2121

22-
[!INCLUDE [cloud-shell-try-it.md](~/reusable-content/ce-skilling/azure/includes/cloud-shell-try-it.md)]
22+
[!INCLUDE[cloud-shell-try-it.md](~/reusable-content/ce-skilling/azure/includes/cloud-shell-try-it.md)]
2323

24-
[!INCLUDE [updated-for-az](~/reusable-content/ce-skilling/azure/includes/updated-for-az.md)]
24+
[!INCLUDE[updated-for-az](~/reusable-content/ce-skilling/azure/includes/updated-for-az.md)]
2525

2626
## Register the Azure API for FHIR resource provider
2727

28-
If the `Microsoft.HealthcareApis` resource provider isn't already registered for your subscription, you can register it with:
28+
If the `Microsoft.HealthcareApis` resource provider isn't already registered for your subscription, you can register it with the following command.
2929

3030
```azurepowershell-interactive
3131
Register-AzResourceProvider -ProviderNamespace Microsoft.HealthcareApis
@@ -44,12 +44,12 @@ New-AzHealthcareApisService -Name nameoffhirservice -ResourceGroupName myResourc
4444
```
4545

4646
> [!NOTE]
47-
> Depending on the version of the `Az` PowerShell module you have installed, the provisioned FHIR server may be configured to use [local RBAC](configure-local-rbac.md) and have the currently signed in PowerShell user set in the list of allowed identity object IDs for the deployed FHIR service. Going forward, we recommend that you [use Azure RBAC](configure-azure-rbac.md) for assigning data plane roles and you may need to delete this users object ID after deployment to enable Azure RBAC mode.
47+
> Depending on the version of the `Az` PowerShell module you have installed, the provisioned FHIR server may be configured to use [local role-based access control (RBAC)](configure-local-rbac.md) and have the currently signed in PowerShell user in the list of allowed identity object IDs for the deployed FHIR service. We recommend you [use Azure RBAC](configure-azure-rbac.md) for assigning data plane roles. You may need to delete this user's object ID after deployment to enable Azure RBAC mode.
4848
4949

5050
## Fetch capability statement
5151

52-
You'll be able to validate that the Azure API for FHIR account is running by fetching a FHIR capability statement:
52+
You can validate that the Azure API for FHIR account is running by fetching a FHIR capability statement with the following commands.
5353

5454
```azurepowershell-interactive
5555
$metadata = Invoke-WebRequest -Uri "https://nameoffhirservice.azurehealthcareapis.com/metadata"
@@ -58,15 +58,15 @@ $metadata.RawContent
5858

5959
## Clean up resources
6060

61-
If you're not going to continue to use this application, delete the resource group with the following steps:
61+
If you're not going to continue using this application, delete the resource group with the following steps.
6262

6363
```azurepowershell-interactive
6464
Remove-AzResourceGroup -Name myResourceGroupName
6565
```
6666

6767
## Next steps
6868

69-
In this quickstart guide, you've deployed the Azure API for FHIR into your subscription. For more information about the settings in Azure API for FHIR and to start using Azure API for FHIR, see
69+
In this quickstart guide, you deployed the Azure API for FHIR into your subscription. For more information about the settings in Azure API for FHIR and to start using Azure API for FHIR, see
7070

7171
>[!div class="nextstepaction"]
7272
>[Additional settings in Azure API for FHIR](azure-api-for-fhir-additional-settings.md)
@@ -92,4 +92,4 @@ In this quickstart guide, you've deployed the Azure API for FHIR into your subsc
9292
>[!div class="nextstepaction"]
9393
>[Configure Private Link](configure-private-link.md)
9494
95-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
95+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

0 commit comments

Comments
 (0)