Template Implementation Guide - AU
0.0.2 - ci-build
Template Implementation Guide - AU
0.0.2 - ci-build
Template Implementation Guide - AU - Local Development build (v0.0.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://healthinfoservices.site/template-fhir-ig/ImplementationGuide/template.fhir.ig | Version: 0.0.2 | |||
| Draft as of 2025-09-25 | Computable Name: TemplateFHIRIG | |||
This is an Implementation Guide (IG) template is intended as a starting place for new FHIR projects. It provides a basic structure with a set of commonly used base FHIR profiles that can be readily modified and/or extended to meet the project requirements.
This version of the template includes dependencies on the Australian FHIR standards - AU Base (v5.0.0) and AU Core (v1.0.0). It is intended that a version of the template without jurisdiction specific dependencies will be subsequently created.
To configure your system to compile this code into an IG, follow the steps below.
This template is designed to make your getting started process as easy as possible… But if you are unfamiliar with FHIR, you are strongly recommended to first familiarise yourself with the basic concepts of FHIR resources. There are many tutorials and guides, but don't get lost in the weeds, the best way to learn is actually starting with a simple project.
Equally if you are not familiar with FHIR Shorthand (FSH) it would be good to follow a tutorial My recommendations are:
You will need to have the following software installed and configured on the system that you will be using for creating the IG.
To setup and deploy the IG, ensure that you have the pre-requisite software installed, and then follow the steps below.
git clone https://github.com/healthinfoservices/template-fhir-ig.git
sushi update-dependencies
Download the latest version of the HL7 FHIR IG Publisher tool into the cache.
(for Linux/Mac)
./_updatePublisher.sh
(for Windows CMD)
_updatePublisher
(for Windows Powershell)
./_updatePublisher.bat
sushi build .
Build the IG
(for Linux/Mac)
./_genonce.sh
(for Windows CMD)
_genonce
(for Windows Powershell)
./_genonce.bat
To customise this template for our own you will need to use a text editor to modify the following:
Change the information in the sushi-config.yaml file to set overall settings for your IG.
Using a text editor, you can adapt or extend the IG by editing the .fsh files in the input/fsh folder. You can also delete and .fsh files for profiles that you will not be using, and/or create new fsh files for additional profiles.
Using a text editor, modify the index.md. This creates the content for the home page of your IG.
Make use of the aliases.fsh file. It contains a set of aliases that you can use in your fsh files to prevent having to type in long url's.
After each modification to fsh or md files, run the following command: (for Linux/Mac)
./_genonce.sh
(for Windows CMD)
_genonce
(for Windows Powershell)
```sh
./_genonce.bat
You might find these links helpful:
Simple example profiles are included for the following resources:
This template is provided by HealthInfoServices to help those starting on their FHIR journey, and to make it more efficient for more experienced FHIR practitioners. Enjoy and please feel free to credit HealthInfoServices in your work.
Distributed under the MIT License. See LICENSE.txt for more information.