Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,35 @@ These are basic Python based tools for working with medical images and text, spe
The cleaning method used here mirrors the one by CTP in that we can identify images based on known
locations. We are looking for collaborators to develop and validate an OCR cleaning method! Please reach out if you would like to help work on this.

## HIPAA-safe Quickstart (use synthetic data only)

**Never test with real Protected Health Information (PHI).** Start with synthetic DICOM files so you can practice safely.

Install:
pip install deid deid-data pydicom
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason to not put these sections into the documentation in docs?

For code sections, you'll want to put in code blocks.


Minimal check in Python (loads one synthetic DICOM file):
from deid.data import get_dataset
from deid.dicom import get_files, DicomCleaner

# synthetic sample dataset name: "dicom-cookies"
data_dir = get_dataset("dicom-cookies")
test_file = next(get_files(data_dir))

cleaner = DicomCleaner() # create a simple cleaner
cleaner.detect(test_file) # analyze for potential burned-in PHI regions
# cleaner.clean(...) # optional: perform cleaning based on a recipe
# cleaner.save_dicom(...) # optional: save a cleaned copy

Notes:

- Use only synthetic datasets during evaluation (e.g., "dicom-cookies").
- Before sharing outputs or logs, verify they don’t contain identifiers.

## Installation

### Local

For the stable release, install via pip:

```bash
Expand All @@ -35,4 +60,5 @@ docker run pydicom/deid --help
```

## Issues

If you have an issue, or want to request a feature, please do so on our [issues board](https://www.github.com/pydicom/deid/issues).