Skip to content

Commit bfac997

Browse files
authored
Merge pull request #180045 from ginalee-dotcom/patch-9
Update de-identified-export.md
2 parents 4323dd1 + ac71078 commit bfac997

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

articles/healthcare-apis/data-transformation/de-identified-export.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,41 @@ ms.author: ranku
1313
> [!Note]
1414
> Results when using the de-identified export will vary based on factors such as data inputted, and functions selected by the customer. Microsoft is unable to evaluate the de-identified export outputs or determine the acceptability for customer's use cases and compliance needs. The de-identified export is not guaranteed to meet any specific legal, regulatory, or compliance requirements.
1515
16-
The $export command can also be used to export de-identified data from the FHIR server. It uses the anonymization engine from [FHIR tools for anonymization](https://github.com/microsoft/FHIR-Tools-for-Anonymization), and takes anonymization config details in query parameters. You can create your own anonymization config file or use the [sample config file](https://github.com/microsoft/FHIR-Tools-for-Anonymization#sample-configuration-file-for-hipaa-safe-harbor-method) for HIPAA Safe Harbor method as a starting point.
16+
The $export command can also be used to export de-identified data from the FHIR server. It uses the anonymization engine from [FHIR tools for anonymization](https://github.com/microsoft/FHIR-Tools-for-Anonymization), and takes anonymization config details in query parameters. You can create your own anonymization config file or use the [sample config file](https://github.com/microsoft/Tools-for-Health-Data-Anonymization/blob/master/docs/FHIR-anonymization.md#sample-configuration-file) for HIPAA Safe Harbor method as a starting point.
1717

18+
## Configuration file
19+
20+
The anonymization engine comes with a sample configuration file to help meet the requirements of HIPAA Safe Harbor Method. The configuration file is a JSON file with 4 sections: `fhirVersion`, `processingErrors`, `fhirPathRules`, `parameters`.
21+
* `fhirVersion` specifies the FHIR version for the anonymization engine.
22+
* `processingErrors` specifies what action to take for the processing errors that may arise during the anonymization. You can _raise_ or _keep_ the exceptions based on your needs.
23+
* `fhirPathRules` specifies which anonymization method is to be used. The rules are executed in the order of appearance in the configuration file.
24+
* `parameters` sets rules for the anonymization behaviors specified in _fhirPathRules_.
25+
26+
Here is a sample configuration file for R4:
27+
28+
```json
29+
{
30+
"fhirVersion": "R4",
31+
"processingError":"raise",
32+
"fhirPathRules": [
33+
{"path": "nodesByType('Extension')", "method": "redact"},
34+
{"path": "Organization.identifier", "method": "keep"},
35+
{"path": "nodesByType('Address').country", "method": "keep"},
36+
{"path": "Resource.id", "method": "cryptoHash"},
37+
{"path": "nodesByType('Reference').reference", "method": "cryptoHash"},
38+
{"path": "Group.name", "method": "redact"}
39+
],
40+
"parameters": {
41+
"dateShiftKey": "",
42+
"cryptoHashKey": "",
43+
"encryptKey": "",
44+
"enablePartialAgesForRedact": true
45+
}
46+
}
47+
```
48+
49+
For more detailed information on each of these 4 sections of the configuration file, please check [here](https://github.com/microsoft/Tools-for-Health-Data-Anonymization/blob/master/docs/FHIR-anonymization.md#configuration-file-format).
50+
## Using $export command for the de-identified data
1851
`https://<<FHIR service base URL>>/$export?_container=<<container_name>>&_anonymizationConfig=<<config file name>>&_anonymizationConfigEtag=<<ETag on storage>>`
1952

2053
> [!Note]

0 commit comments

Comments
 (0)