Getting started

Requirements

• Node.js 20 or later
• No other dependencies required for CLI use

One-time use with npx

No installation needed:

npx fhir-capability-analyzer analyze https://hapi.fhir.org/baseR4

Install globally

npm install -g fhir-capability-analyzer
fhir-capability-analyzer --version

Install as a project dependency

npm install fhir-capability-analyzer
# or
pnpm add fhir-capability-analyzer

Your first analysis

Analyze a live FHIR server:

fhir-capability-analyzer analyze https://hapi.fhir.org/baseR4

Analyze a local CapabilityStatement file:

fhir-capability-analyzer analyze ./capability.json

Get structured JSON output (stable schema, suitable for CI and AI agents):

fhir-capability-analyzer analyze https://hapi.fhir.org/baseR4 --format json

Your first comparison

Compare two servers:

fhir-capability-analyzer compare https://server-a.example.com https://server-b.example.com

Compare a local baseline against a live server, failing CI if differences exist:

fhir-capability-analyzer compare ./fixtures/baseline.json https://staging.example.com --exit-on-diff

Next steps

• Analyze a server — understand the full output and what it tells you
• Compare two servers — CI assertions and diff output
• Profile detection — how international profile conformance is detected
• CI/CD integration — patterns for using this tool in CI pipelines