You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/healthcare-apis/azure-api-for-fhir/autoscale-azure-api-fhir.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,17 @@ author: mikaelweave
5
5
ms.service: healthcare-apis
6
6
ms.subservice: fhir
7
7
ms.topic: conceptual
8
-
ms.date: 05/03/2022
8
+
ms.date: 06/02/2022
9
9
ms.author: mikaelw
10
10
---
11
11
12
12
# Autoscale for Azure API for FHIR
13
13
14
-
The Azure API for FHIR as a managed service allows customers to persist with FHIR compliant healthcare data and exchange it securely through the service API. To accommodate different transaction workloads, customers can use manual scale or autoscale.
14
+
Azure API for FHIR, as a managed service, allows customers to persist with Fast Healthcare Interoperability Resources (FHIR®) compliant healthcare data and exchange it securely through the service API. To accommodate different transaction workloads, customers can use manual scale or autoscale.
15
15
16
16
## What is autoscale?
17
17
18
-
By default, the Azure API for FHIR is set to manual scale. This option works well when the transaction workloads are known and consistent. Customers can adjust the throughput `RU/s` through the portal up to 10,000 and submit a request to increase the limit.
18
+
By default, Azure API for FHIR is set to manual scale. This option works well when the transaction workloads are known and consistent. Customers can adjust the throughput `RU/s` through the portal up to 10,000 and submit a request to increase the limit.
19
19
20
20
The autoscale feature is designed to scale computing resources including the database throughput `RU/s` up and down automatically according to the workloads, thus eliminating the manual steps of adjusting allocated computing resources.
21
21
@@ -74,5 +74,11 @@ Keep in mind that this is only an estimate based on data size and that there are
74
74
75
75
The autoscale feature incurs costs because of managing the provisioned throughput units automatically. The actual costs depend on hourly usage, but keep in mind that there are minimum costs of 10% of `Tmax` for reserved throughput RU/s. However, this cost increase doesn't apply to storage and runtime costs. For information about pricing, see [Azure API for FHIR pricing](https://azure.microsoft.com/pricing/details/azure-api-for-fhir/).
76
76
77
+
## Next steps
78
+
79
+
In this document, you learned about the autoscale feature for Azure API for FHIR. For an overview about Azure API for FHIR, see
80
+
77
81
>[!div class="nextstepaction"]
78
82
>[About Azure API for FHIR](overview.md)
83
+
84
+
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/azure-api-for-fhir/azure-active-directory-identity-configuration.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,34 +7,34 @@ ms.reviewer: matjazl
7
7
ms.service: healthcare-apis
8
8
ms.subservice: fhir
9
9
ms.topic: conceptual
10
-
ms.date: 02/15/2022
10
+
ms.date: 06/02/2022
11
11
ms.author: mikaelw
12
12
---
13
13
14
14
# Azure Active Directory identity configuration for Azure API for FHIR
15
15
16
-
When you're working with healthcare data, it's important to ensure that the data is secure, and it can't be accessed by unauthorized users or applications. FHIR servers use [OAuth 2.0](https://oauth.net/2/) to ensure this data security. The [Azure API for FHIR](https://azure.microsoft.com/services/azure-api-for-fhir/) is secured using [Azure Active Directory](../../active-directory/index.yml), which is an example of an OAuth 2.0 identity provider. This article provides an overview of FHIR server authorization and the steps needed to obtain a token to access a FHIR server. While these steps apply to any FHIR server and any identity provider, we'll walk through Azure API for FHIR as the FHIR server and Azure Active Directory (Azure AD) as our identity provider in this article.
16
+
When you're working with healthcare data, it's important to ensure that the data is secure, and it can't be accessed by unauthorized users or applications. FHIR servers use [OAuth 2.0](https://oauth.net/2/) to ensure this data security. [Azure API for FHIR](https://azure.microsoft.com/services/azure-api-for-fhir/) is secured using [Azure Active Directory](../../active-directory/index.yml), which is an example of an OAuth 2.0 identity provider. This article provides an overview of FHIR server authorization and the steps needed to obtain a token to access a FHIR server. While these steps apply to any FHIR server and any identity provider, we'll walk through Azure API for FHIR as the FHIR server and Azure Active Directory (Azure AD) as our identity provider in this article.
17
17
18
18
## Access control overview
19
19
20
20
In order for a client application to access Azure API for FHIR, it must present an access token. The access token is a signed, [Base64](https://en.wikipedia.org/wiki/Base64) encoded collection of properties (claims) that convey information about the client's identity and roles and privileges granted to the client.
21
21
22
22
There are many ways to obtain a token, but the Azure API for FHIR doesn't care how the token is obtained as long as it's an appropriately signed token with the correct claims.
23
23
24
-
Using [authorization code flow](../../active-directory/azuread-dev/v1-protocols-oauth-code.md) as an example, accessing a FHIR server goes through the four steps:
24
+
For example like when you use [authorization code flow](../../active-directory/azuread-dev/v1-protocols-oauth-code.md), accessing a FHIR server goes through the following four steps:
1. The client sends a request to the `/authorize` endpoint of Azure AD. Azure AD will redirect the client to a sign-in page where the user will authenticate using appropriate credentials (for example username and password or two-factor authentication). See details on [obtaining an authorization code](../../active-directory/azuread-dev/v1-protocols-oauth-code.md#request-an-authorization-code). Upon successful authentication, an *authorization code* is returned to the client. Azure AD will only allow this authorization code to be returned to a registered reply URL configured in the client application registration.
29
29
1. The client application exchanges the authorization code for an *access token* at the `/token` endpoint of Azure AD. When you request a token, the client application may have to provide a client secret (the applications password). See details on [obtaining an access token](../../active-directory/azuread-dev/v1-protocols-oauth-code.md#use-the-authorization-code-to-request-an-access-token).
30
-
1. The client makes a request to the Azure API for FHIR, for example `GET /Patient` to search all patients. When making the request, it includes the access token in an HTTP request header, for example `Authorization: Bearer eyJ0e...`, where `eyJ0e...` represents the Base64 encoded access token.
31
-
1.The Azure API for FHIR validates that the token contains appropriate claims (properties in the token). If everything checks out, it will complete the request and return a FHIR bundle with results to the client.
30
+
1. The client makes a request to Azure API for FHIR, for example `GET /Patient`, to search all patients. When the client makes the request, it includes the access token in an HTTP request header, for example `Authorization: Bearer eyJ0e...`, where `eyJ0e...` represents the Base64 encoded access token.
31
+
1. Azure API for FHIR validates that the token contains appropriate claims (properties in the token). If everything checks out, it will complete the request and return a FHIR bundle with results to the client.
32
32
33
-
It's important to note that the Azure API for FHIR isn't involved in validating user credentials and it doesn't issue the token. The authentication and token creation is done by Azure AD. The Azure API for FHIR simply validates that the token is signed correctly (it's authentic) and that it has appropriate claims.
33
+
It's important to note that Azure API for FHIR isn't involved in validating user credentials and it doesn't issue the token. The authentication and token creation is done by Azure AD. Azure API for FHIR simply validates that the token is signed correctly (it's authentic) and that it has appropriate claims.
34
34
35
35
## Structure of an access token
36
36
37
-
Development of FHIR applications often involves debugging access issues. If a client is denied access to the Azure API for FHIR, it's useful to understand the structure of the access token and how it can be decoded to inspect the contents (the claims) of the token.
37
+
Development of Fast Healthcare Interoperability Resources (FHIR®) applications often involves debugging access issues. If a client is denied access to Azure API for FHIR, it's useful to understand the structure of the access token and how it can be decoded to inspect the contents (the claims) of the token.
38
38
39
39
FHIR servers typically expect a [JSON Web Token](https://en.wikipedia.org/wiki/JSON_Web_Token) (JWT, sometimes pronounced "jot"). It consists of three parts:
40
40
@@ -101,11 +101,13 @@ The pertinent sections of the Azure AD documentation are:
There are other variations (for example on behalf of flow) for obtaining a token. Check the Azure AD documentation for details. When you use Azure API for FHIR, there are some shortcuts for obtaining an access token (for debugging purposes) [using the Azure CLI](get-healthcare-apis-access-token-cli.md).
104
+
There are other variations (for example due to flow) for obtaining a token. Refer to the [Azure AD documentation](../../active-directory/index.yml) for details. When you use Azure API for FHIR, there are some shortcuts for obtaining an access token (such as for debugging purposes) [using the Azure CLI](get-healthcare-apis-access-token-cli.md).
105
105
106
106
## Next steps
107
107
108
-
In this document, you learned some of the basic concepts involved in securing access to the Azure API for FHIR using Azure AD. For information about how to deploy the Azure API for FHIR service, see.
108
+
In this document, you learned some of the basic concepts involved in securing access to the Azure API for FHIR using Azure AD. For information about how to deploy the Azure API for FHIR service, see
109
109
110
110
>[!div class="nextstepaction"]
111
-
>[Deploy Azure API for FHIR](fhir-paas-portal-quickstart.md)
111
+
>[Deploy Azure API for FHIR](fhir-paas-portal-quickstart.md)
112
+
113
+
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/azure-api-for-fhir/azure-api-fhir-access-token-validation.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ ms.reviewer: matjazl
7
7
ms.service: healthcare-apis
8
8
ms.subservice: fhir
9
9
ms.topic: conceptual
10
-
ms.date: 02/15/2022
10
+
ms.date: 06/02/2022
11
11
ms.author: mikaelw
12
12
---
13
13
# Azure API for FHIR access token validation
@@ -16,7 +16,7 @@ How Azure API for FHIR validates the access token will depend on implementation
16
16
17
17
## Validate token has no issues with identity provider
18
18
19
-
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 Azure AD, the full URL is:
19
+
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 Azure Active Directory (Azure AD), the full URL is:
20
20
21
21
```
22
22
GET https://login.microsoftonline.com/<TENANT-ID>/.well-known/openid-configuration
@@ -96,12 +96,12 @@ The important properties for the FHIR server are `jwks_uri`, which tells the ser
96
96
97
97
Once the server has verified the authenticity of the token, the FHIR server will then proceed to validate that the client has the required claims to access the token.
98
98
99
-
When using the Azure API for FHIR, the server will validate:
99
+
When you use Azure API for FHIR, the server will validate:
100
100
101
101
1. The token has the right `Audience` (`aud` claim).
102
102
1. The user or principal that the token was issued for is allowed to access the FHIR server data plane. The `oid` claim of the token contains an identity object ID, which uniquely identifies the user or principal.
103
103
104
-
We recommend that the FHIR service be [configured to use Azure RBAC](configure-azure-rbac.md) to manage data plane role assignments. But you can also [configure local RBAC](configure-local-rbac.md) if your FHIR service uses an external or secondary Azure Active Directory tenant.
104
+
We recommend that the FHIR service be [configured to use Azure RBAC](configure-azure-rbac.md) to manage data plane role assignments. However, you can also [configure local RBAC](configure-local-rbac.md) if your FHIR service uses an external or secondary Azure AD tenant.
105
105
106
106
When you use the OSS Microsoft FHIR server for Azure, the server will validate:
107
107
@@ -110,10 +110,12 @@ When you use the OSS Microsoft FHIR server for Azure, the server will validate:
110
110
111
111
Consult details on how to [define roles on the FHIR server](https://github.com/microsoft/fhir-server/blob/master/docs/Roles.md).
112
112
113
-
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, the Azure API for FHIR and the FHIR server for Azure don't validate token scopes.
113
+
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.
114
114
115
115
## Next steps
116
-
Now that you know how to walk through token validation, you can complete the tutorial to create a JavaScript application and read FHIR data.
116
+
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®) data.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/azure-api-for-fhir/azure-api-for-fhir-additional-settings.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ ms.topic: conceptual
7
7
ms.reviewer: matjazl
8
8
ms.author: mikaelw
9
9
author: mikaelweave
10
-
ms.date: 02/15/2022
10
+
ms.date: 06/02/2022
11
11
---
12
12
13
13
# Additional settings for Azure API for FHIR
@@ -24,7 +24,7 @@ For more information on how to change the default settings, see [configure datab
24
24
25
25
## Access control
26
26
27
-
The Azure API for FHIR will only allow authorized users to access the FHIR API. You can configure authorized users through two different mechanisms. The primary and recommended way to configure access control is using [Azure role-based access control (Azure RBAC)](../../role-based-access-control/index.yml), which is accessible through the **Access control (IAM)** blade. Azure RBAC only works if you want to secure data plane access using the Azure Active Directory tenant associated with your subscription. If you wish to use a different tenant, the Azure API for FHIR offers a local FHIR data plane access control mechanism. The configuration options aren't as rich when using the local RBAC mechanism. For details, choose one of the following options:
27
+
Azure API for FHIR will only allow authorized users to access the FHIR API. You can configure authorized users through two different mechanisms. The primary and recommended way to configure access control is using [Azure role-based access control (Azure RBAC)](../../role-based-access-control/index.yml), which is accessible through the **Access control (IAM)** blade. Azure RBAC only works if you want to secure data plane access using the Azure Active Directory tenant associated with your subscription. If you wish to use a different tenant, the Azure API for FHIR offers a local FHIR data plane access control mechanism. The configuration options aren't as rich when using the local RBAC mechanism. For details, choose one of the following options:
28
28
29
29
*[Azure RBAC for FHIR data plane](configure-azure-rbac.md). This is the preferred option when you're using the Azure Active Directory tenant associated with your subscription.
30
30
*[Local FHIR data plane access control](configure-local-rbac.md). Use this option only when you need to use an external Azure Active Directory tenant for data plane access control.
@@ -51,4 +51,6 @@ In this how-to guide, you set up additional settings for the Azure API for FHIR.
51
51
Next check out the series of tutorials to create a web application that reads FHIR data.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/azure-api-for-fhir/carin-implementation-guide-blue-button-tutorial.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ ms.topic: tutorial
8
8
ms.reviewer: matjazl
9
9
ms.author: mikaelw
10
10
author: mikaelweave
11
-
ms.date: 02/15/2022
11
+
ms.date: 06/02/2022
12
12
---
13
13
14
14
# CARIN Implementation Guide for Blue Button® for Azure API for FHIR
@@ -75,5 +75,7 @@ The final test we'll walk through is testing [error handling](https://touchstone
75
75
In this tutorial, we walked through how to pass the CARIN IG for Blue Button tests in Touchstone. Next, you can review how to test the Da Vinci formulary tests.
76
76
77
77
>[!div class="nextstepaction"]
78
-
>[DaVinci Drug Formulary](davinci-drug-formulary-tutorial.md)
78
+
>[DaVinci Drug Formulary](davinci-drug-formulary-tutorial.md)
79
+
80
+
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
0 commit comments