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/de-identified-export.md
+18-13Lines changed: 18 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,26 +48,31 @@ Here's a sample configuration file for FHIR R4:
48
48
49
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).
50
50
51
-
## Using the `$export` endpoint for de-identifying data
52
-
53
-
The API call below demonstrates how to form a request for de-id on export from the FHIR service.
54
-
55
-
```
56
-
GET https://<<FHIR service base URL>>/$export?_container=<<container_name>>&_anonymizationConfig=<<config file name>>&_anonymizationConfigEtag=<<ETag on storage>>
57
-
```
58
-
59
-
You will 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 above. Additionally, you will need to place the JSON config file with the anonymization rules inside the container and specify the `<<config file name>>` in the API request (see above).
60
-
51
+
## Manage Configuration File in storage account
52
+
You will 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 above. Additionally, you will need to place the JSON config file with the anonymization rules inside the container and specify the `<<config file name>>` in the API request (see below).
61
53
> [!Note]
62
54
> It is common practice to name the container `anonymization`. The JSON file within the container is often named `anonymizationConfig.json`.
63
55
56
+
## Manage Configuration File in ACR
57
+
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.md#host-your-own-templates).
58
+
1. Push the configuration files to your Azure Container Registry.
59
+
2. Enable Managed Identity on your FHIR service instance.
60
+
3. Provide access of the ACR to the FHIR service Managed Identity.
61
+
4. Register the ACR servers in the FHIR service. You can use the portal to open "Artifacts" blade under "Transform and transfer data" section to add the ACR server.
62
+
5. Optionally configure ACR firewall for secure access.
63
+
64
+
## Using the `$export` endpoint for de-identifying data
65
+
`https://<<FHIR service base URL>>/$export?_container=<<container_name>>&_anonymizationConfigCollectionReference=<<ACR image reference>>&_anonymizationConfig=<<config file name>>&_anonymizationConfigEtag=<<ETag on storage>>`
64
66
> [!Note]
65
67
> Right now the FHIR service only supports de-identified export at the system level (`$export`).
66
68
67
69
|Query parameter | Example |Optionality| Description|
|`anonymizationConfig`|`anonymizationConfig.json`|Required for de-identified export |Name of the configuration file. See the configuration file format [here](https://github.com/microsoft/FHIR-Tools-for-Anonymization#configuration-file-format). This file should be kept inside a container named `anonymization` within the configured ADLS Gen2 account. |
70
-
|`anonymizationConfigEtag`|"0x8D8494A069489EC"|Optional for de-identified export|This is the Etag of the configuration file. You can get the Etag from the blob property using Azure Storage Explorer.|
71
+
|_\_container_|exportContainer|Required|Name of container within the configured storage account where the data will be exported. |
72
+
|_\_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>`) |
73
+
|_\_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 will search and use this file from the specified image. Otherwise, we will search and use this file inside a container named **anonymization** within the configured ADLS Gen2 account.|
74
+
|_\_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 should not include this parameter.|
75
+
71
76
72
77
> [!IMPORTANT]
73
78
> 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.
@@ -79,4 +84,4 @@ In this article, you've learned how to set up and use the de-identified export f
79
84
>[!div class="nextstepaction"]
80
85
>[Export data](export-data.md)
81
86
82
-
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
87
+
FHIR® is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
0 commit comments