Skip to content

Commit e10647e

Browse files
Merge pull request #286273 from KendalBond007/FHIReditsBatch3_Sep24
FHIReditsBatch3_Sep24
2 parents 6a21bfc + 346e571 commit e10647e

File tree

4 files changed

+53
-55
lines changed

4 files changed

+53
-55
lines changed

articles/healthcare-apis/fhir/configure-export-data.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@ ms.author: kesheth
1212

1313
# Configure export settings and set up a storage account
1414

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.
1616

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).
1818

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-
2020

2121
- Enable a managed identity for the FHIR service.
2222
- Configure a new or existing Azure Data Lake Storage Gen2 (ADLS Gen2) account and give permission for the FHIR service to access the account.
2323
- Set the ADLS Gen2 account as the export destination for the FHIR service.
2424

2525
## Enable managed identity for the FHIR service
2626

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).
2828

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.
3030

3131
[![Enable Managed Identity](media/export-data/fhir-mi-enabled.png)](media/export-data/fhir-mi-enabled.png#lightbox)
3232

@@ -48,7 +48,7 @@ In this step, browse to your FHIR service in the Azure portal and select the **I
4848

4949
6. Select your Azure subscription.
5050

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.
5252

5353
8. On the **Review + assign** tab, click **Review + assign** to assign the **Storage Blob Data Contributor** role to your FHIR service.
5454

@@ -58,36 +58,35 @@ Now you're ready to configure the FHIR service by setting the ADLS Gen2 account
5858

5959
## Specify the storage account for FHIR service export
6060

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.
6262

6363
> [!NOTE]
6464
> In the storage account, if you haven't assigned the **Storage Blob Data Contributor** role to the FHIR service, the `$export` operation will fail.
6565
6666
1. Go to your FHIR service settings.
6767

68-
2. Select the **Export** blade.
68+
2. Select **Export**.
6969

7070
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.
7171

7272
[![Screen shot showing user interface of FHIR Export Storage.](media/export-data/fhir-export-storage.png)](media/export-data/fhir-export-storage.png#lightbox)
7373

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.
7575

7676
> [!NOTE]
7777
> Only storage accounts in the same subscription as the FHIR service are allowed to be registered as the destination for `$export` operations.
7878
7979
## Securing the FHIR service `$export` operation
8080

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:
8282

8383
* Allowing the FHIR service to access the storage account as a Microsoft Trusted Service.
8484

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.
8786

8887
### Allowing FHIR service as a Microsoft Trusted Service
8988

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.
9190

9291
:::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":::
9392

@@ -97,13 +96,13 @@ Under the **Exceptions** section, select the box **Allow Azure services on the t
9796

9897
:::image type="content" source="media/export-data/exceptions.png" alt-text="Allow trusted Microsoft services to access this storage account.":::
9998

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.
101100

102101
```PowerShell
103102
Install-Module Az.Storage -Repository PsGallery -AllowClobber -Force
104103
```
105104

106-
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.
107106

108107
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).
109108

@@ -131,9 +130,9 @@ The storage account is on selected networks and isn't publicly accessible. To se
131130

132131
## Next steps
133132

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.
135134

136135
>[!div class="nextstepaction"]
137136
>[How to export FHIR data](export-data.md)
138137
139-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
138+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/fhir/configure-identity-providers.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: namalu
1313

1414
# Configure multiple service identity providers
1515

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.
1717

1818
## Identity providers prerequisite
1919
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
5858

5959
#### Configure the `smartIdentityProviders` array
6060

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.
6262

6363
#### Specify the `authority`
6464

@@ -74,19 +74,19 @@ https://yourIdentityProvider.com/authority/v2.0/.well-known/openid-configuration
7474

7575
#### Configure the `applications` array
7676

77-
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.
7878

7979
#### Identify the application with the `clientId` string
8080

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.
8282

8383
#### Validate the access token with the `audience` string
8484

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.
8686

8787
#### Specify the permissions with the `allowedDataActions` array
8888

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.
9090

9191
| **Valid permission string** | **Description** |
9292
|---|---|

articles/healthcare-apis/fhir/configure-import-data.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ ms.author: kesheth
1111

1212
# Configure FHIR import settings
1313

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:
1515

1616
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.
1818
1. Set the import configuration of the FHIR service.
1919
1. Use one of the options to securely import FHIR data into the FHIR service from an Azure Data Lake Storage Gen2 account.
2020

@@ -35,7 +35,7 @@ After you enable the managed identity, a system-assigned GUID value appears.
3535

3636
## Step 2: Assign permissions to the FHIR service
3737

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.
3939

4040
1. In the storage account, browse to **Access Control (IAM)**.
4141
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.
5353
> [!NOTE]
5454
> If you haven't assigned storage access permissions to the FHIR service, the `import` operation will fail.
5555
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.
5757

5858
1. In the Azure portal, browse to your FHIR service.
5959
2. Select **Overview**.
6060
3. Select **JSON View**.
6161
4. Select the API version as **2022-06-01** or later.
6262

63-
6463
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.
6564

6665
[![Screenshot of selections for opening the JSON view.](media/bulk-import/fhir-json-view.png)](media/bulk-import/fhir-json-view.png#lightbox)
@@ -69,7 +68,7 @@ The following steps walk you through setting configurations for initial and incr
6968

7069
### Set the import configuration for initial import mode
7170

72-
Make the following changes to JSON:
71+
Make the following changes to JSON.
7372

7473
1. In `importConfiguration`, set `enabled` to `true`.
7574
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`.
8281

8382
### Set the import configuration for incremental import mode
8483

85-
Make the following changes to JSON:
84+
Make the following changes to JSON.
8685

8786
1. In `importConfiguration`, set `enabled` to `true`.
8887
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
105104

106105
### Enable the FHIR service as a trusted Microsoft service
107106

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.
109108

110109
1. On the left menu, select **Networking**.
111110

@@ -153,9 +152,9 @@ You're now ready to securely import FHIR data from the storage account. The stor
153152

154153
## Next steps
155154

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:
157156

158157
>[!div class="nextstepaction"]
159158
>[Import FHIR data](import-data.md)
160159
161-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
160+
[!INCLUDE [FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

0 commit comments

Comments
 (0)