Skip to content

FPL 0.1.0

Compare
Choose a tag to compare
@jafeltra jafeltra released this 11 Apr 17:43
· 26 commits to main since this release
a495874

FPL 0.1.0 is the initial release of FHIR Package Loader (FPL), a library for downloading FHIR packages locally and loading its definitions into memory. This library can be used within JavaScript or TypeScript projects, or it can be used through a Command Line Interface (CLI). For more details on the arguments and options available on the command line, see the README. FPL also provides an API, which can be used to download packages programmatically. For more information on how to use the API, see the README.

The initial release provides an initial implementation for downloading packages, but it is subject to change in future releases.

To install FPL, first install Node.js, then run:

npm install -g fhir-package-loader

After installing fhir-package-loader, fpl should be in your path:

$ fpl --help
Usage: fpl [options] [command]

CLI for downloading FHIR packages

Options:
  -v, --version                        output the version number
  -h, --help                           display help for command

Commands:
  install [options] <fhirPackages...>  download and unzip specified FHIR packages
  help [command]                       display help for command

Examples:
  fpl install hl7.fhir.us.core@current
  fpl install hl7.fhir.us.core@4.0.0 hl7.fhir.us.mcode@2.0.0 --cachePath ./myProject

FPL can be run to download specified packages to either the FHIR Cache or another specified directory locally:

$ fpl install hl7.fhir.us.core@current
info  Checking <HOME>/.fhir/packages for hl7.fhir.us.core#current...
info  Did not find hl7.fhir.us.core#current in <HOME>/.fhir/packages.
info  Downloading hl7.fhir.us.core#current... https://build.fhir.org/ig/HL7/US-Core/package.tgz
info  Downloaded hl7.fhir.us.core#current
info  Loaded package hl7.fhir.us.core#current