Skip to main content
The CLI is one binary that exposes generate, validate, conform, and de-identify from a terminal. It follows the Unix convention (0 success, non-zero failure), so every command below drops into a CI pipeline as-is.

​
Prerequisites

1

Install the CLI

Verify the installation:
2

Generate your first message

Generate a synthetic HL7 ADT admission message:
Example output:
The standard is inferred from the message type: ADT^A01 is HL7 v2, Patient is FHIR R4. Generate multiple messages to a folder:
3

Validate a message

Example output:
Each issue includes expected/actual values, a fix suggestion, and a pidgeon lookup tip that opens the built-in standards reference. --mode strict checks against the published spec; --mode compatibility tolerates common real-world deviations.
4

Run a conformance check

Probe a live FHIR endpoint against a published Implementation Guide and get a pass/fail with an HTML scorecard:
Current IG scope includes US Core and Da Vinci PAS 2.1. With --ci, must-support warnings also produce a non-zero exit so your pipeline gate catches them; without --ci they stay warnings.
5

De-identify real messages

If you have real messages to work with, de-identify them first:
All processing happens on your machine; nothing is uploaded.
6

Discover the rest

Help is built in at every level:

​
Exit codes

The CLI emits exactly two exit codes, suitable for CI gates and shell scripting: A minimal CI gate:

​
Next steps