Guidance
Welcome! 👋
Exercises
🔨 In this tutorial we will create:
- A development home on Simplifier.net for our FHIR specification, called a FHIR Development project
- Documentation in the form of an Implementation Guide
- Ensure the quality of our project by running quality control rules
- A stable release of our FHIR specification in the form of a FHIR Package
- A stable release of our Implementation Guide
We will reuse the resources from the earlier FHIR profiling tutorial with Forge.
General help information:
#1 Creating the FHIR project 📁
First we need a FHIR project to create our Implementation Guide in and create our package from:
If you don't yet have a Simplifier.net account, create one for free.
Log in to Simplifier.net and go to your Portal: click on your Avatar on the top-right and go to Portal.
Create a new Simplifier.net project or reuse an existing project.
Make sure that you set FHIR Version to R4 and Scope to Test.
#2 Configure the project 📐
Now we will configure the project and make it pretty:
Go to the Dependencies tab and set the packages on which your project depends.
Click Manage and search for the necessary packages and click Add.
For this project we will need at least package
hl7.fhir.us.core
, version3.2.0
.Once the list is complete, click Save.
Optional: Now let's make your FHIR project a bit prettier:
On the Introduction tab of your project, click on the lower-right main panel, to edit the description of your project. You can use Markdown here, to make this as complete as possible. You can even embed images here, we'll learn later how.
In the top-right menu bar click on Manage and then Canonical Base URLs. Here you can clarify whith what domain your canonical URLs always start, for example
http://<yourname>.<yourcountryextension>/fhir/
. Make sure this is a domain name that you, or your employer, owns.Finally, via Manage you can also upload a nice image as the Avatar for your project.
#3 Uploading FHIR resources to the project 📤
We are starting with a basis for this tutorial, by downloading the FHIR development project you are currently looking at and importing it to your project:
Download the current project by selecting Download on the top-right of this page and clicking Zip project.
Go to your own previously created project, select Upload > Upload file and upload the downloaded Zip file.
Now let's get ready to start editing the Implementation Guide:
Find the ImplementationGuide resource on the Resources page of your project and click to go to its page.
Select Update > Edit: Create IG and start updating in IG Editor. Your Implementation Guide will now be visible on the Guides tab of your project and is ready for editing!
Start editing an existing Implementation Guide resource in Simplifier.net
#4 Complete the Implementation Guide 📃
Help information for this step:
- In the Implementation Guide Editor you can find a Help menu on the bottom left.
- Every page of your IG is a text resource in your project. You can look at current pages how they were built up, by downloading them or copying their contents.
- Generic information on how to format text with Markdown.
Let's make the Implementation Guide more complete by adding a few more pages and content on them:
On the Guides tab click to Edit the Implementation Guide
First, let's work on the settings, by clicking the little gear icon ⚙
Give the IG an appropriate Title, Description and Version
Select the style you prefer for your IG
Now, let's work on the content. When you Browse your Implementation Guide you can see the section on FHIR Artifacts is already quite complete. But the page on HospitalXCondition only has a start. Minumum requirements:
On the page for the HospitalXCondition profile, add an interactive rendering of the snapshot of the profile.
Add a new page for the Patient example instance under Examples and embed the XML code of it.
Add at least one embedded image in a page of your choice.
#5 Publishing the FHIR Package 🎁
Now we are going to release a stable versioned version of our specification to the world:
Go to the Packages tab of your project and Create a new package.
Important:Choose a package name in your own name space. For example:
<yourname>.<yourcountrycode>.publishingtutorial
Use a version number ending in
-something
, for example0.0.1-test
. In this way you will not confuse anyone with a test package when they search for real FHIR work.
#6 Update scope of the Guide to the released package ✅
Finally, we can point our Implementation Guide to our package, instead of our development versions of the resources in the project:
- In the settings of your Implementation Guide you can now update the Scope, to point to the resources in your just created package. In this way the documentation won't change while you are preparing for a next release of the specification!
Congratulations! 🎉 You have now created a FHIR development project, created documenation around it and published a stable version of both so it can be used by the world.
Want to know more? Reach out to Firely to learn more about what we can do to help you bring FHIR to life.