Skip to content

Commit a5b43f5

Browse files
committed
Add README section about masked properties
1 parent 56ea39e commit a5b43f5

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,23 @@ Users can specify a different location for the file by using the `--run-log-file
127127
node src/cli/cli.js --run-log-filepath path/to/file.json
128128
```
129129

130+
### Masking Patient Data
131+
132+
Currently, patient data can be masked within the extracted `Patient` resource. When masked, the value of the field will be replaced with a [Data Absent Reason extension](https://www.hl7.org/fhir/extension-data-absent-reason.html) with the code `masked`.
133+
Patient properties that can be masked are: `gender`, `mrn`, `name`, `address`, `birthDate`, `language`, `ethnicity`, `birthsex`, and `race`.
134+
To mask a property, provide an array of the properties to mask in the `constructorArgs` of the Patient extractor. For example, the following configuration can be used to mask `address` and `birthDate`:
135+
136+
```bash
137+
{
138+
"label": "patient",
139+
"type": "CSVPatientExtractor",
140+
"constructorArgs": {
141+
"filePath": "./data/patient-information.csv"
142+
"mask": ["address", "birthDate"]
143+
}
144+
}
145+
```
146+
130147
### Extraction Date Range
131148

132149
The mCODE Extraction Client will extract all data that is provided in the CSV files by default, regardless of any dates associated with each row of data. It is recommended that any required date filtering is performed outside of the scope of this client.

0 commit comments

Comments
 (0)