Create my first FHIR Implementation Guide using Simplifier

The much appreciated beta testers of Simplifier can use the new Implementation Guide (IG) editor. To become a beta tester, follow the instructions on this link! In this blogpost I will show you how to make an IG using Simplifier. For your IG, you can use your own resources and/or any of the publically available resources placed on Simplifier. This IG makes use of my project’s resources  which I uploaded by a link to my GitHub repository. In a former blog, I showed how to link a project to a GitHub repository.

Step 1 – Create an IG

As a beta tester the ‘Implementation Guides’ tab in your portal will be visible. Click the big green button and provide a title to create your first IG. The IG will appear in the menu with the options Browse, Edit and Delete. The Edit button opens the IG editor.

1.IGblog

Personal portal in Simplifier

Step 2 – Define the outline of your IG

The IG editor opens with the root page. On this page you can adjust the title and select one of two IG rendering format. For now, we leave it at the default ‘Two Level Menu’. Feel free to experiment! Add a child page to the root element by clicking the icon that appears when you hover above the tree elements in the left section of the IG editor. Give the newly made page an appropriate name. Add more base and child pages to make the outline of your IG.

In our ‘Two Level’ rendering format, the first level elements will form the navigation bar in the top of the IG. If you add child pages to one of those elements, that section of the navigation bar will have a dropdown menu, which will include it’s child pages. A third level will form the different paragraphs, including a navigation menu on the side. Please experiment with these multiple levels of pages, and let us know what you think!

Step 3 – Provide the content of your IG

You can fill the IG content in a fast and good-looking way thanks to the Markdown based editor and Simplifier’s resources. For the use of Markdown features in this editor I would like to refer you to this page or Google. Use the preview on the right section to see the progress of your work of the current page. Click on the “Preview” button to preview the entire IG. Simplifier automatically saves your work so don’t worry if you leave the editor or if you cannot find the save button (it is not there!). In the last part of this blog, I will elaborate further on how to include publicly available resources on Simplifier.

Step 4 – Include rendered resources from Simplifier

In my IG, I want to include the rendered trees and tables of the FHIR StructureDefinitions in my project SIG. One of them is a profile on an Observation resource named LabObservationNorway and is located at https://simplifier.net/SIG/LabObservationNorway4. Therefore, I type the statements {{tree:SIG/LabObservationNorway4}} and {{table:SIG/LabObservationNorway4}} in the editor on the page named ‘LabObservationNorway’. To see the result in the preview section press  ‘Ctrl+Enter’ or refresh the page with the button on the right. Next, let’s include a link to an example instance of this profile. This works in a same manner using the location on Simplifier. The statement {{link:SIG/Observation-example9}} will give a link to that particular example.

The IG editor has more statements that can be used. The {{structure:project/resource}} statement gives another version of the rendered tree. For example, it has a different layout and allows you to collapse the tree. This rendering, however, is at the moment still work in progress. Moreover, it is possible to include table of contents anywhere in the IG. There are two variations, one contains all pages of the IG ( {{index:root}} ) and the other contains a table of contents of the current pagee( {{index:current}} ). Lastly, {{namingsystems:project}} will list all the NamingSystems of a project. More options within the IG editor will follow. If you have any suggestions, let us know!

4.IGblog

IG Editor

Finally

Simplifier’s IG editor lets you combine FHIR resources together with textual guidance in an fast, coherent and straightforward way, thereby creating a useful and easy to read IG. The above mentioned example IG can be found here. If you haven’t done so already: become a beta tester to create your own IG and play around yourself. Keep in mind that the IG editor is still a beta feature and improvements can be expected. Feedback is much appreciated and can be easily provided through the feedback button on the top right.

Advertisements

One thought on “Create my first FHIR Implementation Guide using Simplifier

  1. Pingback: FHIR Implementation Guides in Simplifier.net | The Fhirplace

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s