Skip to main content

Guardrails for AI input/output validation in healthcare, with DICOM support

Project description

Healthcare AI Guardrails

PyPI Python Versions CI License

Lightweight validation guardrails for AI model inputs/outputs in healthcare workflows, with first-class DICOM support.

Features

  • Declarative YAML spec for checks on input and output data
  • Built-in validators: numeric ranges, choices, required fields
  • Specific DICOM validators: patient age, modality, patient sex, patient position, slice thickness, pixel spacing, image orientation, SOP Class UID, BodyPartExamined, PhotometricInterpretation, pixel intensity range, KVP, X-Ray Tube Current, Exposure Time, Protocol Name, and RT Structure Set ROI presence.
  • Generic DICOM validators: check if a tag's value is in a list, check a tag's value representation (VR), and check if a tag's numeric value is within a range.
  • Output structure validation via JSON Schema
  • Simple Python API and CLI (hc-guardrails)

Install (users)

Install from PyPI:

pip install healthcare-ai-guardrails

This installs the Python API and a CLI named hc-guardrails.

Quick CLI check:

hc-guardrails examples/spec.example.yaml examples/output.sample.json --mode output

If you’re validating DICOM, pydicom and numpy are already included as dependencies.

Install (contributors)

Dev install:

python -m venv .venv
source .venv/bin/activate
pip install -e .

With uv (fast Python package manager):

curl -LsSf https://astral.sh/uv/install.sh | sh
# create and use a virtualenv automatically
uv venv
source .venv/bin/activate
uv pip install -e .

Quick start

Spec (examples/spec.example.yaml):

  • Input: verify DICOM patient age in [18, 90], modality in {CT, MR}, patient sex in {M,F,O}, slice thickness/pixel spacing ranges, and sane image orientation
  • Output: ensure probability ∈ [0, 1] and match a JSON Schema

Run on a DICOM file:

hc-guardrails examples/spec.example.yaml path/to/file.dcm --mode input

Run on a JSON output:

hc-guardrails examples/spec.example.yaml path/to/output.json --mode output

Python API

from healthcare_ai_guardrails import GuardrailRunner
from healthcare_ai_guardrails.validators.dicom import (
    DICOMPatientAgeCheck,
    DICOMModalityCheck,
    DICOMPatientSexCheck,
    DICOMPatientPositionCheck,
    DICOMSliceThicknessCheck,
    DICOMPixelSpacingCheck,
    DICOMImageOrientationCheck,
    DICOMKVPCheck,
    DICOMTubeCurrentCheck,
    DICOMExposureTimeCheck,
    DICOMProtocolNameCheck,
    DICOMRTStructureCheck,
)
from healthcare_ai_guardrails.validators.generic_dicom import (
    DICOMGenericNumericRangeCheck,
    DICOMGenericValueInListCheck,
    DICOMGenericTagTypeCheck,
)
import pydicom

runner = GuardrailRunner(
    [
        # Specific Validators
        DICOMPatientAgeCheck(min_years=18, max_years=90),
        DICOMModalityCheck(allowed_modalities=["CT", "MR"]),
        DICOMPatientSexCheck(allowed=["M", "F", "O"]),
        DICOMPatientPositionCheck(allowed=["HFS", "FFP", "FFS"]),
        DICOMSliceThicknessCheck(min_mm=0.5, max_mm=5),
        DICOMPixelSpacingCheck(min_mm=0.2, max_mm=2.0),
        DICOMImageOrientationCheck(tolerance=1e-3),
        DICOMKVPCheck(min_kvp=80, max_kvp=140),
        DICOMTubeCurrentCheck(min_ma=100, max_ma=500),
        DICOMExposureTimeCheck(min_ms=50, max_ms=200),
        DICOMProtocolNameCheck(allowed=["Axial Brain", "Sagittal Spine"]),
        DICOMRTStructureCheck(required_rois=["Heart", "Lungs"]),
        # Generic Validators
        DICOMGenericValueInListCheck(
            tag="Manufacturer", allowed_values=["SIEMENS", "GE"]
        ),
        DICOMGenericTagTypeCheck(tag="PatientName", expected_vr="PN"),
        DICOMGenericNumericRangeCheck(tag="BeamNumber", min_val=1, max_val=10),
    ]
)

ds = pydicom.dcmread("/path/to/file.dcm")
results = runner.run(ds)
for r in results:
    print(r.name, r.passed, r.message)

YAML Spec schema

