Skip to main content

Prerequisites

  • Pidgeon CLI installed (dotnet tool install --global Pidgeon.CLI --version 0.1.0-beta.1)
  • Optionally: a vendor profile from real sample messages

Generate your first messages

Start with a basic HL7 ADT admission message:
This produces 5 synthetic ADT^A01 messages with realistic patient demographics, encounter data, and properly structured segments (MSH, EVN, PID, PV1).
Use --seed 42 for reproducible output — the same seed always generates the same messages.

Multi-standard generation

Pidgeon auto-detects the standard from the message type. You can also specify it explicitly:
HL7 v2 and FHIR R4 generation are free. NCPDP SCRIPT is closed by default — install the member-supplied standards package first (pidgeon data install ncpdp-script --accept-license, NCPDP membership required).

Use vendor profiles for realistic patterns

Real-world messages vary by EHR vendor. Use vendor profiles to match specific patterns:
1

Analyze sample messages

If you have real messages (de-identified), analyze them to create a profile:
2

Generate with the profile

Generated messages now match the field population patterns, segment ordering, and value sets from your samples.
3

Validate against the profile

Batch generation with output files

Save generated messages to files for use in integration testing:

Common message type combinations

Here are typical combinations for integration testing scenarios:

Next steps