CLI Commands Reference

License Management

Manage your Epic CLI license and view usage information:

# Show detailed license and usage information
epic license status

# Activate a license key (handles already-activated licenses gracefully)
epic license activate <key>

# Return to trial mode
epic license deactivate

# Test license API connectivity
epic license test

# View pricing and upgrade options
epic upgrade

Authentication & Status

Check system health and authentication status:

# Overall system health and license info
epic status

# Test Epic authentication
epic auth test

# Check token status
epic auth status

# FHIR server capabilities
epic capabilities

# Show available features by license tier
epic features

Patient Operations

Search and retrieve patient information:

# Search patients (available in all tiers)
epic patients search --family Smith --given John
epic patients search --gender female --count 10

# CSV export (Team+ only)
epic patients search --family Smith --csv

# Get patient details
epic patient PATIENT_ID
epic patient PATIENT_ID --json --include "vitals,labs,medications"

Clinical Data (Starter+)

Access clinical data for licensed users:

# Patient vitals
epic vitals PATIENT_ID
epic vitals PATIENT_ID --count 10 --since 2024-01-01

# Lab results
epic labs PATIENT_ID --json

# Medications
epic medications PATIENT_ID
epic medications PATIENT_ID --status active

Configuration

Manage Epic CLI configuration:

# Show current configuration
epic config show

# Validate configuration
epic config validate

# Re-run setup wizard
epic setup --force

Examples by License Tier

Here are practical examples organized by license tier:

Trial Mode (Free)

Perfect for learning and evaluation:

# Basic patient search (10 calls/day limit)
epic patients search --family Lopez
epic patient erXuFYUfucBZaryVksYEcMg3

# Check remaining calls
epic license status

# Upgrade when ready
epic upgrade

Starter License ($199/year)

Production environment access with 2,000 calls/day:

# Production environment access
epic patients search --family Smith --count 50 --json > patients.json

# Access vitals and labs
epic patient PATIENT_ID --include "vitals,labs,medications"

# 2,000 calls/day for serious development
epic vitals PATIENT_ID --count 100

Professional License ($499/year)

CSV export and batch processing with 5,000 calls/day:

# CSV export for team analysis
epic patients search --gender female --count 100 --csv > female_patients.csv

# Batch processing capabilities
epic batch-process patient-ids.txt

# Advanced data export
epic vitals PATIENT_ID --csv --since 2024-01-01

Team License ($999/year)

Team collaboration with 10,000 calls/day:

# Team configuration sharing
epic config share --team-id TEAM_ID

# Advanced team features
epic patients search --count 1000 --json

# Webhook setup
epic webhook setup --endpoint https://yourapp.com/epic-webhook

Enterprise License (Custom)

Unlimited API calls for production systems:

# Unlimited API calls for production systems
epic patients search --count 10000 --json

# Advanced webhook configuration
epic webhook setup --endpoint https://yourapp.com/epic-webhook

# Custom queries and audit logs
epic audit-logs --since 2024-01-01
epic custom-query --file custom-fhir-query.json

Testing License Features

Use mock licenses for testing without purchasing:

# Test starter license features
epic --mock-license starter license status
epic --mock-license starter patients search

# Test professional license features  
epic --mock-license professional patients search --csv

# Test team license features
epic --mock-license team license status

# Test enterprise license
epic --mock-license enterprise license status

# Test expired license (falls back to trial)
epic --mock-license expired patients search

Command Category	Trial	Starter	Professional	Team	Enterprise
Patient Search	✅	✅	✅	✅	✅
Vitals & Labs	❌	✅	✅	✅	✅
CSV Export	❌	❌	✅	✅	✅
Batch Processing	❌	❌	✅	✅	✅
Team Features	❌	❌	❌	✅	✅
Webhooks & Audit	❌	❌	❌	❌	✅

License Management

Patient Operations

Clinical Data

Most Used Commands

License Management

Authentication & Status

Patient Operations

Clinical Data (Starter+)

Configuration

Examples by License Tier

Trial Mode (Free)

Starter License ($199/year)

Professional License ($499/year)

Team License ($999/year)

Enterprise License (Custom)

Testing License Features

Feature Availability by License Tier

Upgrade Your License

API Reference