Skip to content
fhir-capability-analyzer

Getting Started

Requirements

Section titled “Requirements”
  • Node.js 20 or later
  • No other dependencies required for CLI use

One-time use with npx

Section titled “One-time use with npx”

No installation needed:

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

Install globally

Section titled “Install globally”
Terminal window
npm install -g fhir-capability-analyzer
fhir-capability-analyzer --version

Install as a project dependency

Section titled “Install as a project dependency”
Terminal window
npm install fhir-capability-analyzer
# or
pnpm add fhir-capability-analyzer

Your first analysis

Section titled “Your first analysis”

Analyze a live FHIR server:

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

Analyze a local CapabilityStatement file:

Terminal window
fhir-capability-analyzer analyze ./capability.json

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

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

Your first comparison

Section titled “Your first comparison”

Compare two servers:

Terminal window
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:

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

Next steps

Section titled “Next steps”