IHE FHIR Profile Publication/Creating new Profiles

From IHE Wiki
Revision as of 04:12, 30 September 2018 by Costateixeira (talk | contribs)
Jump to navigation Jump to search

Getting Started – Using the default content

These are the steps to create another implementation guide from the base profile. To provide an example, we describe how to change the profile “base” to a new profile called “mmm”. Of course you can use an name as long as the file names match the references.

  1. Copying / renaming implementation guide
  2. Adding pages
  3. Adding resources

The details:

Copying / renaming implementation guide

Rename (or copy) the “base” folder to “mmm”

Rename the file “base.xml” to “mmm.xml”. Compared to the “base” profile, we end up with this:


Edit the mmm.xml and change the id, url, and optionally name as appropriate:


<?xml version="1.0" encoding="utf-16"?>
<ImplementationGuide xmlns="http://hl7.org/fhir%22>

  <id value="base" />   <url value="http://ihe.net/fhir/base%22 />   <name value="ImplementationGuide5" />   <status value="draft" />



<?xml version="1.0" encoding="utf-16"?>
<ImplementationGuide xmlns="http://hl7.org/fhir%22>

    <id value="mmm" />     <url value="http://ihe.net/fhir/mmm" />     <name value="Mobile Medication Management" />     <status value="draft" />


At this moment you can rebuild to make sure things still work ok.

Adding pages

You can add pages under the top page, which is the Table of Contents.

It is recommended to keep page named “index” – you can change the existing index.xml page if you want.

Add the x(ht)ml file in the content\pagecontent folder, for example a “welcome” page.


Add an entry in the implementationGuide (mmm.xml) to point to the file you added.

 <page>      <nameUrl value="toc.html" />      <title value="Table of Contents" />      <generation value="html" />      <page>          <nameUrl value="index.html" />          <title value="Main Page" />          <generation value="html" />      </page>      <page>          <nameUrl value="welcome.html" />          <title value="Welcome Page" />          <generation value="html" />      </page>      <page>          <nameUrl value="artifacts.html" />          <title value="Artifacts" />          <generation value="html" />      </page>  </page>

  1. == Adding resources ==
    1. === place the resource as an XML file in the content\resources folder, ===


place a reference in the implementation guide file (mmm.xml).

Just add a section like this. Make sure you point to a package that exists in the mmm.xml file.

         <resource>             <reference>                 <reference value="CapabilityStatement/ihe-mmm-requestplacer" />             </reference>             <name value="IHE MMM Request placer" />             <description value="Request Placer Specifications" />             <package value="Package1" />         </resource>

<?xml version="1.0" encoding="utf-16"?>
<ImplementationGuide xmlns="http://hl7.org/fhir%22>

    <id value="base" />     <url value="http://ihe.net/fhir/base%22 />     <name value="Base Profile" />     <version value="0.2.1" />     <status value="draft" />     <experimental value="false" />     <date value="2018-01-01T00:00:00.000+02:00" />     <jurisdiction>         <coding>             <system value="urn:iso:std:iso:3166%22 />             <code value="US" />         </coding>     </jurisdiction>     <packageId value="ihe.fhir.base" />     <license value="Apache-2.0" />     <fhirVersion value="3.5.0" />     <definition>         <package>             <name value="Package1" />             <description value="Package" />         </package>         <resource>             <reference>                 <reference value="CapabilityStatement/ihe-base-requestplacer" />             </reference>             <name value="ihe-base-requestplacer" />             <description value="Request Placer Specifications" />             <package value="Package1" />         </resource>         <resource>             <reference>                 <reference value="StructureDefinition/medication-request" />             </reference>             <name value="Medication Request" />             <description value="Medication Request Specifications" />             <exampleBoolean value="false" />             <package value="Package1" />         </resource>         <page>             <nameUrl value="toc.html" />             <title value="Table of Contents" />             <generation value="html" />             <page>                 <nameUrl value="index.html" />                 <title value="Main Page" />                 <generation value="html" />             </page>             <page>                 <nameUrl value="artifacts.html" />                 <title value="Artifacts" />                 <generation value="html" />             </page>         </page>     </definition>