Skip to content

Conversation

@rdlasco
Copy link

@rdlasco rdlasco commented Sep 12, 2025

This PR adds a short “HIPAA-safe Quickstart” section to the README.

  • Reminds users not to use real PHI for evaluation.
  • Points to synthetic DICOM from the deid-data package.
  • Provides a tiny Python snippet that loads one sample file and runs detect.
  • Adds safety notes (use synthetic data; verify outputs/logs before sharing).

Scope: documentation only; no behavior change.

Fixes #287

**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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add "HIPAA-safe Quickstart" and clarify --exclude usage

3 participants