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-settings-convert-data.md
+23-55Lines changed: 23 additions & 55 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: msjasteppe
5
5
ms.service: healthcare-apis
6
6
ms.subservice: fhir
7
7
ms.topic: how-to
8
-
ms.date: 08/21/2022
8
+
ms.date: 08/22/2022
9
9
ms.author: jasteppe
10
10
---
11
11
@@ -33,7 +33,7 @@ To access and use the default templates for your conversion requests, ensure tha
33
33
>
34
34
> The default templates are provided only to help you get started with your data conversion workflow. These default templates are not intended for production and might change when Microsoft releases updates for the FHIR service. To have consistent data conversion behavior across different versions of the FHIR service, you must do the following:
35
35
>
36
-
> 1. Host your own copy of the templates in an Azure Container Registry instance.
36
+
> 1. Host your own copy of the templates in an [Azure Container Registry](../../container-registry/container-registry-intro.md) (ACR) instance.
37
37
> 2. Register the templates to the FHIR service.
38
38
> 3. Use your registered templates in your API calls.
39
39
> 4. Verify that the conversion behavior meets your requirements.
@@ -104,24 +104,27 @@ In the example code, two example custom fields `customfield_message` and `custom
104
104
105
105
## Host your own templates
106
106
107
-
We recommend that you host your own copy of templates in an Azure Container Registry (ACR) instance. Hosting your own templates and using them for `$convert-data` operations involves the following six steps:
107
+
It's recommended that you host your own copy of templates in an [Azure Container Registry](../../container-registry/container-registry-intro.md) (ACR) instance. ACR can be used to host your custom templates and support with versioning.
108
+
109
+
Hosting your own templates and using them for `$convert-data` operations involves the following seven steps:
108
110
109
111
1.[Create an Azure Container Registry instance](#step-1-create-an-azure-container-registry-instance)
110
112
2.[Push the templates to your Azure Container Registry instance](#step-2-push-the-templates-to-your-azure-container-registry-instance)
111
113
3.[Enable Azure Managed identity in your FHIR service instance](#step-3-enable-azure-managed-identity-in-your-fhir-service-instance)
112
114
4.[Provide Azure Container Registry access to the FHIR service managed identity](#step-4-provide-azure-container-registry-access-to-the-fhir-service-managed-identity)
113
115
5.[Register the Azure Container Registry server in the FHIR service](#step-5-register-the-azure-container-registry-server-in-the-fhir-service)
114
116
6.[Configure the Azure Container Registry firewall for secure access](#step-6-configure-the-azure-container-registry-firewall-for-secure-access)
117
+
7.[Verify the $convert-data operation](#step-7-verify-the-convert-data-operation)
115
118
116
119
### Step 1: Create an Azure Container Registry instance
117
120
118
-
Read the [Introduction to container registries in Azure](../../container-registry/container-registry-intro.md) and follow the instructions for creating your own Azure Container Registry instance. We recommend that you place your Azure Container Registry instance in the same resource group as your FHIR service.
121
+
Read the [Introduction to container registries in Azure](../../container-registry/container-registry-intro.md) and follow the instructions for creating your own ACR instance. We recommend that you place your ACR instance in the same resource group as your FHIR service.
119
122
120
123
### Step 2: Push the templates to your Azure Container Registry instance
121
124
122
-
After you create an Azure Container Registry instance, you can use the **FHIR Converter: Push Templates** command in the [FHIR Converter extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-health-fhir-converter) to push your custom templates to your Azure Container Registry instance. Alternatively, you can use the [Template Management CLI tool](https://github.com/microsoft/FHIR-Converter/blob/main/docs/TemplateManagementCLI.md) for this purpose.
125
+
After you create an ACR instance, you can use the **FHIR Converter: Push Templates** command in the [FHIR Converter extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-health-fhir-converter) to push your custom templates to your ACR instance. Alternatively, you can use the [Template Management CLI tool](https://github.com/microsoft/FHIR-Converter/blob/main/docs/TemplateManagementCLI.md) for this purpose.
123
126
124
-
To maintain different versions of custom templates in your ACR, you may push the image containing your custom templates into your ACR instance with different image tags.
127
+
To maintain different versions of custom templates in your Azure Container Registry, you may push the image containing your custom templates into your ACR instance with different image tags.
125
128
* For more information about ACR registries, repositories, and artifacts, see [About registries, repositories, and artifacts](../../container-registry/container-registry-concepts.md).
126
129
* For more information about image tag best practices, see [Recommendations for tagging and versioning container images](../../container-registry/container-registry-image-tag-version.md).
127
130
@@ -159,7 +162,7 @@ For more information about assigning roles in the Azure portal, see [Azure built
159
162
160
163
### Step 5: Register the Azure Container Registry server in the FHIR service
161
164
162
-
You can register the Azure Container Registry server by using the Azure portal.
165
+
You can register the ACR server by using the Azure portal.
163
166
164
167
To use the Azure portal:
165
168
@@ -169,62 +172,27 @@ To use the Azure portal:
169
172
170
173
:::image type="content" source="media/convert-data/configure-settings-convert-data/fhir-acr-add-registry.png" alt-text="Screenshot of the Artifacts screen for registering an Azure Container Registry with a FHIR service." lightbox="media/convert-data/configure-settings-convert-data/fhir-acr-add-registry.png":::
171
174
172
-
You can register up to 20 Azure Container Registry servers in the FHIR service.
175
+
You can register up to 20 ACR servers in the FHIR service.
173
176
174
177
> [!NOTE]
175
178
> It might take a few minutes for the registration to take effect.
176
179
177
180
### Step 6: Configure the Azure Container Registry firewall for secure access
178
181
179
-
1. In the Azure portal, on the left pane, select **Networking** for the Azure Container Registry instance.
180
-
181
-
:::image type="content" source="media/convert-data/configure-settings-convert-data/networking-container-registry.png" alt-text="Screenshot of the Networking screen for configuring an Azure Container Registry firewall." lightbox="media/convert-data/configure-settings-convert-data/networking-container-registry.png":::
182
-
183
-
2. On the **Public access** tab, select **Selected networks**.
184
-
185
-
3. In the **Firewall** section, specify the IP address in the **Address range** box.
186
-
187
-
Add IP ranges to allow access from the Internet or your on-premises networks.
182
+
There are many methods for securing ACR using the built-in firewall depending on your particular use case.
188
183
189
-
The following table lists the IP addresses for the Azure regions where the FHIR service is available:
184
+
*[Connect privately to an Azure container registry using Azure Private Link](../../container-registry/container-registry-private-link.md)
185
+
*[Configure public IP network rules](../../container-registry/container-registry-access-selected-networks.md)
186
+
*[Azure Container Registry mitigating data exfiltration with dedicated data endpoints](../../container-registry/container-registry-dedicated-data-endpoints.md)
187
+
*[Restrict access to a container registry using a service endpoint in an Azure virtual network](../../container-registry/container-registry-vnet.md)
188
+
*[Allow trusted services to securely access a network-restricted container registry](../../container-registry/allow-access-trusted-services.md)
189
+
*[Configure rules to access an Azure container registry behind a firewall](../../container-registry/container-registry-firewall-access-rules.md)
190
+
*[Azure IP Ranges and Service Tags – Public Cloud](https://www.microsoft.com/download/details.aspx?id=56519)
190
191
191
-
| Azure region | Public IP address |
192
-
|:---------------------|:------------------|
193
-
| Australia East | 20.53.47.210 |
194
-
| Brazil South | 191.238.72.227 |
195
-
| Canada Central | 20.48.197.161 |
196
-
| Central India | 20.192.47.66 |
197
-
| East US | 20.62.134.242, 20.62.134.244, 20.62.134.245 |
198
-
| East US 2 | 20.62.60.115, 20.62.60.116, 20.62.60.117 |
199
-
| France Central | 51.138.211.19 |
200
-
| Germany North | 51.116.60.240 |
201
-
| Germany West Central | 20.52.88.224 |
202
-
| Japan East | 20.191.167.146 |
203
-
| Japan West | 20.189.228.225 |
204
-
| Korea Central | 20.194.75.193 |
205
-
| North Central US | 52.162.111.130, 20.51.0.209 |
206
-
| North Europe | 52.146.137.179 |
207
-
| Qatar Central | 20.21.36.225 |
208
-
| South Africa North | 102.133.220.199 |
209
-
| South Central US | 20.65.134.83 |
210
-
| Southeast Asia | 20.195.67.208 |
211
-
| Sweden Central | 51.12.28.100 |
212
-
| Switzerland North | 51.107.247.97 |
213
-
| UK South | 51.143.213.211 |
214
-
| UK West | 51.140.210.86 |
215
-
| West Central US | 13.71.199.119 |
216
-
| West Europe | 20.61.103.243, 20.61.103.244 |
217
-
| West US 2 | 20.51.13.80, 20.51.13.84, 20.51.13.85 |
218
-
| West US 3 | 20.150.245.165 |
219
-
220
-
You can also completely disable public access to your Azure Container Registry instance while still allowing access from your FHIR service. To do so:
221
-
222
-
1. In the Azure portal container registry, select **Networking**.
223
-
2. Select the **Public access** tab, select **Disabled**, and then select **Allow trusted Microsoft services to access this container registry**.
224
-
225
-
:::image type="content" source="media/convert-data/configure-settings-convert-data/configure-private-network-container-registry.png" alt-text="Screenshot of the Networking option for disabling public network access to an Azure Container Registry instance." lightbox="media/convert-data/configure-settings-convert-data/configure-private-network-container-registry.png":::
192
+
> [!NOTE]
193
+
> The FHIR service has been registered as a trusted Microsoft service with Azure Container Registry.
226
194
227
-
### Verify the $convert-data operation
195
+
### Step 7: Verify the $convert-data operation
228
196
229
197
Make a call to the `$convert-data` operation by specifying your template reference in the `templateCollectionReference` parameter:
230
198
@@ -234,7 +202,7 @@ You should receive a `Bundle` response that contains the health data converted i
234
202
235
203
## Next steps
236
204
237
-
In this article, you've learned how to configure settings for `$convert-data`for converting health data into FHIR by using the FHIR service in Azure Health Data Services.
205
+
In this article, you've learned how to configure the settings for `$convert-data`to begin converting various health data formats into the FHIR format.
0 commit comments