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/convert-data-azure-data-factory.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
-
title: Transform HL7v2 data to FHIR R4 with $convert-data in the FHIR service for Azure Health Data Services.
3
-
description: Learn how to transform HL7v2 data into FHIR R4 by using Azure Data Factory’s $convert-data operation. This article covers prerequisites, configuration, and pipeline creation for seamless data conversion and storage with Azure Data Lake Storage Gen2 capabilities.
2
+
title: Transform HL7v2 data to FHIR R4 with $convert-data in the FHIR service for Azure Health Data Services
3
+
description: Learn how to transform HL7v2 data into FHIR R4 by using Azure Data Factory’s $convert-data operation. Explore prerequisites, configuration, and pipeline creation for data conversion and storage with Azure Data Lake Storage Gen2 capabilities.
4
4
author: msjasteppe
5
5
ms.service: healthcare-apis
6
6
ms.subservice: fhir
7
7
ms.topic: how-to
8
-
ms.date: 05/06/2024
8
+
ms.date: 05/13/2024
9
9
ms.author: jasteppe
10
10
---
11
11
@@ -139,7 +139,7 @@ To configure the pipeline to automatically run whenever a new HL7v2 blob file in
139
139
140
140
1. Select **Author** from the navigation menu. Select the pipeline configured in the previous section and select **Add trigger** and **New/Edit** from the menu bar.
141
141
142
-
:::image type="content" source="media/convert-data/convert-data-with-azure-data-factory/select-add-trigger.png" alt-text="Screenshot showing the Azure Data Factory Add trigger and New/Edit options." lightbox="media/convert-data/convert-data-with-azure-data-factory/select-add-trigger.png":::
142
+
:::image type="content" source="media/convert-data/convert-data-with-azure-data-factory/select-add-trigger.png" alt-text="Screenshot showing the Azure Data Factory add trigger and new or edit options." lightbox="media/convert-data/convert-data-with-azure-data-factory/select-add-trigger.png":::
143
143
144
144
2. In the **Add triggers** panel, select the **Choose trigger** dropdown, and then select **New**.
145
145
3. Enter a **Name** and **Description** for the trigger.
title: Using the FHIR service to export de-identified data
3
-
description: This article describes how to set up and use de-identified export
2
+
title: Export deidentified data from the FHIR service in Azure Health Data Services
3
+
description: Learn to deidentify FHIR data with the FHIR service’s export feature. Use our sample config file for HIPAA Safe Harbor compliance and privacy protection.
4
4
author: expekesheth
5
5
ms.service: healthcare-apis
6
6
ms.subservice: fhir
7
7
ms.topic: reference
8
-
ms.date: 08/30/2022
8
+
ms.date: 05/06/2024
9
9
ms.author: kesheth
10
10
---
11
-
# Exporting de-identified data
11
+
# Export deidentified data
12
12
13
13
> [!NOTE]
14
-
> Results when using the FHIR service's de-identified export will vary based on the nature of the data being exported and what de-id functions are in use. Microsoft is unable to evaluate de-identified export outputs or determine the acceptability for customers' use cases and compliance needs. The FHIR service's de-identified export is not guaranteed to meet any specific legal, regulatory, or compliance requirements.
14
+
> Results when using the FHIR service's deidentified export vary based on the nature of the data being exported and what de-ID functions are in use. Microsoft is unable to evaluate deidentified export outputs or determine the acceptability for your use cases and compliance needs. The FHIR service's deidentified export is not guaranteed to meet any specific legal, regulatory, or compliance requirements.
15
15
16
-
The FHIR service is able to de-identify data on export when running an `$export` operation. For de-identified export, the FHIR service uses the anonymization engine from the [FHIR tools for anonymization](https://github.com/microsoft/FHIR-Tools-for-Anonymization) (OSS) project on GitHub. There's a [sample config file](https://github.com/microsoft/Tools-for-Health-Data-Anonymization/blob/master/docs/FHIR-anonymization.md#sample-configuration-file) to help you get started redacting/transforming FHIR data fields that contain personally identifying information.
16
+
The FHIR® service can deidentify data when you run an `$export` operation. For deidentified export, the FHIR service uses the anonymization engine from the [FHIR tools for anonymization](https://github.com/microsoft/FHIR-Tools-for-Anonymization) (OSS) project on GitHub. There's a [sample config file](https://github.com/microsoft/Tools-for-Health-Data-Anonymization/blob/master/docs/FHIR-anonymization.md#sample-configuration-file) to help you get started redacting/transforming FHIR data fields that contain personally identifying information.
17
17
18
18
## Configuration file
19
19
20
-
The anonymization engine comes with a sample configuration file to help you get started with [HIPAA Safe Harbor Method](https://www.hhs.gov/hipaa/for-professionals/privacy/special-topics/de-identification/index.html#safeharborguidance) de-id requirements. The configuration file is a JSON file with four properties: `fhirVersion`, `processingErrors`, `fhirPathRules`, `parameters`.
20
+
The anonymization engine comes with a sample configuration file to help you get started with [HIPAA Safe Harbor Method](https://www.hhs.gov/hipaa/for-professionals/privacy/special-topics/de-identification/index.html#safeharborguidance) de-ID requirements. The configuration file is a JSON file with four properties: `fhirVersion`, `processingErrors`, `fhirPathRules`, `parameters`.
21
21
*`fhirVersion` specifies the FHIR version for the anonymization engine.
22
-
*`processingErrors` specifies what action to take for any processing errors that may arise during the anonymization. You can _raise_ or _keep_ the exceptions based on your needs.
22
+
*`processingErrors` specifies what action to take for any processing errors that arise during the anonymization. You can _raise_ or _keep_ the exceptions based on your needs.
23
23
*`fhirPathRules` specifies which anonymization method to use. The rules are executed in the order they appear in the configuration file.
24
24
*`parameters` sets more controls for the anonymization behavior specified in _fhirPathRules_.
25
25
@@ -46,44 +46,41 @@ Here's a sample configuration file for FHIR R4:
46
46
}
47
47
```
48
48
49
-
For detailed information on the settings within the configuration file, visit [here](https://github.com/microsoft/Tools-for-Health-Data-Anonymization/blob/master/docs/FHIR-anonymization.md#configuration-file-format).
49
+
For more information, see [FHIR anonymization](https://github.com/microsoft/Tools-for-Health-Data-Anonymization/blob/master/docs/FHIR-anonymization.md#configuration-file-format).
50
50
51
51
## Manage Configuration File in storage account
52
-
You need to create a container for the de-identified export in your ADLS Gen2 account and specify the `<<container_name>>` in the API request as shown. Additionally, you need to place the JSON config file with the anonymization rules inside the container and specify the `<<config file name>>` in the API request.
52
+
You need to create a container for the deidentified export in your ADLS Gen2 account and specify the `<<container_name>>` in the API request as shown. Additionally, you need to place the JSON config file with the anonymization rules inside the container and specify the `<<config file name>>` in the API request.
53
53
54
54
> [!NOTE]
55
55
> It is common practice to name the container `anonymization`. The JSON file within the container is often named `anonymizationConfig.json`.
56
56
57
57
## Manage Configuration File in ACR
58
58
59
-
It's recommended that you host the export configuration files on Azure Container Registry(ACR). It takes the following steps similar as [hosting templates in ACR for $convert-data](convert-data-faq.md#host-your-own-templates).
59
+
We recommend that you host the export configuration files on Azure Container Registry(ACR). It takes the following steps similar as [hosting templates in ACR for $convert-data](convert-data-faq.md#host-your-own-templates).
60
60
1. Push the configuration files to your Azure Container Registry.
61
61
2. Enable Managed Identity on your FHIR service instance.
62
62
3. Provide access of the ACR to the FHIR service Managed Identity.
63
63
4. Register the ACR servers in the FHIR service. You can use the portal to open "Artifacts" under "Transform and transfer data" section to add the ACR server.
64
64
5. Configure ACR firewall for secure access.
65
65
66
-
## Using the `$export` endpoint for de-identifying data
66
+
## Using the `$export` endpoint for deidentifying data
67
67
`https://<<FHIR service base URL>>/$export?_container=<<container_name>>&_anonymizationConfigCollectionReference=<<ACR image reference>>&_anonymizationConfig=<<config file name>>&_anonymizationConfigEtag=<<ETag on storage>>`
68
68
69
69
> [!NOTE]
70
-
> Right now the FHIR service only supports de-identified export at the system level (`$export`).
70
+
> Right now the FHIR service only supports deidentified export at the system level (`$export`).
71
71
72
72
|Query parameter | Example |Optionality| Description|
|_\_container_|exportContainer|Required|Name of container within the configured storage account where the data is exported. |
75
-
|_\_anonymizationConfigCollectionReference_|"myacr.azurecr.io/deidconfigs:default"|Optional|Reference to an OCI image on ACR containing de-id configuration files for de-id export (such as stu3-config.json, r4-config.json). The ACR server of the image should be registered within the FHIR service. (Format: `<RegistryServer>/<imageName>@<imageDigest>`, `<RegistryServer>/<imageName>:<imageTag>`) |
76
-
|_\_anonymizationConfig_|`anonymizationConfig.json`|Required|Name of the configuration file. See the configuration file format [here](https://github.com/microsoft/FHIR-Tools-for-Anonymization#configuration-file-format). If _\_anonymizationConfigCollectionReference_ is provided, we'll search and use this file from the specified image. Otherwise, we'll search and use this file inside a container named **anonymization** within the configured ADLS Gen2 account.|
75
+
|_\_anonymizationConfigCollectionReference_|"myacr.azurecr.io/deidconfigs:default"|Optional|Reference to an OCI image on ACR containing de-ID configuration files for de-ID export (such as stu3-config.json, r4-config.json). The ACR server of the image should be registered within the FHIR service. (Format: `<RegistryServer>/<imageName>@<imageDigest>`, `<RegistryServer>/<imageName>:<imageTag>`) |
76
+
|_\_anonymizationConfig_|`anonymizationConfig.json`|Required|Name of the configuration file. See the configuration file format [here](https://github.com/microsoft/FHIR-Tools-for-Anonymization#configuration-file-format). If _\_anonymizationConfigCollectionReference_ is provided, we search and use this file from the specified image. Otherwise, we search and use this file inside a container named **anonymization** within the configured ADLS Gen2 account.|
77
77
|_\_anonymizationConfigEtag_|"0x8D8494A069489EC"|Optional|Etag of the configuration file, which can be obtained from the blob property in Azure Storage Explorer. Specify this parameter only if the configuration file is stored in Azure storage account. If you use ACR to host the configuration file, you shouldn't include this parameter.|
78
78
79
79
> [!IMPORTANT]
80
-
> Both the raw export and de-identified export operations write to the same Azure storage account specified in the export configuration for the FHIR service. If you have need for multiple de-identification configurations, it is recommended that you create a different container for each configuration and manage user access at the container level.
80
+
> Both the raw export and deidentified export operations write to the same Azure storage account specified in the export configuration for the FHIR service. If you have need for multiple deidentification configurations, it is recommended that you create a different container for each configuration and manage user access at the container level.
81
81
82
82
## Next steps
83
83
84
-
In this article, you've learned how to set up and use the de-identified export feature in the FHIR service. For more information about how to export FHIR data, see
85
-
86
-
>[!div class="nextstepaction"]
87
-
>[Export data](export-data.md)
84
+
Export data(export-data.md)
88
85
89
-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
- name: Migration from Azure API for FHIRLearn to deidentify FHIR data with the FHIR® service’s export feature. Use our sample config file for HIPAA Safe Harbor compliance and privacy protection.
0 commit comments