fhir-validator-wrapper 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/fhir-validator.js

@@ -0,0 +1,396 @@
+const { spawn } = require('child_process');
+const http = require('http');
+const https = require('https');
+const { URL } = require('url');
+
+/**
+ * Node.js wrapper for the FHIR Validator HTTP Service
+ */
+class FhirValidator {
+  constructor(validatorJarPath) {
+    this.validatorJarPath = validatorJarPath;
+    this.process = null;
+    this.port = null;
+    this.baseUrl = null;
+    this.isReady = false;
+  }
+
+  /**
+   * Start the FHIR validator service
+   * @param {Object} config - Configuration object
+   * @param {string} config.version - FHIR version (e.g., "5.0.0")
+   * @param {string} config.txServer - Terminology server URL (e.g., "http://tx.fhir.org/r5")
+   * @param {string} config.txLog - Path to transaction log file
+   * @param {string[]} [config.igs] - Array of implementation guide packages (e.g., ["hl7.fhir.us.core#6.0.0"])
+   * @param {number} [config.port=8080] - Port to run the service on
+   * @param {number} [config.timeout=30000] - Timeout in ms to wait for service to be ready
+   * @returns {Promise<void>}
+   */
+  async start(config) {
+    if (this.process) {
+      throw new Error('Validator service is already running');
+    }
+
+    const { version, txServer, txLog, igs = [], port = 8080, timeout = 30000 } = config;
+
+    if (!version || !txServer || !txLog) {
+      throw new Error('version, txServer, and txLog are required');
+    }
+
+    this.port = port;
+    this.baseUrl = `http://localhost:${port}`;
+
+    // Build command line arguments
+    const args = [
+      '-jar', this.validatorJarPath,
+      '-server', port.toString(),
+      '-tx', txServer,
+      '-txlog', txLog,
+      '-version', version
+    ];
+
+    // Add implementation guides
+    for (const ig of igs) {
+      args.push('-ig', ig);
+    }
+
+    console.log(`Starting FHIR validator with command: java ${args.join(' ')}`);
+
+    // Spawn the Java process
+    this.process = spawn('java', args, {
+      stdio: ['pipe', 'pipe', 'pipe']
+    });
+
+    // Handle process events
+    this.process.on('error', (error) => {
+      console.error('Failed to start validator process:', error);
+      throw error;
+    });
+
+    this.process.on('exit', (code, signal) => {
+      console.log(`Validator process exited with code ${code} and signal ${signal}`);
+      this.cleanup();
+    });
+
+    // Capture stdout and stderr for debugging
+    this.process.stdout.on('data', (data) => {
+      const lines = data.toString().split('\n');
+      lines.forEach(line => {
+        // Remove ANSI escape sequences (color codes, etc.)
+        const cleanLine = line.replace(/\u001b\[[0-9;]*m/g, '').trim();
+        if (cleanLine.length > 1) { // Only log non-empty lines
+          console.log(`Validator: ${cleanLine}`);
+        }
+      });
+    });
+
+    this.process.stderr.on('data', (data) => {
+      console.error(`Validator-err: ${data}`);
+    });
+
+    // Wait for the service to be ready
+    await this.waitForReady(timeout);
+    console.log('FHIR validator service is ready');
+  }
+
+  /**
+   * Wait for the HTTP service to be ready
+   * @param {number} timeout - Timeout in milliseconds
+   * @returns {Promise<void>}
+   */
+  async waitForReady(timeout) {
+    const startTime = Date.now();
+    
+    while (Date.now() - startTime < timeout) {
+      try {
+        await this.healthCheck();
+        this.isReady = true;
+        return;
+      } catch (error) {
+        // Service not ready yet, wait and retry
+        await new Promise(resolve => setTimeout(resolve, 1000));
+      }
+    }
+    
+    throw new Error(`Validator service did not become ready within ${timeout}ms`);
+  }
+
+  /**
+   * Perform a health check on the service
+   * @returns {Promise<void>}
+   */
+  healthCheck() {
+    return new Promise((resolve, reject) => {
+      const req = http.get(`${this.baseUrl}/validateResource`, (res) => {
+        // We expect a 405 Method Not Allowed since we're doing GET instead of POST
+        if (res.statusCode === 405) {
+          resolve();
+        } else {
+          reject(new Error(`Unexpected status code: ${res.statusCode}`));
+        }
+      });
+
+      req.on('error', reject);
+      req.setTimeout(5000, () => {
+        req.destroy();
+        reject(new Error('Health check timeout'));
+      });
+    });
+  }
+
+  /**
+   * Validate a FHIR resource
+   * @param {string|Buffer|Object} resource - The resource to validate (JSON string, Buffer, or Object)
+   * @param {Object} [options] - Validation options
+   * @param {string[]} [options.profiles] - Profiles to validate against
+   * @param {string} [options.resourceIdRule] - Resource ID rule ("OPTIONAL", "REQUIRED", "PROHIBITED")
+   * @param {boolean} [options.anyExtensionsAllowed=true] - Whether any extensions are allowed
+   * @param {string} [options.bpWarnings] - Best practice warning level
+   * @param {string} [options.displayOption] - Display option for validation
+   * @returns {Promise<Object>} - The OperationOutcome as a JavaScript object
+   */
+  async validate(resource, options = {}) {
+    if (!this.isReady) {
+      throw new Error('Validator service is not ready');
+    }
+
+    // Convert resource to bytes
+    let resourceBytes;
+    let contentType = 'application/fhir+json';
+
+    if (typeof resource === 'string') {
+      // Determine if it's JSON or XML
+      const trimmed = resource.trim();
+      if (trimmed.startsWith('<')) {
+        contentType = 'application/fhir+xml';
+      }
+      resourceBytes = Buffer.from(resource, 'utf8');
+    } else if (Buffer.isBuffer(resource)) {
+      resourceBytes = resource;
+      // Try to detect format from content
+      const content = resource.toString('utf8').trim();
+      if (content.startsWith('<')) {
+        contentType = 'application/fhir+xml';
+      }
+    } else if (typeof resource === 'object') {
+      resourceBytes = Buffer.from(JSON.stringify(resource), 'utf8');
+      contentType = 'application/fhir+json';
+    } else {
+      throw new Error('Resource must be a string, Buffer, or object');
+    }
+
+    // Build query parameters
+    const queryParams = new URLSearchParams();
+    
+    if (options.profiles && options.profiles.length > 0) {
+      queryParams.set('profiles', options.profiles.join(','));
+    }
+    if (options.resourceIdRule) {
+      queryParams.set('resourceIdRule', options.resourceIdRule);
+    }
+    if (options.anyExtensionsAllowed !== undefined) {
+      queryParams.set('anyExtensionsAllowed', options.anyExtensionsAllowed.toString());
+    }
+    if (options.bpWarnings) {
+      queryParams.set('bpWarnings', options.bpWarnings);
+    }
+    if (options.displayOption) {
+      queryParams.set('displayOption', options.displayOption);
+    }
+
+    const url = `${this.baseUrl}/validateResource?${queryParams.toString()}`;
+
+    return new Promise((resolve, reject) => {
+      const parsedUrl = new URL(url);
+      const requestOptions = {
+        hostname: parsedUrl.hostname,
+        port: parsedUrl.port,
+        path: parsedUrl.pathname + parsedUrl.search,
+        method: 'POST',
+        headers: {
+          'Content-Type': contentType,
+          'Content-Length': resourceBytes.length,
+          'Accept': 'application/fhir+json'
+        }
+      };
+
+      const req = http.request(requestOptions, (res) => {
+        let data = '';
+        
+        res.on('data', (chunk) => {
+          data += chunk;
+        });
+        
+        res.on('end', () => {
+          try {
+            const result = JSON.parse(data);
+            resolve(result);
+          } catch (error) {
+            reject(new Error(`Failed to parse response: ${error.message}\nResponse: ${data}`));
+          }
+        });
+      });
+
+      req.on('error', reject);
+      
+      req.setTimeout(30000, () => {
+        req.destroy();
+        reject(new Error('Validation request timeout'));
+      });
+
+      req.write(resourceBytes);
+      req.end();
+    });
+  }
+
+  /**
+   * Validate a FHIR resource with byte array input
+   * @param {Buffer} resourceBytes - The resource as bytes
+   * @param {string} [format='json'] - The format ('json' or 'xml')
+   * @param {Object} [options] - Validation options (same as validate method)
+   * @returns {Promise<Object>} - The OperationOutcome as a JavaScript object
+   */
+  async validateBytes(resourceBytes, format = 'json', options = {}) {
+    if (!Buffer.isBuffer(resourceBytes)) {
+      throw new Error('resourceBytes must be a Buffer');
+    }
+    
+    return this.validate(resourceBytes, options);
+  }
+
+  /**
+   * Validate a FHIR resource object
+   * @param {Object} resourceObject - The resource as a JavaScript object
+   * @param {Object} [options] - Validation options (same as validate method)
+   * @returns {Promise<Object>} - The OperationOutcome as a JavaScript object
+   */
+  async validateObject(resourceObject, options = {}) {
+    if (typeof resourceObject !== 'object' || resourceObject === null) {
+      throw new Error('resourceObject must be an object');
+    }
+    
+    return this.validate(resourceObject, options);
+  }
+
+  /**
+   * Load an Implementation Guide
+   * @param {string} packageId - The package ID (e.g., "hl7.fhir.us.core")
+   * @param {string} version - The version (e.g., "6.0.0")
+   * @returns {Promise<Object>} - The OperationOutcome as a JavaScript object
+   */
+  async loadIG(packageId, version) {
+    if (!this.isReady) {
+      throw new Error('Validator service is not ready');
+    }
+
+    const queryParams = new URLSearchParams();
+    queryParams.set('packageId', packageId);
+    queryParams.set('version', version);
+
+    const url = `${this.baseUrl}/loadIG?${queryParams.toString()}`;
+
+    return new Promise((resolve, reject) => {
+      const parsedUrl = new URL(url);
+      const requestOptions = {
+        hostname: parsedUrl.hostname,
+        port: parsedUrl.port,
+        path: parsedUrl.pathname + parsedUrl.search,
+        method: 'POST',
+        headers: {
+          'Accept': 'application/fhir+json'
+        }
+      };
+
+      const req = http.request(requestOptions, (res) => {
+        let data = '';
+        
+        res.on('data', (chunk) => {
+          data += chunk;
+        });
+        
+        res.on('end', () => {
+          try {
+            const result = JSON.parse(data);
+            resolve(result);
+          } catch (error) {
+            reject(new Error(`Failed to parse response: ${error.message}\nResponse: ${data}`));
+          }
+        });
+      });
+
+      req.on('error', reject);
+      
+      req.setTimeout(30000, () => {
+        req.destroy();
+        reject(new Error('Load IG request timeout'));
+      });
+
+      req.end();
+    });
+  }
+
+  /**
+   * Stop the validator service
+   * @returns {Promise<void>}
+   */
+  async stop() {
+    if (!this.process) {
+      return;
+    }
+
+    return new Promise((resolve, reject) => {
+      const timeout = setTimeout(() => {
+        console.warn('Force killing validator process after timeout');
+        if (this.process && !this.process.killed) {
+          this.process.kill('SIGKILL');
+        }
+        this.cleanup();
+        resolve();
+      }, 10000); // 10 second total timeout
+
+      // Single exit handler
+      const onExit = () => {
+        clearTimeout(timeout);
+        this.cleanup();
+        resolve();
+      };
+
+      this.process.once('exit', onExit); // Use 'once' to avoid duplicate listeners
+
+      // Since Java process is blocking on System.in.read(), SIGTERM likely won't work
+      // Go straight to SIGKILL for immediate termination
+      console.log('Stopping validator process...');
+      this.process.kill('SIGKILL');
+      
+      // Backup: try SIGTERM first, then SIGKILL after 2 seconds
+      // this.process.kill('SIGTERM');
+      // setTimeout(() => {
+      //   if (this.process && !this.process.killed) {
+      //     console.log('Escalating to SIGKILL...');
+      //     this.process.kill('SIGKILL');
+      //   }
+      // }, 2000);
+    });
+  }
+
+  /**
+   * Clean up internal state
+   * @private
+   */
+  cleanup() {
+    this.process = null;
+    this.port = null;
+    this.baseUrl = null;
+    this.isReady = false;
+  }
+
+  /**
+   * Check if the validator service is running
+   * @returns {boolean}
+   */
+  isRunning() {
+    return this.process !== null && this.isReady;
+  }
+}
+
+module.exports = FhirValidator;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "fhir-validator-wrapper",
+  "version": "1.0.0",
+  "description": "Node.js wrapper for the HL7 FHIR Validator CLI",
+  "main": "fhir-validator.js",
+  "scripts": {
+    "test": "jest",
+    "test:unit": "jest --testPathIgnorePatterns=integration",
+    "test:integration": "INTEGRATION_TESTS=1 jest",
+    "test:manual": "MANUAL_TEST=1 node tests.js",
+    "test:with-jar": "FHIR_VALIDATOR_JAR_PATH=./my-validator.jar npm test",
+    "start": "node example.js"
+  },
+  "keywords": [
+    "fhir",
+    "validator",
+    "hl7",
+    "healthcare",
+    "interoperability",
+    "validation"
+  ],
+  "author": "Grahame Grieve",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FHIR/fhir-validator-wrapper.git"
+  },
+  "bugs": {
+    "url": "https://github.com/FHIR/fhir-validator-wrapper/issues"
+  },
+  "homepage": "https://github.com/FHIR/fhir-validator-wrapper#readme",
+  "dependencies": {},
+  "devDependencies": {
+    "jest": "^29.0.0"
+  },
+  "files": [
+    "fhir-validator.js",
+    "README.md",
+    "LICENSE"
+  ]
+}

