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/fhir/configure-export-data.md
+16-17Lines changed: 16 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,21 +12,21 @@ ms.author: kesheth
12
12
13
13
# Configure export settings and set up a storage account
14
14
15
-
The FHIR service supports the `$export` operation [specified by HL7](https://www.hl7.org/fhir/uv/bulkdata/) for exporting FHIR data from a FHIR server. In the FHIR service implementation, calling the `$export` endpoint causes the FHIR service to export data into a pre-configured Azure storage account.
15
+
The FHIR® service supports the `$export` operation [specified by HL7](https://www.hl7.org/fhir/uv/bulkdata/) for exporting FHIR data from a FHIR server. In the FHIR service implementation, calling the `$export` endpoint causes the FHIR service to export data into a pre-configured Azure storage account.
16
16
17
-
Ensure you are granted with application role - 'FHIR Data exporter role' prior to configuring export. To understand more on application roles, see [Authentication and Authorization for FHIR service](../../healthcare-apis/authentication-authorization.md).
17
+
Ensure you are granted the application role 'FHIR Data exporter role' prior to configuring export. To understand more on application roles, see [Authentication and Authorization for FHIR service](../../healthcare-apis/authentication-authorization.md).
18
18
19
-
Three steps in setting up the `$export` operation for the FHIR service-
19
+
There are three steps in setting up the `$export` operation for the FHIR service-
20
20
21
21
- Enable a managed identity for the FHIR service.
22
22
- Configure a new or existing Azure Data Lake Storage Gen2 (ADLS Gen2) account and give permission for the FHIR service to access the account.
23
23
- Set the ADLS Gen2 account as the export destination for the FHIR service.
24
24
25
25
## Enable managed identity for the FHIR service
26
26
27
-
The first step in configuring your environment for FHIR data export is to enable a system-wide managed identity for the FHIR service. This managed identity is used to authenticate the FHIR service to allow access to the ADLS Gen2 account during an `$export` operation. For more information about managed identities in Azure, see [About managed identities for Azure resources](../../active-directory/managed-identities-azure-resources/overview.md).
27
+
The first step in configuring your environment for FHIR data export is to enable a system-wide managed identity for the FHIR service. This managed identity is used to authenticate the FHIR service, allowing access to the ADLS Gen2 account during an `$export` operation. For more information about managed identities in Azure, see [About managed identities for Azure resources](../../active-directory/managed-identities-azure-resources/overview.md).
28
28
29
-
In this step, browse to your FHIR service in the Azure portal and select the **Identity** blade. Set the **Status** option to **On**, and then click **Save**. When the **Yes** and **No** buttons display, select **Yes** to enable the managed identity for the FHIR service. Once the system identity has been enabled, you'll see an **Object (principal) ID** value for your FHIR service.
29
+
In this step, browse to your FHIR service in the Azure portal and select **Identity**. Set the **Status** option to **On**, and then click **Save**. When the **Yes** and **No** buttons display, select **Yes** to enable the managed identity for the FHIR service. Once the system identity has been enabled, you'll see an **Object (principal) ID** value for your FHIR service.
@@ -48,7 +48,7 @@ In this step, browse to your FHIR service in the Azure portal and select the **I
48
48
49
49
6. Select your Azure subscription.
50
50
51
-
7. Select **System-assigned managed identity**, and then select the managed identity that you enabled earlier for your FHIR service.
51
+
7. Select **System-assigned managed identity**, and then select the managed identity that you previously enabled for your FHIR service.
52
52
53
53
8. On the **Review + assign** tab, click **Review + assign** to assign the **Storage Blob Data Contributor** role to your FHIR service.
54
54
@@ -58,36 +58,35 @@ Now you're ready to configure the FHIR service by setting the ADLS Gen2 account
58
58
59
59
## Specify the storage account for FHIR service export
60
60
61
-
The final step is to specify the ADLS Gen2 account that the FHIR service uses when exporting data.
61
+
The final step is to specify the ADLS Gen2 account the FHIR service uses when exporting data.
62
62
63
63
> [!NOTE]
64
64
> In the storage account, if you haven't assigned the **Storage Blob Data Contributor** role to the FHIR service, the `$export` operation will fail.
65
65
66
66
1. Go to your FHIR service settings.
67
67
68
-
2. Select the **Export** blade.
68
+
2. Select **Export**.
69
69
70
70
3. Select the name of the storage account from the list. If you need to search for your storage account, use the **Name**, **Resource group**, or **Region** filters.
71
71
72
72
[](media/export-data/fhir-export-storage.png#lightbox)
73
73
74
-
After you've completed this final configuration step, you're ready to export data from the FHIR service. See [How to export FHIR data](./export-data.md) for details on performing `$export` operations with the FHIR service.
74
+
After you've completed this configuration step, you're ready to export data from the FHIR service. See [How to export FHIR data](./export-data.md) for details on performing `$export` operations with the FHIR service.
75
75
76
76
> [!NOTE]
77
77
> Only storage accounts in the same subscription as the FHIR service are allowed to be registered as the destination for `$export` operations.
78
78
79
79
## Securing the FHIR service `$export` operation
80
80
81
-
For securely exporting from the FHIR service to an ADLS Gen2 account, there are two main options:
81
+
For securely exporting from the FHIR service to an ADLS Gen2 account, there are two options:
82
82
83
83
* Allowing the FHIR service to access the storage account as a Microsoft Trusted Service.
84
84
85
-
* Allowing specific IP addresses associated with the FHIR service to access the storage account.
86
-
This option permits two different configurations depending on whether or not the storage account is in the same Azure region as the FHIR service.
85
+
* Allowing specific IP addresses associated with the FHIR service to access the storage account. This option permits two different configurations depending on whether or not the storage account is in the same Azure region as the FHIR service.
87
86
88
87
### Allowing FHIR service as a Microsoft Trusted Service
89
88
90
-
Go to your ADLS Gen2 account in the Azure portal and select the **Networking** blade. Select **Enabled from selected virtual networks and IP addresses** under the **Firewalls and virtual networks** tab.
89
+
Go to your ADLS Gen2 account in the Azure portal and select **Networking**. Select **Enabled from selected virtual networks and IP addresses** under the **Firewalls and virtual networks** tab.
91
90
92
91
:::image type="content" source="media/export-data/storage-networking-1.png" alt-text="Screenshot of Azure Storage Networking Settings." lightbox="media/export-data/storage-networking-1.png":::
93
92
@@ -97,13 +96,13 @@ Under the **Exceptions** section, select the box **Allow Azure services on the t
97
96
98
97
:::image type="content" source="media/export-data/exceptions.png" alt-text="Allow trusted Microsoft services to access this storage account.":::
99
98
100
-
Next, run the following PowerShell command to install the `Az.Storage` PowerShell module in your local environment. This allows you to configure your Azure storage account(s) using PowerShell.
99
+
Next, run the following PowerShell command to install the `Az.Storage` PowerShell module in your local environment. This allows you to configure your Azure storage accounts using PowerShell.
Now, use the PowerShell command below to set the selected FHIR service instance as a trusted resource for the storage account. Make sure that all listed parameters are defined in your PowerShell environment.
105
+
Now, use the following PowerShell command to set the selected FHIR service instance as a trusted resource for the storage account. Make sure that all listed parameters are defined in your PowerShell environment.
107
106
108
107
You'll need to run the `Add-AzStorageAccountNetworkRule` command as an administrator in your local environment. For more information, see [Configure Azure Storage firewalls and virtual networks](../../storage/common/storage-network-security.md).
109
108
@@ -131,9 +130,9 @@ The storage account is on selected networks and isn't publicly accessible. To se
131
130
132
131
## Next steps
133
132
134
-
In this article, you learned about the three steps in configuring your environment to allow export of data from your FHIR service to an Azure storage account. For more information about Bulk Export capabilities in the FHIR service, see
133
+
In this article, you learned about the three steps in configuring your environment to allow export of data from your FHIR service to an Azure storage account. For more information about Bulk Export capabilities in the FHIR service, see the following.
135
134
136
135
>[!div class="nextstepaction"]
137
136
>[How to export FHIR data](export-data.md)
138
137
139
-
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/fhir/configure-identity-providers.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ ms.author: namalu
13
13
14
14
# Configure multiple service identity providers
15
15
16
-
In addition to [Microsoft Entra ID](/entra/fundamentals/whatis), you can configure up to two additional identity providers for a FHIR service, whether the service already exists or is newly created.
16
+
In addition to [Microsoft Entra ID](/entra/fundamentals/whatis), you can configure up to two additional identity providers for a FHIR® service, whether the service already exists or is newly created.
17
17
18
18
## Identity providers prerequisite
19
19
Identity providers must support OpenID Connect (OIDC), and must be able to issue JSON Web Tokens (JWT) with a `fhirUser` claim, a `azp` or `appid` claim, and an `scp` claim with [SMART on FHIR v1 Scopes](https://www.hl7.org/fhir/smart-app-launch/1.0.0/scopes-and-launch-context/index.html#scopes-for-requesting-clinical-data).
@@ -58,7 +58,7 @@ Add the `smartIdentityProviders` element to the FHIR service `authenticationConf
58
58
59
59
#### Configure the `smartIdentityProviders` array
60
60
61
-
If you don't need any identity providers besides Microsoft Entra ID, set the `smartIdentityProviders` array to null, or omit it from the provisioning request. Otherwise, include at least one valid identity provider configuration object in the array. You can configure up to two additional identity providers.
61
+
If you don't need any identity providers beside Microsoft Entra ID, set the `smartIdentityProviders` array to null, or omit it from the provisioning request. Otherwise, include at least one valid identity provider configuration object in the array. You can configure up to two additional identity providers.
You must include at least one application configuration and can add upto 25 applications in the `applications` array. Each application configuration has values that validate access token claims and an array that defines the permissions for the application to access FHIR resources.
77
+
You must include at least one application configuration and can add up to 25 applications in the `applications` array. Each application configuration has values that validate access token claims, and an array that defines the permissions for the application to access FHIR resources.
78
78
79
79
#### Identify the application with the `clientId` string
80
80
81
-
The identity provider defines the application with a unique identifier called the `clientId` string (or application ID). The FHIR service validates the access token by checking the `authorized party` (azp) or `application id` (appid) claim against the `clientId` string. The FHIR service rejects requests with a `401 Unauthorized` error code if the `clientId` string and the token claim don't match exactly.
81
+
The identity provider defines the application with a unique identifier called the `clientId` string (or application ID). The FHIR service validates the access token by checking the `authorized party` (azp) or `application id` (appid) claim against the `clientId` string. If the `clientId` string and the token claim don't match exactly, the FHIR service rejects the request with a `401 Unauthorized` error code.
82
82
83
83
#### Validate the access token with the `audience` string
84
84
85
-
The `aud` claim in an access token identifies the intended recipient of the token. The `audience` string is the unique identifier for the recipient. The FHIR service validates the access token by checking the `audience` string against the `aud` claim. The FHIR service rejects requests with a `401 Unauthorized` error code if the `audience` string and the `aud` claim don't match exactly.
85
+
The `aud` claim in an access token identifies the intended recipient of the token. The `audience` string is the unique identifier for the recipient. The FHIR service validates the access token by checking the `audience` string against the `aud` claim. If the `audience` string and the `aud` claim don't match exactly, the FHIR service rejects requests with a `401 Unauthorized` error code.
86
86
87
87
#### Specify the permissions with the `allowedDataActions` array
88
88
89
-
Include at least one permission string in the `allowedDataActions` array. You can include any valid permission strings, but avoid duplicates.
89
+
Include at least one permission string in the `allowedDataActions` array. You can include any valid permission strings. Avoid duplicates.
Copy file name to clipboardExpand all lines: articles/healthcare-apis/fhir/configure-import-data.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,10 +11,10 @@ ms.author: kesheth
11
11
12
12
# Configure FHIR import settings
13
13
14
-
This article walks you through the steps to configure settings on the FHIR service for `import` operations. To configure settings, you need to:
14
+
This article walks you through the steps to configure settings on the FHIR® service for `import` operations. To configure settings, you need to:
15
15
16
16
1. Enable a managed identity on the FHIR service.
17
-
1. Create an Azure storage account or use an existing storage account, and then grant permissions to the FHIR service to access it.
17
+
1. Create an Azure storage account or use an existing storage account, and grant permissions for the FHIR service to access it.
18
18
1. Set the import configuration of the FHIR service.
19
19
1. Use one of the options to securely import FHIR data into the FHIR service from an Azure Data Lake Storage Gen2 account.
20
20
@@ -35,7 +35,7 @@ After you enable the managed identity, a system-assigned GUID value appears.
35
35
36
36
## Step 2: Assign permissions to the FHIR service
37
37
38
-
Use the following steps to assign permissions to access the storage account:
38
+
Use the following steps to assign permissions to access the storage account.
39
39
40
40
1. In the storage account, browse to **Access Control (IAM)**.
41
41
2. Select **Add role assignment**. If the option for adding a role assignment is unavailable, ask your Azure administrator to assign you permission to perform this step.
@@ -53,14 +53,13 @@ Now you're ready to select the storage account for import.
53
53
> [!NOTE]
54
54
> If you haven't assigned storage access permissions to the FHIR service, the `import` operation will fail.
55
55
56
-
For this step, you need to get the request URL and JSON body:
56
+
For this step, you need to get the request URL and JSON body.
57
57
58
58
1. In the Azure portal, browse to your FHIR service.
59
59
2. Select **Overview**.
60
60
3. Select **JSON View**.
61
61
4. Select the API version as **2022-06-01** or later.
62
62
63
-
64
63
To specify the Azure storage account in JSON view which is in **READ** mode, you need to use the [REST API](/rest/api/healthcareapis/services/create-or-update) to update the FHIR service.
65
64
66
65
[](media/bulk-import/fhir-json-view.png#lightbox)
@@ -69,7 +68,7 @@ The following steps walk you through setting configurations for initial and incr
69
68
70
69
### Set the import configuration for initial import mode
71
70
72
-
Make the following changes to JSON:
71
+
Make the following changes to JSON.
73
72
74
73
1. In `importConfiguration`, set `enabled` to `true`.
75
74
2. Update `integrationDataStore` with the target storage account name.
@@ -82,7 +81,7 @@ You're now ready to perform initial-mode import by using `import`.
82
81
83
82
### Set the import configuration for incremental import mode
84
83
85
-
Make the following changes to JSON:
84
+
Make the following changes to JSON.
86
85
87
86
1. In `importConfiguration`, set `enabled` to `true`.
88
87
2. Update `integrationDataStore` with the target storage account name.
@@ -105,7 +104,7 @@ To securely import FHIR data into the FHIR service from an Azure Data Lake Stora
105
104
106
105
### Enable the FHIR service as a trusted Microsoft service
107
106
108
-
1. In the Azure portal, go to your Data Lake Storage Gen2 account in the Azure portal.
107
+
1. In the Azure portal, go to your Data Lake Storage Gen2 account.
109
108
110
109
1. On the left menu, select **Networking**.
111
110
@@ -153,9 +152,9 @@ You're now ready to securely import FHIR data from the storage account. The stor
153
152
154
153
## Next steps
155
154
156
-
In this article, you learned how the FHIR service supports the `import` operation and how you can import data into the FHIR service from a storage account. You also learned about the steps for configuring import settings in the FHIR service. For more information about converting data to FHIR, exporting settings to set up a storage account, and moving data to Azure Synapse Analytics, see:
155
+
In this article, you learned how the FHIR service supports the `import` operation, and how you can import data into the FHIR service from a storage account. You also learned about the steps for configuring import settings in the FHIR service. For more information about converting data to FHIR, exporting settings to set up a storage account, and moving data to Azure Synapse Analytics, see:
157
156
158
157
>[!div class="nextstepaction"]
159
158
>[Import FHIR data](import-data.md)
160
159
161
-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
0 commit comments