Test De-id Profile Using the FW De-id Command
Introduction
To avoid uploading personally identifiable information (PII), use the Flywheel Command-Line Interface to test your de-id profile on your computer before you upload it.
This article explains how to use the fw deid test
command to test your de-id profile.
Before you Begin
- Install the CLI: The Flywheel command-line interface (CLI) is an additional Flywheel program used with Command Prompt (Windows) or Terminal (Mac). Install the app and sign in to your Flywheel account.
- Learn more about creating a de-id profile
Instruction Steps
- Open a plain text editor such as TextEdit, Notepad, or Sublime.
- Copy and paste the following command into the editor:
-
Replace the placeholders with your information:
-
SRC
: The path to the folder to test. This data should be the same or similar to the data you want to upload to Flywheel. PROFILE
: The path to file containing the de-id profilePATH
: The path to save test results to on the current machine- Optional flags:
[--session LABEL]
[--subject LABEL]
Example:
fw deid test ~/Documents/TestData ~/Documents/deid_profile.yaml ~/Documents/DeIDLogs --subject deidTest
-
Open the Terminal or Windows Command Prompt
-
Copy and paste your command into Terminal or Windows Command Prompt and hit enter.
-
The Flywheel CLI scans your files.
- Once complete, review the log file named
deid_log.csv
. This gives you a preview of how the DICOM fields would change after de-identification.
Example:
- Adjust your de-id profile until the log file shows that your data will be sufficiently de-identified on upload.
Next Steps
Add your de-id profile to a Flywheel project to automatically de-identify new data or use the CLI to upload data.