This wiki has undergone a migration to Confluence found Here

Difference between revisions of "FHIR Implementation Guide Authoring"

From HL7Wiki
Jump to navigation Jump to search
(Created page with "= Steps = Execute the following steps to create an IG == Install the Build Tools == Setting up the Build == Adding an Implementation Guide to the...")
 
(Migrate Content to Confluence/Added Forward Link)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Steps =
+
Content on this page has been migrated to Confluence here: https://confluence.hl7.org/display/FHIR/FHIR+Implementation+Guide+Authoring
 +
 
 +
<br />
 +
=Steps=
 
Execute the following steps to create an IG
 
Execute the following steps to create an IG
== Install the Build Tools ==
+
==Install the Build Tools==
 
[[FHIR_Build_Process#Set_up|Setting up the Build]]
 
[[FHIR_Build_Process#Set_up|Setting up the Build]]
== Adding an Implementation Guide to the Build ==
+
[[ Proposed new FHIR IG build Process]]
 +
 
 +
==Adding an Implementation Guide to the Build==
 +
 
 
#Assign an identifier to the IG (e.g., gao)
 
#Assign an identifier to the IG (e.g., gao)
 
#Add a folder to the guides folder with that identifier
 
#Add a folder to the guides folder with that identifier
Line 9: Line 15:
 
#Add its overview html page as gao.html to that folder
 
#Add its overview html page as gao.html to that folder
 
#Add a new line to source\igs.xml in the form:
 
#Add a new line to source\igs.xml in the form:
 +
 
   &lt;ig code="gao" name="Guideline Appropriate Ordering" brief="GAO" source="\guides\gao\gao.xml" committeereview="0" committee="cds" ballot="draft" fmm="0"  
 
   &lt;ig code="gao" name="Guideline Appropriate Ordering" brief="GAO" source="\guides\gao\gao.xml" committeereview="0" committee="cds" ballot="draft" fmm="0"  
 
   section="K"/&gt;
 
   section="K"/&gt;
 
Where code is the identifier you created above
 
Where code is the identifier you created above
== Dealing with Resource Locations in Forge ==
+
==Dealing with Resource Locations in Forge==
 
If you used Forge to create the IG, when you save it, the build will NOT know where to find your files.
 
If you used Forge to create the IG, when you save it, the build will NOT know where to find your files.
 
In the XML file, you will need to change:
 
In the XML file, you will need to change:
Line 24: Line 31:
 
If your resource profile is in guides\StructureDefinition\gao-order.xml
 
If your resource profile is in guides\StructureDefinition\gao-order.xml
  
Having made this change, you can no longer edit your IG in Forge, and will have to switch it back.  An XSLT is available [[file:switcheroo.xsl]] to go back and forth between these two formats.  A newer version of Forge will eventually support sourceUri correctly.
+
Having made this change, you can no longer edit your IG in Forge, and will have to switch it back.  An XSLT is available [[file:switcheroo.txt]] to go back and forth between these two formats.  A newer version of Forge will eventually support sourceUri correctly.
  
== Cheating the build ==
+
==Cheating the build==
 
Comment out the other IGs in your local copy of igs.xml and you won't have to build them.  Eventually the build tools will support building a guide.
 
Comment out the other IGs in your local copy of igs.xml and you won't have to build them.  Eventually the build tools will support building a guide.

Latest revision as of 15:38, 30 October 2019

Content on this page has been migrated to Confluence here: https://confluence.hl7.org/display/FHIR/FHIR+Implementation+Guide+Authoring


Steps

Execute the following steps to create an IG

Install the Build Tools

Setting up the Build Proposed new FHIR IG build Process

Adding an Implementation Guide to the Build

  1. Assign an identifier to the IG (e.g., gao)
  2. Add a folder to the guides folder with that identifier
  3. Add the guide as gao.xml to that folder
  4. Add its overview html page as gao.html to that folder
  5. Add a new line to source\igs.xml in the form:
 <ig code="gao" name="Guideline Appropriate Ordering" brief="GAO" source="\guides\gao\gao.xml" committeereview="0" committee="cds" ballot="draft" fmm="0" 
  section="K"/>

Where code is the identifier you created above

Dealing with Resource Locations in Forge

If you used Forge to create the IG, when you save it, the build will NOT know where to find your files. In the XML file, you will need to change:

     <sourceReference>
       <reference value="http://hl7.org/fhir/StructureDefinition/gao-order" />
     </sourceReference>

To look like:

     <sourceUri value="gao-order.xml" />

If your resource profile is in guides\gao\gao-order.xml, Or:

     <sourceUri value="StructureDefinition/gao-order.xml" />

If your resource profile is in guides\StructureDefinition\gao-order.xml

Having made this change, you can no longer edit your IG in Forge, and will have to switch it back. An XSLT is available File:Switcheroo.txt to go back and forth between these two formats. A newer version of Forge will eventually support sourceUri correctly.

Cheating the build

Comment out the other IGs in your local copy of igs.xml and you won't have to build them. Eventually the build tools will support building a guide.