Skip to content

Commit 1a1e420

Browse files
committed
edits and markdown cleanup
1 parent 454b9e0 commit 1a1e420

File tree

2 files changed

+21
-20
lines changed

2 files changed

+21
-20
lines changed

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ ms.author: kesheth
1111
---
1212
# Azure API for FHIR access token validation
1313

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

16-
How Azure API for FHIR validates the access token will depend on implementation and configuration. In this article, we'll walk through the validation steps, which can be helpful when troubleshooting access issues.
16+
How Azure API for FHIR® validates the access token will depend on implementation and configuration. In this article, we'll walk through the validation steps, which can be helpful when troubleshooting access issues.
1717

18-
## Validate token has no issues with identity provider
18+
## Validate the token has no issues with identity provider
1919

2020
The first step in the token validation is to verify that the token was issued by the correct identity provider and that it hasn't been modified. The FHIR server will be configured to use a specific identity provider known as the authority `Authority`. The FHIR server will retrieve information about the identity provider from the `/.well-known/openid-configuration` endpoint. When you use Microsoft Entra ID, the full URL is:
2121

@@ -25,7 +25,7 @@ GET https://login.microsoftonline.com/<TENANT-ID>/.well-known/openid-configurati
2525

2626
where `<TENANT-ID>` is the specific Microsoft Entra tenant (either a tenant ID or a domain name).
2727

28-
Microsoft Entra ID will return a document like this one to the FHIR server.
28+
Microsoft Entra ID will return a document like the following to the FHIR server.
2929

3030
```json
3131
{
@@ -90,8 +90,9 @@ Microsoft Entra ID will return a document like this one to the FHIR server.
9090
"msgraph_host": "graph.microsoft.com",
9191
"rbac_url": "https://pas.windows.net"
9292
}
93-
```
94-
The important properties for the FHIR server are `jwks_uri`, which tells the server where to fetch the encryption keys needed to validate the token signature and `issuer`, which tells the server what will be in the issuer claim (`iss`) of tokens issued by this server. The FHIR server can use this to validate that it's receiving an authentic token.
93+
```
94+
95+
The important properties for the FHIR server are `jwks_uri`, which tells the server where to fetch the encryption keys needed to validate the token signature, and `issuer`, which tells the server what will be in the issuer claim (`iss`) of tokens issued by this server. The FHIR server can use this to validate it's receiving an authentic token.
9596

9697
## Validate claims of the token
9798

@@ -109,14 +110,14 @@ When you use the OSS Microsoft FHIR server for Azure, the server will validate:
109110
1. The token has the right `Audience` (`aud` claim).
110111
1. The token has a role in the `roles` claim, which is allowed access to the FHIR server.
111112

112-
Consult details on how to [define roles on the FHIR server](https://github.com/microsoft/fhir-server/blob/master/docs/Roles.md).
113+
For details on how to [define roles on the FHIR server](https://github.com/microsoft/fhir-server/blob/master/docs/Roles.md).
113114

114115
A FHIR server may also validate that an access token has the scopes (in token claim `scp`) to access the part of the FHIR API that a client is trying to access. Currently, Azure API for FHIR and the FHIR server for Azure don't validate token scopes.
115116

116117
## Next steps
117-
Now that you know how to walk through token validation, you can complete the tutorial to create a JavaScript application and read Fast Healthcare Interoperability Resources (FHIR&#174;) data.
118+
Now that you know how to validate tokens, you can complete the tutorial to create a JavaScript application and read Fast Healthcare Interoperability Resources (FHIR&#174;) data.
118119

119120
>[!div class="nextstepaction"]
120121
>[Web application tutorial](tutorial-web-app-fhir-server.md)
121122
122-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
123+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/azure-api-for-fhir/azure-api-fhir-resource-manager-template.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ ms.date: 09/27/2023
1212

1313
# Quickstart: Use an ARM template to deploy Azure API for FHIR
1414

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

17-
In this quickstart, you'll learn how to use an Azure Resource Manager template (ARM template) to deploy Azure API for Fast Healthcare Interoperability Resources (FHIR®). You can deploy Azure API for FHIR through the Azure portal, PowerShell, or CLI.
17+
In this quickstart, you learn how to use an Azure Resource Manager template (ARM template) to deploy Azure API for Fast Healthcare Interoperability Resources (FHIR®). You can deploy Azure API for FHIR through the Azure portal, PowerShell, or CLI.
1818

19-
[!INCLUDE [About Azure Resource Manager](~/reusable-content/ce-skilling/azure/includes/resource-manager-quickstart-introduction.md)]
19+
[!INCLUDE[About Azure Resource Manager](~/reusable-content/ce-skilling/azure/includes/resource-manager-quickstart-introduction.md)]
2020

21-
If your environment meets the prerequisites and you're familiar with using ARM templates, select the **Deploy to Azure** button. The template will open in the Azure portal once you sign in.
21+
If your environment meets the prerequisites and you're familiar with using ARM templates, select the **Deploy to Azure** button. The template opens in the Azure portal once you sign in.
2222

2323
:::image type="content" source="~/reusable-content/ce-skilling/azure/media/template-deployments/deploy-to-azure-button.svg" alt-text="Button to deploy the Resource Manager template to Azure." border="false" link="https://portal.azure.com/#create/Microsoft.Template/uri/https%3a%2f%2fraw.githubusercontent.com%2fAzure%2fazure-quickstart-templates%2fmaster%2fquickstarts%2fmicrosoft.healthcareapis%2fazure-api-for-fhir%2fazuredeploy.json":::
2424

@@ -139,7 +139,7 @@ read -p "Press [ENTER] to continue: "
139139
---
140140

141141
> [!NOTE]
142-
> The deployment takes a few minutes to complete. Note the names for the Azure API for FHIR service and the resource group, which you use to review the deployed resources later.
142+
> The deployment takes a few minutes to complete. Note the names for the Azure API for FHIR service and the resource group, for use in reviewing deployed resources.
143143
144144
## Review deployed resources
145145

@@ -151,11 +151,11 @@ Follow these steps to see an overview of your new Azure API for FHIR service:
151151

152152
2. In the FHIR list, select your new service. The **Overview** page for the new Azure API for FHIR service appears.
153153

154-
3. To validate that the new FHIR API account is provisioned, select the link next to **FHIR metadata endpoint** to fetch the FHIR API capability statement. The link has a format of `https://<service-name>.azurehealthcareapis.com/metadata`. If the account is provisioned, a large JSON file is displayed.
154+
3. To validate that the new FHIR API account is provisioned, select the link next to **FHIR metadata endpoint** to fetch the FHIR API capability statement. The link has a format of `https://<service-name>.azurehealthcareapis.com/metadata`. If the account is provisioned, a JSON file is displayed.
155155

