How to de-Identify DICOM files using the CLI

Open a plain text editor (for example, Sublime, TextEdit, or Notepad)

Below is an example de-identification profile that uses the.yaml format. To get started, copy and paste the example in to the text editor:

---
# You can give your de-identification profile a name 

profile: Config1

# Indicates where you want to place the de-id log. You will use this log file to preview 
# the de-id updates before uploading

deid-log: ~/Documents/deid_log.csv 

# Sets the filetype to DICOM

dicom:
  
  # Date-increment controls how many days to offset each date field 
  # where the increment-date (shown below) is configured. 
  #Positive values will result in later dates, negative 
  # values will result in earlier dates.
  
  date-increment: -17

  # patient-age-from-birthdate sets the DICOM header as a 3-digit value with a suffix 
  # be 091D, and that same age in months would be 003M. By default, if 
  # the age fits in days, then days will be used,
  # otherwise if it fits in months, then months
  # will be used, otherwise years will be used
  
  patient-age-from-birthdate: true
  
  # Set patient age units as Years. Other options include months (M) and days (D)
  
  patient-age-units: Y

  # The following are field transformations. 
  # Remove, replace-with, increment-date, hash, and hashuid can be used with any DICOM
  # field. Replace name with the DICOM field "keyword" by the DICOM standard
  fields:
    
    # Use remove Remove a dicom field Removes the field from the DICOM entirely. 
    # If removal is not supported then this field will be blank.
    # This example removes PatientID. 
    
    - name: PatientID
      remove: true

    # Replace a dicom field with the value provided. 
    # This example replaces “StationName” with "XXXX" in Flywheel
    
    - name: StationName
      replace-with: XXXX

    # Offsets the date by the number of days defined in
    # the date-increment setting above, preserving the time 
    # and timezone. In this example, StudyDate appears as 17 days earlier
    
    - name: StudyDate
      increment-date: true

    # One-Way hash a dicom field to a unique string
    
    - name: AccessionNumber
      hash: true

     # Replaces a UID field with a hashed version of that 
     # field. The first four nodes (prefix) and last node
     # (suffix) will be preserved, with the middle being
     # replaced by the hashed value
    
    - name: ConcatenationUID
      hashuid: true

To convert the text file in to YAML, save the file with the .yaml extension.

Update the settings as needed for your data.