IHE FHIR Profile Publication/Getting Started

From IHE Wiki
Jump to navigation Jump to search

Publishing the Base profile

The base profile is the base template for IHE work – it provides a “vanilla flavour” profile with minimum working content.

Install the dependencies

For running this process, you need a few things in your machine:

  1. Java – install the JRE from here: http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html

  2. Jekyll (including Ruby)

    1. https://jekyllrb.com/docs/installation/

Get the publisher running

The recommended way is to get your system up to speed is to start with a known good configuration. This can be found in the links below (a repository will be added later).

  1. Create a base folder for your profile – this is your “parent” folder, where all the content will be stored.

  2. Create or get the “content” folder. To do this you can

    1. start with the base template that has a minimum content. Download this file, and unzip to your base folder. It will create the “content” folder and the sub-folders.

    2. If you want, you can create the “content” folder and its sub-folders manually:

      1. “images” folder for the images and other binaries

      2. “pagecontent” folder for the page text

      3. “resources” folder for fhir resources

      4. the ImplementationGuide xml file (in our example, the base.xml) will be in the “content” folder. A minimum ImplementationGuide is shown below.

  3. Download the IHE IG template from here, and unzip to your base folder. It will create the “publish” folder and some sub-folders. Besides the template, this includes a script that downloads and runs the publisher.

If your profile folder is called "base", your folders should now look like this (check that they do and fix it otherwise it won’t work):


  1. Go to publish folder and run the BUILD.bat file. It will take a while -up to a few minutes to download the IG publisher


After some time (1 minute to several minutes, depends on the content and your machine), it should inform you of the successful build:


Checking the Output

If the build was successful, the result is in the folder publish/output/index.html

Open this file on the browser and you will see the result as if it were published on the IHE web server: