dicom-anonymization 0.1.2

DICOM anonymization
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

# dicom-anonymization

[![crates.io](https://img.shields.io/crates/v/dicom-anonymization.svg)](https://crates.io/crates/dicom-anonymization)
[![CI](https://github.com/carecoders/dicom-anonymization/actions/workflows/ci.yml/badge.svg)](https://github.com/carecoders/dicom-anonymization/actions/workflows/ci.yml)
[![Documentation](https://docs.rs/dicom-anonymization/badge.svg)](https://docs.rs/dicom-anonymization)

This repository provides a library and binary for anonymizing (or de-identifying) [DICOM](https://dicomstandard.org/) files.

> [!WARNING]
> This is a work in progress. Some major things may still change and not all things may work as expected yet until version 0.5.

The project prioritizes performance, reliability, safety and ease of use.

## Limitations

Only top-level DICOM tags are processed for now, not tags nested inside sequences. This may change in the future.

## Building

```bash
cargo build --release
```

## Usage

See documentation on [docs.rs](https://docs.rs/dicom-anonymization).

### Library

#### Using default configuration

```rust
use std::fs::File;
use dicom_anonymization::Anonymizer;

let file = File::open("tests/data/test.dcm")?;

let anonymizer = Anonymizer::default();
let result = anonymizer.anonymize(file)?;

let output_file = File::create("anonymized.dcm")?;
result.write(output_file)?;
```

#### Using custom configuration

```rust
use std::fs::File;
use dicom_dictionary_std::tags;
use dicom_anonymization::Anonymizer;
use dicom_anonymization::actions::{Action, HashLength};
use dicom_anonymization::config::ConfigBuilder;
use dicom_anonymization::processor::DataElementProcessor;

// default configuration can be customized/overridden
let config = ConfigBuilder::default()
    .uid_root("1.2.840.123".parse().unwrap())
    .remove_private_tags(true)
    .tag_action(tags::PATIENT_NAME, Action::Empty)
    .tag_action(tags::PATIENT_ID, Action::Hash(HashLength::new(16).ok()))
    .tag_action(tags::ACCESSION_NUMBER, Action::Hash(HashLength::new(16).ok()))
    .tag_action(tags::STUDY_DATE, Action::HashDate(tags::PATIENT_ID))
    .tag_action(tags::SERIES_DATE, Action::Remove)
    .tag_action(tags::STUDY_INSTANCE_UID, Action::HashUID)
    .tag_action(tags::SERIES_INSTANCE_UID, Action::HashUID)
    .tag_action(tags::SOP_INSTANCE_UID, Action::HashUID)
    .build();

let processor = DataElementProcessor::new(config);
let anonymizer = Anonymizer::new(processor);

let file = File::open("tests/data/test.dcm")?;
let result = anonymizer.anonymize(file)?;

let mut output = Vec::new();
result.write(&mut output)?;
```

#### Building configuration from scratch

```rust
use dicom_dictionary_std::tags;
use dicom_anonymization::actions::Action;
use dicom_anonymization::config::ConfigBuilder;

let config_from_scratch = ConfigBuilder::new()
    .uid_root("1.2.840.123".parse().unwrap())
    .remove_private_tags(false)
    .tag_action(tags::PATIENT_NAME, Action::Replace("John Doe".into()))
    // ...more config rules...
    .build();
```

### Binary

```bash
$ dcmanon -h
Anonymize DICOM files

Usage: dcmanon [OPTIONS] --input <INPUT_PATH> --output <OUTPUT_PATH>

Options:
  -i, --input <INPUT_PATH>    Input file ('-' for stdin) or directory
  -o, --output <OUTPUT_PATH>  Output file ('-' for stdout) or directory
  -u, --uid-root <UID_ROOT>   UID root (default: '9999')
  -r, --recursive             Recursively look for files in input directory
  -c, --continue              Continue when file found is not DICOM
  -v, --verbose               Show more verbose output
      --exclude <TAGS>        Tags to exclude from anonymization, e.g. "00100020,00080050"
  -h, --help                  Print help
  -V, --version               Print version
```

#### Example

```bash
dcmanon -i tests/data/test.dcm -o anonymized.dcm
```

## Contributing


We welcome contributions from the community. If you are interested in contributing to the project, please read [CONTRIBUTING.md](CONTRIBUTING.md).

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT License ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.