package/readme.md

@@ -0,0 +1,356 @@
+[![npm version](https://badge.fury.io/js/fhir-validator-wrapper.svg)](https://badge.fury.io/js/fhir-validator-wrapper)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-yellow.svg)]
+[![Downloads](https://img.shields.io/npm/dm/fhir-validator-wrapper.svg)](https://www.npmjs.com/package/fhir-validator-wrapper)
+
+# FHIR Validator Wrapper
+
+A Node.js wrapper for the HL7 FHIR Validator CLI that provides a simple, promise-based API for validating FHIR resources.
+
+## FHIR Foundation Project Statement
+
+* Maintainers: Grahame Grieve (looking for volunteers)
+* Issues / Discussion: https://github.com/FHIR/fhir-validator-wrapper/issues / https://chat.fhir.org/#narrow/channel/179169-javascript
+* License: Apache 2.0
+* Contribution Policy: See [Contributing](#contributing).
+* Security Information: To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/FHIR/fhir-validator-wrapper/security/advisories/new) tab.
+
+## Contributing
+
+There are many ways to contribute:
+* [Submit bugs](https://github.com/FHIR/fhir-validator-wrapper/issues) and help us verify fixes as they are checked in.
+* Review the [source code changes](https://github.com/FHIR/fhir-validator-wrapper/pulls).
+* Engage with users and developers on the [dotnet stream on FHIR Zulip](https://chat.fhir.org/#narrow/channel/179169-javascript)
+* Contribute features or bug fixes via PRs:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## Overview
+
+This library manages the lifecycle of the FHIR Validator Java service and provides a clean Node.js interface for validation operations. It handles process management, HTTP communication, and provides typed validation options.
+
+## Prerequisites
+
+- Node.js 12.0.0 or higher
+- Java 8 or higher
+- FHIR Validator CLI JAR file (download from [GitHub releases](https://github.com/hapifhir/org.hl7.fhir.core/releases))
+
+## Installation
+
+```bash
+npm install fhir-validator-wrapper
+```
+
+## Quick Start
+
+```bash
+# Run the example with your JAR file
+FHIR_VALIDATOR_JAR_PATH=./your-validator.jar npm start
+```
+
+Or in code:
+
+```javascript
+const FhirValidator = require('fhir-validator-wrapper');
+
+async function validateResource() {
+  const validator = new FhirValidator('./validator_cli.jar');
+  
+  try {
+    // Start the validator service
+    await validator.start({
+      version: '5.0.0',
+      txServer: 'http://tx.fhir.org/r5',
+      txLog: './txlog.txt',
+      igs: ['hl7.fhir.us.core#6.0.0']
+    });
+    
+    // Validate a resource
+    const patient = {
+      resourceType: 'Patient',
+      id: 'example',
+      active: true,
+      name: [{ family: 'Doe', given: ['John'] }]
+    };
+    
+    const result = await validator.validate(patient);
+    console.log('Validation result:', result);
+    
+  } finally {
+    await validator.stop();
+  }
+}
+```
+
+## API Reference
+
+### Constructor
+
+#### `new FhirValidator(validatorJarPath)`
+
+Creates a new FHIR validator instance.
+
+- `validatorJarPath` (string): Path to the FHIR validator CLI JAR file
+
+### Methods
+
+#### `start(config)`
+
+Starts the FHIR validator service with the specified configuration.
+
+**Parameters:**
+- `config` (Object): Configuration object
+  - `version` (string): FHIR version (e.g., "5.0.0", "4.0.1")
+  - `txServer` (string): Terminology server URL (e.g., "http://tx.fhir.org/r5")
+  - `txLog` (string): Path to transaction log file
+  - `igs` (string[], optional): Array of implementation guide packages
+  - `port` (number, optional): Port to run the service on (default: 8080)
+  - `timeout` (number, optional): Startup timeout in milliseconds (default: 30000)
+
+**Returns:** `Promise<void>`
+
+**Example:**
+```javascript
+await validator.start({
+  version: '5.0.0',
+  txServer: 'http://tx.fhir.org/r5',
+  txLog: './txlog.txt',
+  igs: [
+    'hl7.fhir.us.core#6.0.0',
+    'hl7.fhir.uv.sdc#3.0.0'
+  ],
+  port: 8080
+});
+```
+
+#### `validate(resource, options)`
+
+Validates a FHIR resource against the loaded implementation guides and profiles.
+
+**Parameters:**
+- `resource` (string|Buffer|Object): The resource to validate
+  - String: JSON or XML resource
+  - Buffer: Raw bytes of resource
+  - Object: JavaScript object representing the resource
+- `options` (Object, optional): Validation options
+  - `profiles` (string[]): Profiles to validate against
+  - `resourceIdRule` (string): Resource ID rule ("OPTIONAL", "REQUIRED", "PROHIBITED")
+  - `anyExtensionsAllowed` (boolean): Whether any extensions are allowed (default: true)
+  - `bpWarnings` (string): Best practice warning level
+  - `displayOption` (string): Display option for validation
+
+**Returns:** `Promise<Object>` - OperationOutcome as JavaScript object
+
+**Examples:**
+```javascript
+// Basic validation
+const result = await validator.validate(patientResource);
+
+// Validation with options
+const result = await validator.validate(patientResource, {
+  profiles: ['http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient'],
+  resourceIdRule: 'REQUIRED',
+  bpWarnings: 'Warning'
+});
+```
+
+#### `validateBytes(resourceBytes, format, options)`
+
+Validates a FHIR resource from raw bytes.
+
+**Parameters:**
+- `resourceBytes` (Buffer): The resource as bytes
+- `format` (string, optional): The format ("json" or "xml", default: "json")
+- `options` (Object, optional): Same as `validate()` method
+
+**Returns:** `Promise<Object>` - OperationOutcome as JavaScript object
+
+#### `validateObject(resourceObject, options)`
+
+Validates a FHIR resource object.
+
+**Parameters:**
+- `resourceObject` (Object): The resource as a JavaScript object
+- `options` (Object, optional): Same as `validate()` method
+
+**Returns:** `Promise<Object>` - OperationOutcome as JavaScript object
+
+#### `loadIG(packageId, version)`
+
+Loads an additional implementation guide at runtime.
+
+**Parameters:**
+- `packageId` (string): The package ID (e.g., "hl7.fhir.us.core")
+- `version` (string): The version (e.g., "6.0.0")
+
+**Returns:** `Promise<Object>` - OperationOutcome as JavaScript object
+
+**Example:**
+```javascript
+await validator.loadIG('hl7.fhir.uv.ips', '1.1.0');
+```
+
+#### `stop()`
+
+Stops the validator service and cleans up resources.
+
+**Returns:** `Promise<void>`
+
+#### `isRunning()`
+
+Checks if the validator service is currently running.
+
+**Returns:** `boolean`
+
+#### `healthCheck()`
+
+Performs a health check on the running service.
+
+**Returns:** `Promise<void>`
+
+## Implementation Guide Loading
+
+Implementation guides can be loaded in two ways:
+
+1. **At startup** (recommended for known dependencies):
+```javascript
+await validator.start({
+  version: '5.0.0',
+  txServer: 'http://tx.fhir.org/r5',
+  txLog: './txlog.txt',
+  igs: [
+    'hl7.fhir.us.core#6.0.0',
+    'hl7.fhir.uv.sdc#3.0.0'
+  ]
+});
+```
+
+2. **At runtime** (for dynamic loading):
+```javascript
+await validator.loadIG('hl7.fhir.uv.ips', '1.1.0');
+```
+
+For IG package format documentation, see: [Using the FHIR Validator - Loading Implementation Guides](https://confluence.hl7.org/spaces/FHIR/pages/35718580/Using+the+FHIR+Validator#UsingtheFHIRValidator-LoadinganimplementationGuide)
+
+## Error Handling
+
+The library throws descriptive errors for various failure scenarios:
+
+```javascript
+try {
+  await validator.validate(invalidResource);
+} catch (error) {
+  if (error.message.includes('Validation failed')) {
+    // Handle validation errors
+    console.log('Resource is invalid:', error.message);
+  } else if (error.message.includes('not ready')) {
+    // Handle service not ready
+    console.log('Service not started:', error.message);
+  } else {
+    // Handle other errors
+    console.log('Unexpected error:', error.message);
+  }
+}
+```
+
+## Best Practices
+
+1. **Resource Management**: Always call `stop()` when done to clean up the Java process:
+```javascript
+try {
+  await validator.start(config);
+  // ... validation operations
+} finally {
+  await validator.stop();
+}
+```
+
+2. **Process Termination Handling**: Handle graceful shutdown:
+```javascript
+process.on('SIGINT', async () => {
+  await validator.stop();
+  process.exit(0);
+});
+```
+
+3. **Reuse Validator Instance**: Start the validator once and reuse for multiple validations:
+```javascript
+const validator = new FhirValidator('./validator_cli.jar');
+await validator.start(config);
+
+// Validate multiple resources
+const result1 = await validator.validate(resource1);
+const result2 = await validator.validate(resource2);
+const result3 = await validator.validate(resource3);
+
+await validator.stop();
+```
+
+4. **Timeout Configuration**: Set appropriate timeouts for startup in production:
+```javascript
+await validator.start({
+  // ... other config
+  timeout: 120000 // 2 minutes for production environments
+});
+```
+
+## Testing
+
+The library includes comprehensive tests. You can run them in different ways depending on your setup:
+
+### Unit Tests Only
+```bash
+npm run test:unit
+```
+
+### Integration Tests (requires JAR file)
+```bash
+# Set the JAR path and run integration tests
+FHIR_VALIDATOR_JAR_PATH=./your-validator.jar npm run test:integration
+```
+
+### Manual Testing
+```bash
+# Quick manual test with your JAR
+FHIR_VALIDATOR_JAR_PATH=./your-validator.jar npm run test:manual
+```
+
+### Configuration
+
+The JAR file location can be configured using the `FHIR_VALIDATOR_JAR_PATH` environment variable:
+
+```bash
+# Option 1: Set environment variable
+export FHIR_VALIDATOR_JAR_PATH=/path/to/your/validator.jar
+npm test
+
+# Option 2: Inline with command
+FHIR_VALIDATOR_JAR_PATH=./validator_cli.jar npm test
+
+# Option 3: Use npm script helper
+npm run test:with-jar
+```
+
+**Default behavior**: If no environment variable is set, tests will look for `./validator_cli.jar`
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Java not found**: Ensure Java is installed and available in PATH
+2. **JAR file not found**: Verify the validator JAR path is correct
+3. **Port conflicts**: Change the port if 8080 is already in use
+4. **Memory issues**: Add JVM options by modifying the spawn command if needed
+5. **Network timeouts**: Increase timeout values for slow networks
+
+### Debug Logging
+
+The library logs validator stdout/stderr for debugging. Check console output for Java process messages.
+
+## Support
+
+For issues with this wrapper, please file a GitHub issue.
+For FHIR validator issues, see the [official FHIR validator documentation](https://confluence.hl7.org/spaces/FHIR/pages/35718580/Using+the+FHIR+Validator).