Installation

Requirements

• Node.js 22 or later
• Package manager: npm, pnpm, or yarn

CLI — global install

Install the CLI globally to use fhir-test-data as a command anywhere:

pnpm

pnpm add -g fhir-test-data

npm

npm install -g fhir-test-data

yarn

yarn global add fhir-test-data

Verify the install:

fhir-test-data --version

Library — project dependency

Add as a development dependency when using the TypeScript API in test suites or build scripts:

pnpm

pnpm add -D fhir-test-data

npm

npm install --save-dev fhir-test-data

yarn

yarn add --dev fhir-test-data

Package exports

The package exposes two entry points:

Import path	Contents
fhir-test-data	Core types, all builder factories, locale utilities
fhir-test-data/faults	injectFaults, FAULT_TYPES, fault type definitions

import { createPatientBuilder } from "fhir-test-data";
import { injectFaults, FAULT_TYPES } from "fhir-test-data/faults";