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.

Every code uses real reference datasets — ICD-10, LOINC, NDC, SNOMED CT, CVX, RxNorm, HCPCS — so generated messages pass downstream validation the same way production data would.

​
Supported Standards

pidgeon generate ADT^A01 --count 5
pidgeon generate ORU^R01 --count 3
pidgeon generate ORM^O01

​
HL7 v2 Coverage

Post supports all 278 trigger events across HL7 v2.3 through v2.8 — not a subset. Any valid message type and version works.
51 trigger events covering the complete patient movement lifecycle.ADT^A01 Admission, ADT^A02 Transfer, ADT^A03 Discharge, ADT^A04 Registration, ADT^A05 Pre-admit, ADT^A06 Transfer outpatient to inpatient, ADT^A07 Transfer inpatient to outpatient, ADT^A08 Update patient info, ADT^A09–ADT^A12 Patient tracking, ADT^A13 Cancel discharge, ADT^A14–ADT^A17 Pending events, ADT^A18 Merge, ADT^A19–ADT^A51 and more.
Orders: ORM^O01 General order, ORM^O02 Order response, ORM^O03 Diet orderResults: ORU^R01 Observation result, ORU^R03 Display-oriented result, ORU^R04 Response to query
RDE^O11 Pharmacy/treatment encoded order, RDE^O25 Pharmacy/treatment refill authorization, RDS^O13 Pharmacy/treatment dispense, RGV^O15 Pharmacy/treatment give, RAS^O17 Pharmacy/treatment administration
20+ types: SIU^S12 Notification of new appointment, SIU^S13 Request rescheduling, SIU^S14 Modification notification, SIU^S15 Cancellation notification, SIU^S16–SIU^S26 additional scheduling events, SRM schedule request messages
11 types: MDM^T01 Original document notification, MDM^T02 Original with content, MDM^T03–MDM^T11 document addenda, status changes, and replacements
BAR^P01 Add patient account, BAR^P02 Purge patient account, BAR^P05 Update account, BAR^P06 End account, DFT^P03 Post detail financial transaction, DFT^P11 Post detail financial transaction (expanded)
10+ types: MFN^M01–MFN^M11 covering staff/practitioner, location, charge description, clinical study, test/observation, and other master file updates
QRY^A19 Patient query, QRY^Q01–QRY^Q02 General queries, QRY^R02 Query for results, QRY^PC4/PC9/PCE/PCK Patient care queries, QRY^Q26–QRY^Q30 Pharmacy queries, and more
VXU^V04 Unsolicited vaccination update, VXR^V03 Vaccination record response, VXQ^V01 Vaccination query
REF^I12 Patient referral, REF^I13 Modify referral, REF^I14 Cancel referral, REF^I15 Request referral status, RRI^I12–RRI^I15 Referral response messages
ACK, CRM, CSU, DOC, DSR, EDR, EQQ, ERP, MFD, MFK, MFQ, MFR, NMD, NMQ, NMR, OMD, OMN, OMS, ORD, ORF, ORR, ORS, ORW, OSQ, OSR, PEX, PGL, PIN, PPG, PPP, PPR, PPT, PPV, PRR, PTR, QCK, RAR, RCI, RCL, RDO, RDR, ROR, RPA, RPI, RPL, RPR, RQA, RQC, RQI, RQP, RQQ, RRA, RRD, RRE, RRG, RRI, RRO, SUR, TBR, UDM, VQQ, and more
Shell-safe syntax is supported: ADT-A01, ADT_A01, and ADT.A01 all work as alternatives to ADT^A01.

​
FHIR R4 Resources

40 resource types across clinical, administrative, and infrastructure domains:
Patient, Person, RelatedPerson
Observation, DiagnosticReport, Condition, AllergyIntolerance, FamilyMemberHistory, Immunization
Medication, MedicationRequest, MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, ServiceRequest, ImagingStudy
Encounter, EpisodeOfCare, CareTeam, CarePlan, Goal, RiskAssessment
Organization, Location, Practitioner, PractitionerRole, HealthcareService
Appointment, AppointmentResponse, Schedule, Slot, Task, Communication
Bundle, Composition, DocumentReference, Device, DeviceRequest
Coverage, Claim

​
NCPDP SCRIPT 2017071

14 transaction types with full XML serialization and validation:
NewRx, RxChangeRequest, RxChangeResponse, CancelRx, CancelRxResponse
RxFill, RxHistoryRequest, RxHistoryResponse
PAInitiationRequest, PAInitiationResponse
FormularyRequest, FormularyResponse, GetMessage, Verify, Error, Status

​
Generation Modes

Deterministic generation using reference datasets (ICD-10, LOINC, NDC, SNOMED). Fast and reproducible. Available to all users.
pidgeon generate ADT^A01 --mode procedural
Uses a local AI model for enhanced clinical narratives and realistic note text.
pidgeon generate ORU^R01 --mode local-ai
Cloud AI provider for highest quality clinical narratives. Requires BYOK configuration.
pidgeon generate MDM^T02 --mode api-ai

​
Reproducibility

Use --seed for deterministic output. The same seed always produces the same message, making tests repeatable across machines and CI runs: 
# Same seed = identical output every time
pidgeon generate ADT^A01 --seed 42

# With --count, every message uses the same seed (identical copies)
pidgeon generate ADT^A01 --count 10 --seed 42

​
Vendor-Specific Generation

pidgeon generate ADT^A01 --vendor epic_er --count 20
See Vendor Profiles for creating and managing vendor configurations.

​
Output Options

# Write to a file
pidgeon generate ADT^A01 --output ./messages/admit.hl7

# JSON format for FHIR
pidgeon generate Patient --format json

# NDJSON for bulk loading
pidgeon generate Observation --count 100 --format ndjson