Package management

Simplifier.net offers functionality to handle packages and dependencies. This functionality allows you to publish packages based on your project resources, which can be immediately installed and used by people implementing your profiles. The Simplifier FHIR package server is NPM compatible. You may either connect to this server using a NPM client or use our cross platform FHIR command line tool called Firely Terminal. On this page we will explain how to manage packages and dependencies in Simplifier, how to use Firely Terminal to install packages for validation, how to manage packages and how to create your own packages in Firely Terminal.

Packages

View packages

Visit the Packages tab of any Simplifier project to see which packages are available in this project. For more information about a package and its content, click on the name of the package.

The Introduction page will give you an overview of the package:

  • Install instructions; shows the command you need to install the package, click on the blue copy icon to copy it to your clipboard. Click on Firely Terminal or NPM to switch to your preferred tooling.

  • Release notes; shows the release notes given by the author of the package.

  • Dependencies; shows the dependencies to other packages.

  • History; shows the previous versions of the package, click on a version name to see the details.

  • Info; shows information about when the package was created, a link to the project it is part of and a download button to download the package.

_images/Packages_introduction.PNG

Switch to the Files tab to see the content of the package.

_images/Packages_files.PNG

Publish packages

Visit the Packages tab of your project and click on Create > Create new package to create a new package. Provide a name, version number, description and release notes for your package. Note that the name of your package should include at least one dot. Indicate if your package is a prelease package or not and click Create to publish your package. To create a new version of an existing package, click on Create and select Create new version for.. followed by the name of your package. Add the required information and click Create to publish the new version of your package.

_images/PackageCreate.png

Dependencies

View dependencies

Visit the Dependencies tab of any Simplifier project to see a list of its package dependencies as well as indirect dependencies. Click on the name of one of the listed packages to see the details of this package. This will show the information as explained in the View Packages section.

_images/PackageDependencies.PNG

Add dependencies

Visit the Dependencies tab to add dependencies to your project. There are two ways to do so. One way is to browse Simplifier for existing packages and add them to your project. The other way is to directly edit the JSON code.

Click Manage to search for existing dependencies. Type a search string in the search box and select a package and its version from the search results. Click Add to add the package to your project. When you are finished adding packages click Save to save the changes to your project.

_images/ManagePackageDependencies.PNG

Click Edit to directly edit the JSON code and add the packages and their version to dependencies.

_images/EditPackageDependencies.PNG

Remove dependencies

To remove dependencies from your project, you could either select Manage and click on the recycle bin icon next to the package you want to remove or select Edit to directly edit the JSON code.

Firely Terminal

Firely Terminal is our (free) command line tool for FHIR. Firely Terminal allows you to communicate with any FHIR server. With simple commands you can easily download, upload, validate and transform resources, zip them, bundle them or split bundles. Firely Terminal offers many features. One of them is to install, create and manage FHIR packages.

Learn more about Firely Terminal and managing FHIR packages on the command line in particular.