156156
# [PowerShell](#tab/PowerShell)
157157

158-
Run the following interactive code to view details about your Azure API for FHIR service. You'll have to enter the name of the new service and the resource group.
158+
Run the following interactive code to view details about your Azure API for FHIR service. You have to enter the name and resource group of the new service.
159159

160160
```azurepowershell-interactive
161161
$serviceName = Read-Host -Prompt "Enter the name of your Azure API for FHIR service"
@@ -172,7 +172,7 @@ Read-Host "Press [ENTER] to continue"
172172

173173
# [CLI](#tab/CLI)
174174

175-
Run the following interactive code to view details about your Azure API for FHIR service. You'll have to enter the name of the new service and the resource group.
175+
Run the following interactive code to view details about your Azure API for FHIR service. You have to enter the name of the new service and the resource group.
176176

177177
```azurecli-interactive
178178
read -p "Enter the name of your Azure API for FHIR service: " serviceName &&
@@ -189,7 +189,7 @@ read -p "Press [ENTER] to continue: "
189189

190190
## Clean up resources
191191

192-
When it's no longer needed, delete the resource group, which deletes the resources in the resource group.
192+
When no longer needed, delete the resource group. This deletes the resources in the resource group.
193193

194194
# [Portal](#tab/azure-portal)
195195

@@ -225,7 +225,7 @@ For a step-by-step tutorial that guides you through the process of creating an A
225225

226226
## Next steps
227227

228-
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
228+
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 the following.
229229

230230

231231
>[!div class="nextstepaction"]
@@ -249,4 +249,4 @@ In this quickstart guide, you've deployed the Azure API for FHIR into your subsc
249249
>[!div class="nextstepaction"]
250250
>[Configure Private Link](configure-private-link.md)
251251
252-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
252+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

0 commit comments

Comments
 (0)