Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pidgeon.health/llms.txt

Use this file to discover all available pages before exploring further.

One command to start watching. Every new message file is parsed and validated in real time against your vendor profile, with metrics tracked per interface.

​
Creating Interfaces

pidgeon loft watch --directory /var/mirth/outbound/er --profile epic_er --file-pattern "*.hl7"

​
Interface Metrics

Each interface tracks:
  • Messages total — Total messages processed
  • Success rate — Percentage passing validation
  • Error rate — Messages with validation failures
  • Throughput — Messages per minute/hour
  • Latency — Average and p99 processing time
curl "https://api.pidgeon.health/api/loft/interfaces/{id}/metrics?sinceHours=24"

​
Managing Interfaces

# List all interfaces
curl https://api.pidgeon.health/api/loft/interfaces

# Update an interface
curl -X PUT https://api.pidgeon.health/api/loft/interfaces/{id} \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

# Delete an interface
curl -X DELETE https://api.pidgeon.health/api/loft/interfaces/{id}

​
Status Overview

# CLI
pidgeon loft status

# API
curl https://api.pidgeon.health/api/loft/status