Documentation

Installation

Submit Shield is distributed as a Python package, a Docker image, and a Windows installer. Choose the method that matches your environment.

pip install submitshield

docker pull submitshield/sdk:latest

# Run the folder-watcher
docker run -d \
  -v /path/to/claims:/watch \
  -e SUBMITSHIELD_API_KEY=your_key \
  submitshield/sdk:latest

# Download from https://submitshield.health/downloads
submitshield-setup.exe

Quick start

Validate your first batch of claims in under five minutes.

from submitshield import SubmitShield

# Initialize the client with your API key
client = SubmitShield(api_key="your_key")

# Validate claims from any supported format
# Supported: 837P, FHIR R4, CSV, canonical JSON, X12 835
verdicts = client.validate("claims.csv")

# Iterate over results
for verdict in verdicts:
    print(f"Claim {verdict.claim_id}: {verdict.status}")

    if verdict.status == "flagged":
        for flag in verdict.flags:
            print(f"  [{flag.rule}] {flag.message}")
            print(f"  CMS source: {flag.source_url}")

# Check summary statistics
clean = sum(1 for v in verdicts if v.status == "clean")
flagged = sum(1 for v in verdicts if v.status == "flagged")
print(f"Results: {clean} clean, {flagged} flagged")

PHI de-identification

The SDK automatically strips all 18 HIPAA identifiers from your claims before transmitting data to the Submit Shield API. This happens entirely on your machine, so protected health information never leaves your network.

De-identification covers: names, geographic data, dates (except year), phone numbers, fax numbers, email addresses, SSN, MRN, health plan beneficiary numbers, account numbers, certificate/license numbers, vehicle identifiers, device identifiers, URLs, IP addresses, biometric identifiers, full-face images, and any other uniquely identifying number.

Resources