Skip to content

Commit efd1a47

Browse files
v-regandownerv-regandowner
authored
Merge pull request #230110 from irenepjoseph/patch-2
Update convert-data.md
2 parents b72df7d + 978aebe commit efd1a47

File tree

1 file changed

+38
-27
lines changed

1 file changed

+38
-27
lines changed

‎articles/healthcare-apis/azure-api-for-fhir/convert-data.md

Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: Data conversion for Azure API for FHIR
33
description: Use the $convert-data endpoint and customize-converter templates to convert data in Azure API for FHIR.
44
services: healthcare-apis
5-
author: RuiyiC
5+
author: irenepjoseph
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: overview
9-
ms.date: 06/03/2022
10-
ms.author: ruiyichen
9+
ms.date: 03/09/2023
10+
ms.author: irenejoseph
1111
---
1212

1313
# Converting your data to FHIR for Azure API for FHIR
@@ -21,7 +21,7 @@ Currently the `$convert-data` custom endpoint supports `four` types of data conv
2121
|C-CDA | FHIR |
2222
|HL7v2 | FHIR|
2323
|JSON | FHIR|
24-
|FHIR STU3 | FHIR R4 **(new!)**|
24+
|FHIR STU3 | FHIR R4 |
2525

2626

2727
> [!NOTE]
@@ -40,8 +40,11 @@ $convert-data takes a [Parameter](http://hl7.org/fhir/parameters.html) resource
4040
| ----------- | ----------- | ----------- |
4141
| inputData | Data to be converted. | For `Hl7v2`: string <br> For `Ccda`: XML <br> For `Json`: JSON <br> For `FHIR STU3`: JSON|
4242
| inputDataType | Data type of input. | ```HL7v2```, ``Ccda``, ``Json``, ``Fhir``|
43-
| templateCollectionReference | Reference to an [OCI image ](https://github.com/opencontainers/image-spec) template collection on [Azure Container Registry (ACR)](https://azure.microsoft.com/services/container-registry/). It's the image containing Liquid templates to use for conversion. It can be a reference either to the default templates or a custom template image that is registered within the FHIR service. See below to learn about customizing the templates, hosting those on ACR, and registering to the FHIR service. | For ***default/sample*** templates: <br> **HL7v2** templates: <br>```microsofthealth/fhirconverter:default``` <br>``microsofthealth/hl7v2templates:default``<br> **C-CDA** templates: <br> ``microsofthealth/ccdatemplates:default`` <br> **JSON** templates: <br> ``microsofthealth/jsontemplates:default`` <br> **FHIR-STU3** templates: <br> ``microsofthealth/stu3tor4templates:default`` <br><br> For ***custom*** templates: <br> \<RegistryServer\>/\<imageName\>@\<imageDigest\>, \<RegistryServer\>/\<imageName\>:\<imageTag\> |
44-
| rootTemplate | The root template to use while transforming the data. | For **HL7v2**:<br> "ADT_A01", "ADT_A02", "ADT_A03", "ADT_A04", "ADT_A05", "ADT_A08", "ADT_A11", "ADT_A13", "ADT_A14", "ADT_A15", "ADT_A16", "ADT_A25", "ADT_A26", "ADT_A27", "ADT_A28", "ADT_A29", "ADT_A31", "ADT_A47", "ADT_A60", "OML_O21", "ORU_R01", "ORM_O01", "VXU_V04", "SIU_S12", "SIU_S13", "SIU_S14", "SIU_S15", "SIU_S16", "SIU_S17", "SIU_S26", "MDM_T01", "MDM_T02"<br><br> For **C-CDA**:<br> "CCD", "ConsultationNote", "DischargeSummary", "HistoryandPhysical", "OperativeNote", "ProcedureNote", "ProgressNote", "ReferralNote", "TransferSummary" <br><br> For **JSON**: <br> "ExamplePatient", "Stu3ChargeItem" <br><br> **For FHIR STU3 to R4**": <br>Name of the root template that is the same as the STU3 resource name e.g., "Patient", "Observation", "Organization". |
43+
| templateCollectionReference | Reference to an [OCI image ](https://github.com/opencontainers/image-spec) template collection on [Azure Container Registry (ACR)](https://azure.microsoft.com/services/container-registry/). It's the image containing Liquid templates to use for conversion. It can be a reference either to the default templates or a custom template image that is registered within the FHIR service. See below to learn about customizing the templates, hosting those on ACR, and registering to the FHIR service. | For ***default/sample*** templates: <br> **HL7v2** templates: <br>```microsofthealth/fhirconverter:default``` <br>``microsofthealth/hl7v2templates:default``<br> **C-CDA** templates: <br> ``microsofthealth/ccdatemplates:default`` <br> **JSON** templates: <br> ``microsofthealth/jsontemplates:default`` <br> **FHIR STU3** templates: <br> ``microsofthealth/stu3tor4templates:default`` <br><br> For ***custom*** templates: <br> \<RegistryServer\>/\<imageName\>@\<imageDigest\>, \<RegistryServer\>/\<imageName\>:\<imageTag\> |
44+
| rootTemplate | The root template to use while transforming the data. | For **HL7v2**:<br> "ADT_A01", "ADT_A02", "ADT_A03", "ADT_A04", "ADT_A05", "ADT_A08", "ADT_A11", "ADT_A13", "ADT_A14", "ADT_A15", "ADT_A16", "ADT_A25", "ADT_A26", "ADT_A27", "ADT_A28", "ADT_A29", "ADT_A31", "ADT_A47", "ADT_A60", "OML_O21", "ORU_R01", "ORM_O01", "VXU_V04", "SIU_S12", "SIU_S13", "SIU_S14", "SIU_S15", "SIU_S16", "SIU_S17", "SIU_S26", "MDM_T01", "MDM_T02"<br><br> For **C-CDA**:<br> "CCD", "ConsultationNote", "DischargeSummary", "HistoryandPhysical", "OperativeNote", "ProcedureNote", "ProgressNote", "ReferralNote", "TransferSummary" <br><br> For **JSON**: <br> "ExamplePatient", "Stu3ChargeItem" <br><br> **FHIR STU3**": <br> STU3 Resource Name e.g., "Patient", "Observation", "Organization". |
45+
46+
> [!NOTE]
47+
> FHIR STU3 to R4 templates are "diff" Liquid templates that provide mappings of field differences only between STU3 resource and its equivalent resource in FHIR R4 standard.Some of the STU3 resources are renamed or removed from R4. Please refer to [Resource differences and constraints for STU3 to R4 conversion](https://github.com/microsoft/FHIR-Converter/blob/main/docs/Stu3R4-resources-differences.md).
4548
4649
> [!NOTE]
4750
> JSON templates are sample templates for use, not "default" templates that adhere to any pre-defined JSON message types. JSON doesn't have any standardized message types, unlike HL7v2 messages or C-CDA documents. Therefore, instead of default templates we provide you with some sample templates that you can use as a starting guide for your own customized templates.
@@ -104,6 +107,9 @@ $convert-data takes a [Parameter](http://hl7.org/fhir/parameters.html) resource
104107

105108
You can use the [FHIR Converter extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-health-fhir-converter) for Visual Studio Code to customize the templates as per your needs. The extension provides an interactive editing experience, and makes it easy to download Microsoft-published templates and sample data. Refer to the documentation in the extension for more details.
106109

110+
> [!NOTE]
111+
> FHIR Converter extension for Visual Studio Code is available for HL7v2, C-CDA and JSON Liquid templates. FHIR STU3 to R4 Liquid templates are currently not supported.
112+
107113
## Host and use templates
108114

109115
It's recommended that you host your own copy of templates on ACR. There are four steps involved in hosting your own copy of templates and using those in the $convert-data operation:
@@ -183,27 +189,32 @@ In the table below, you'll find the IP address for the Azure region where the Az
183189

184190
|**Azure Region** |**Public IP Address** |
185191
|:----------------------|:-------------------|
186-
| Australia East | 20.53.44.80 |
187-
| Canada Central | 20.48.192.84 |
188-
| Central US | 52.182.208.31 |
189-
| East US | 20.62.128.148 |
190-
| East US 2 | 20.49.102.228 |
191-
| East US 2 EUAP | 20.39.26.254 |
192-
| Germany North | 51.116.51.33 |
193-
| Germany West Central | 51.116.146.216 |
194-
| Japan East | 20.191.160.26 |
195-
| Korea Central | 20.41.69.51 |
196-
| North Central US | 20.49.114.188 |
197-
| North Europe | 52.146.131.52 |
198-
| South Africa North | 102.133.220.197 |
199-
| South Central US | 13.73.254.220 |
200-
| Southeast Asia | 23.98.108.42 |
201-
| Switzerland North | 51.107.60.95 |
202-
| UK South | 51.104.30.170 |
203-
| UK West | 51.137.164.94 |
204-
| West Central US | 52.150.156.44 |
205-
| West Europe | 20.61.98.66 |
206-
| West US 2 | 40.64.135.77 |
192+
| Australia East | 20.53.47.210 |
193+
| Brazil South | 191.238.72.227 |
194+
| Canada Central | 20.48.197.161 |
195+
| Central India | 20.192.47.66 |
196+
| East US | 20.62.134.242, 20.62.134.244, 20.62.134.245 |
197+
| East US 2 | 20.62.60.115, 20.62.60.116, 20.62.60.117 |
198+
| France Central | 51.138.211.19 |
199+
| Germany North | 51.116.60.240 |
200+
| Germany West Central | 20.52.88.224 |
201+
| Japan East | 20.191.167.146 |
202+
| Japan West | 20.189.228.225 |
203+
| Korea Central | 20.194.75.193 |
204+
| North Central US | 52.162.111.130, 20.51.0.209 |
205+
| North Europe | 52.146.137.179 |
206+
| Qatar Central | 20.21.36.225 |
207+
| South Africa North | 102.133.220.199 |
208+
| South Central US | 20.65.134.83 |
209+
| Southeast Asia | 20.195.67.208 |
210+
| Sweden Central | 51.12.28.100 |
211+
| Switzerland North | 51.107.247.97 |
212+
| UK South | 51.143.213.211 |
213+
| UK West | 51.140.210.86 |
214+
| West Central US | 13.71.199.119 |
215+
| West Europe | 20.61.103.243, 20.61.103.244 |
216+
| West US 2 | 20.51.13.80, 20.51.13.84, 20.51.13.85 |
217+
| West US 3 | 20.150.245.165 |
207218

208219

209220
> [!NOTE]

0 commit comments

Comments
 (0)