Specific DICOM validators:

  • dicom_patient_age_rangemin_years, max_years, inclusive (default: true)
  • dicom_modality_allowedallowed_modalities: ["CT", "MR", ...]
  • dicom_patient_sex_allowedallowed: ["M", "F", "O"]
  • dicom_patient_position_allowedallowed: ["HFS", "FFP", "FFS"]
  • dicom_slice_thickness_rangemin_mm, max_mm, inclusive
  • dicom_pixel_spacing_rangemin_mm, max_mm, inclusive
  • dicom_image_orientation_sanetolerance (default: 1e-3)
  • dicom_kvp_rangemin_kvp, max_kvp, inclusive
  • dicom_tube_current_rangemin_ma, max_ma, inclusive
  • dicom_exposure_time_rangemin_ms, max_ms, inclusive
  • dicom_protocol_name_allowedallowed: ["Axial Brain", ...]
  • dicom_rt_structure_presentrequired_rois: ["Heart", ...]

Generic DICOM validators:

  • dicom_generic_numeric_rangetag, unit, min_val, max_val, inclusive
  • dicom_generic_value_in_listtag, allowed_values: [...]
  • dicom_generic_tag_type_checktag, expected_vr

Other generic validators:

  • rangepath: [..], min, max, inclusive
  • choicepath: [..], allowed: [...], case_insensitive
  • required_fieldspaths: [[..], [..]]

Output validators:

  • json_schemaschema: {..} (JSON Schema Draft 2020-12 compatible via jsonschema)
  • All generic validators above

Example output schema:

output:
  - type: json_schema
    name: output_schema
    schema:
      type: object
      required: ["probability", "label"]
      properties:
        probability:
          type: number
          minimum: 0
          maximum: 1
        label:
          type: string

Development

Supported Python: 3.9–3.13 (tested in CI on Linux; library is pure Python and should work across platforms).

Run tests locally:

pytest -q

With uv:

uv run pytest -q

Lint/type-check (optional suggestions):

pip install ruff mypy
ruff check .
mypy src

Code style:

pip install black
black .

With uv:

uv pip install black
uv run black .

Notes

  • DICOM tags used include: PatientAge, PatientBirthDate, StudyDate, SeriesDate, ContentDate, Modality, PatientSex, PatientPosition, SliceThickness, PixelSpacing, ImageOrientationPatient, KVP, XRayTubeCurrent, ExposureTime, ProtocolName, SOPClassUID, StructureSetROISequence.
  • Age parsing supports Y/M/W/D suffixes (per DICOM), falls back to birthdate computation.
  • Validators never raise; failures are returned as ValidationResult and can be surfaced as warnings or errors.

Contributing

PRs welcome. Please add/update tests for new validators or behavior and update examples/spec.example.yaml when adding new spec types.

To create DICOMs in tests, use create_test_dicom from healthcare_ai_guardrails.testing.dicom_factory.

Releases and changelog

Maintainers (publishing):

  • Create a GitHub Release on the main branch. The workflow runs tests across Python 3.9–3.13, builds the sdist and universal wheel, and publishes to PyPI.
  • Ensure the repository has PYPI_API_TOKEN set in Secrets.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

healthcare_ai_guardrails-0.2.0.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

healthcare_ai_guardrails-0.2.0-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file healthcare_ai_guardrails-0.2.0.tar.gz.

File metadata

  • Download URL: healthcare_ai_guardrails-0.2.0.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for healthcare_ai_guardrails-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a64ab12d300de08ff4041ec83c8ddc25142659db3c24d1d10165b198a6f5da95
MD5 c6c80f17aa7467db0fab91ecf6f0d127
BLAKE2b-256 a13da319305e7ead103e78be086d1a111d828eb6555435f2b3b34301429f9ea5

See more details on using hashes here.

Provenance

The following attestation bundles were made for healthcare_ai_guardrails-0.2.0.tar.gz:

Publisher: release.yml on SamPIngram/healthcare-ai-guardrails

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file healthcare_ai_guardrails-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for healthcare_ai_guardrails-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 46c81fccac4c635457176bc58b9f1667158ffa681989fd851f36fdbffe6b5ee6
MD5 1d94aca6b49a3262a551db65311a8cc4
BLAKE2b-256 30ddcd64bb3dcc20dabcb524c539b8a98226559d63b007b0332dcb2356819622

See more details on using hashes here.

Provenance

The following attestation bundles were made for healthcare_ai_guardrails-0.2.0-py3-none-any.whl:

Publisher: release.yml on SamPIngram/healthcare-ai-guardrails

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page