IG Design Overview

  1. Create/Open an ImplementationGuide (Project).
  2. Create ValueSets and CodeSystems in the UI.
  3. Create profiles (StructureDefinition resources) in UI. Create elements and constrain them to value sets created in step #2.
  4. Import images into the IG to insert into narrative.
  5. Create narrative pages for the IG.
  6. Mark example resources as “example” with optional subject/context.
  7. Publish the IG.
  8. Review the published IG.
  9. Review the QA results and resolve errors.
  10. Export as HTML package and store in GitHub.

Create Implementation Guide

  1. Open and log into Trifolia-on-FHIR.
  2. Select File > New Project.
  3. Specify an ID that is unique to your IG (e.g., test-ig).
  4. Specify a URL unique to your IG (e.g., http://test.com/fhir/implementationguide/test-ig). The last leaf/level of the URL should match the ID to prevent errors during publishing.
  5. Specify a name for your IG. This is the computable format of the name, used similarly (but not the same) as the ID.
  6. Specify a title for your IG. This is what is displayed to readers of the IG.
  7. Specify a Package ID. If developing an HL7 IG, you will receive this information pending PSS approval.
  8. Define permissions using the “Permissions” tab.
  9. Save the IG. It is now set as the project you are working on.

Create Narrative Pages

  1. Click Browse/Edit > Edit Implementation Guide.
  2. Select the “Narrative/Pages” tab.
  3. Provide a high-level description of the implementation guide, if desired. If no narrative pages are specified (see Step 4), then the IG’s home page will use this description.
  4. Scroll to the bottom and click the “Add Narrative Page” button. This will create an index page that represents the home page for your IG. When you edit this page, ToF can automatically generate the content for the home page (index) based on the description of the IG. You can also specify custom content displayed on the home page.
  5. Click the “+” on the index/home page to create child pages.
  6. The “Downloads” template is available to add to your IG and customize, which will provide default content for a “Downloads” page.
  7. Select “Show on top navigation bar” and specify a navigation menu name for the pages you want to appear on the top menu of the published IG.
  8. When editing a page, you can click the icon that represents multiple images to insert imports.

Import Images

  1. Click the “Import” menu from the top navigation menu.
  2. Drag-and-drop image files from your computer to the import window.
  3. Click “Import.”

Identify Examples

  1. Click Browse/Edit > Edit Implementation Guide.
  2. Select the “Resources” tab.
  3. Click “Edit” next to an example resource.
  4. Select “Example = Yes” or select a profile to set an example.
  5. Click “Done.”
  6. “Save” the IG after updating resources.

Publish

  1. Click the “Publish” menu from the top navigation menu.
  2. Select the options for your publication.
  3. HL7 requires the latest IG publisher for ballots. The IG publisher updates occasionally include bugs, which leads to errors. You can select “No” pending resolution.
  4. Selecting “No” for “Use terminology server” can quicken the publish execution, assuming you’re not worried about terminology.
  5. Indicating “Yes” for “Download?” will offer the entire published package as a download to your computer when complete.
  6. Click “Publish.” This process can be time-consuming, depending on the size of your IG. Please be patient. Once published, you can view the IG with the link on the status screen. Alternatively, you can select Browse/Edit > View Implementation Guide.

Create Terminology

Create a new value set or code system:

  1. Select Browse/Edit > Value Sets and/or Code Systems.
  2. Select the blue “+” button in the top-right to create a new value set or code system.
  3. Specify the details of the value set and/or code system.
  4. Save the value set or code system. The value set or code system is automatically associated with your IG.

Locate existing value sets or code systems:

  1. Select Browse/Edit > Edit Implementation Guide.
  2. Select the “Resources” tab.
  3. Select the “hand/pointer” icon in the top-right to add an existing resource.
  4. Un-check “Showing resources for the “Test IG” implementation guide.”
  5. Filter/Find then select the value set or code system.

Import a ValueSet from VSAC:

  1. Select “Import” on the top navigation bar
  2. Select the “VSAC” tab
  3. Specify your VSAC credentials
    Your credentials are never sent to ToF servers, they are used only by your browser to communicate with VSAC; they do not leave your computer, aside from being sent to VSAC for authentication.
  4. Specify the OID for the value set you would like to import.
  5. Click “Import”.
  6. Assuming the value set is found, it will be imported and automatically associated with your IG.

Create Profiles

  1. Select Browse/Edit > Profiles/Extensions.
  2. Click the blue “+” icon in the top-right of the screen.
  3. Indicate the URL for the profile. The beginning of the URL should match the IG’s URL (e.g., http://test.com/fhir/structuredefinition/my-profile if the IG is http://test.com/fhir/implementationguide/test-ig).
  4. Verify the ID matches the end of the URL. This should auto-populate when you enter the URL
    (e.g., “my-profile” for the above URL example)
  5. Specify a name and title, which the published IG will display.
  6. Indicate the “type” of resource this profile constrains (e.g., “Patient”).
  7. You may want to build your profile based on another profile. Specify a “Base Profile” that exists in the system.
  8. Click “Save.”
  9. Click the “Elements” tab.
  10. Select an element to constrain.
  11. Click “Constrain Element” in the right panel.
  12. Re-define the element in the right panel to specify the difference between the element and the base definition.
  13. Repeat for all constraints.
  14. Define a description for the profile, which the published IG will display to the reader.
  15. Save the profile.

Reverting to a previous version of a resource in Trifolia on FHIR

  1. In the resource(IG, Profile, Value Set, etc) Editor, navigate to the History tab
  2. Find the version of the resource you wish to restore
  3. Select the “Revert” option to the right of the "Save" button to undo any unsaved changes
  4. Select the "Restore" option by clicking the up arrow to the right of "Comparing version E to version #"  to review the history of a resource and restore a previously saved version.
  5. Save the IG in order for the restored version to persist