PLUGIN Implementation Guide

Getting started (with contributions to this IG)

Step 1 - Install required software

sushi This project uses FSH and sushi. Therefore, it requires Node.js. The IG Publisher additionally requires Java to be present on the system.

Installing sushi is detailed here. The following command might be sufficient if you're already working with nvm:

npm install fsh-sushi

IG Publisher The IG Publisher requires Java and Jekyll to be installed.

# Generally a good idea
sudo apt update

# Java
sudo apt install openjdk-17-jre

# Jekyll
sudo apt-get install graphviz jekyll

[!TIP] If you're using zsh, be sure to change to above files accordingly!

Step 2 - Clone the repo, and initialize publishers.

# Clone the repo
git clone https://github.com/plugin-healthcare/implementation-guide.git
cd implementation-guide

# Adding executable permissions may or may not be required
chmod +x _updatePublisher.sh

# Install/update the Implementation Guide publisher.
./_updatePublisher.sh

Step 3 - Compile the IG

# Adding executable permissions may or may not be required
chmod +x _genonce.sh

# Run sushi and subsequently the IG Publisher.
./_genonce.sh

Troubleshooting

If sushi complains about snapshots ("Structure Definition http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient is missing a snapshot. Snapshot is required for import."), please follow these steps:

1. Download the package nictiz.fhir.nl.r4.nl-core with snapshots from Simplifier.
2. Overwrite the contents of ~/.fhir/packages/nictiz.fhir.nl.r4.nl-core#0.10.0/package with the contents of the downloaded tgz.
3. Re-run sushi.

[!warning] The above uses version 0.10.0 of the nl-core package. Please note that version numbers may have changed the meantime.