All option for masking fields added to config

Author: julianxcarter

README.md

@@ -148,6 +148,18 @@ To mask a property, provide an array of the properties to mask in the `construct
 }
 ```
 
+Alternatively, providing a string with a value of `all` in the `constructorArgs` of the Patient extractor will mask all of the supported properties listed above. The following configuration can be used to mask all properties of the `Patient` resource, rather than listing each individual property:
+
+```bash
+{
+  "label": "patient",
+  "type": "CSVPatientExtractor",
+  "constructorArgs": {
+    "filePath": "./data/patient-information.csv"
+    "mask": "all"
+  }
+}
+```
 ### Extraction Date Range
 
 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.

src/extractors/CSVPatientExtractor.js

@@ -9,6 +9,26 @@ const { getEmptyBundle } = require('../helpers/fhirUtils');
 const { CSVPatientSchema } = require('../helpers/schemas/csv');
 const logger = require('../helpers/logger');
 
+const ALL_SUPPORTED_MASK_FIELDS = [
+  'gender',
+  'mrn',
+  'name',
+  'address',
+  'birthDate',
+  'language',
+  'ethnicity',
+  'birthsex',
+  'race',
+  'telecom',
+  'multipleBirth',
+  'photo',
+  'contact',
+  'generalPractitioner',
+  'managingOrganization',
+  'link',
+];
+
+
 function joinAndReformatData(patientData) {
   logger.debug('Reformatting patient data from CSV into template format');
   // No join needed, just a reformatting
@@ -87,8 +107,10 @@ class CSVPatientExtractor extends BaseCSVExtractor {
     // 3. Generate FHIR Resources
     const bundle = generateMcodeResources('Patient', packagedPatientData);
 
-    // mask fields in the patient data if specified in mask array
-    if (this.mask.length > 0) maskPatientData(bundle, this.mask);
+    // mask specified fields in the patient data
+    if (typeof this.mask === 'string') {
+      maskPatientData(bundle, ALL_SUPPORTED_MASK_FIELDS);
+    } else if (this.mask.length > 0) maskPatientData(bundle, this.mask);
     return bundle;
   }
 }

src/extractors/FHIRPatientExtractor.js

@@ -1,6 +1,25 @@
 const { BaseFHIRExtractor } = require('./BaseFHIRExtractor');
 const { maskPatientData } = require('../helpers/patientUtils.js');
 
+const ALL_SUPPORTED_MASK_FIELDS = [
+  'gender',
+  'mrn',
+  'name',
+  'address',
+  'birthDate',
+  'language',
+  'ethnicity',
+  'birthsex',
+  'race',
+  'telecom',
+  'multipleBirth',
+  'photo',
+  'contact',
+  'generalPractitioner',
+  'managingOrganization',
+  'link',
+];
+
 class FHIRPatientExtractor extends BaseFHIRExtractor {
   constructor({ baseFhirUrl, requestHeaders, version, mask = [] }) {
     super({ baseFhirUrl, requestHeaders, version });
@@ -18,7 +37,10 @@ class FHIRPatientExtractor extends BaseFHIRExtractor {
 
   async get(argumentObject) {
     const bundle = await super.get(argumentObject);
-    if (this.mask.length > 0) maskPatientData(bundle, this.mask);
+    // mask specified fields in the patient data
+    if (typeof this.mask === 'string') {
+      maskPatientData(bundle, ALL_SUPPORTED_MASK_FIELDS);
+    } else if (this.mask.length > 0) maskPatientData(bundle, this.mask);
     return bundle;
   }
 }

src/helpers/configUtils.js

@@ -34,6 +34,10 @@ ajv.addFormat('email-with-name', {
     return emailRegex.test(email.trim().split(' ').pop());
   },
 });
+ajv.addFormat('mask-all', {
+  type: 'string',
+  validate: (string) => string === 'all',
+});
 
 const validator = ajv.addSchema(configSchema, 'config');
 

src/helpers/schemas/config.schema.json

@@ -128,10 +128,18 @@
         },
         "mask": {
           "title": "Masked Fields",
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
+          "oneOf": [
+            {
+              "type": "string",
+              "format": "mask-all"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
         }
       }
     }