This fragment is available on about.html
| Type | Reference | Content |
|---|---|---|
| web | github.com | How to Publish a FHIR Implementation Guide, published by Argentix Informatics, Inc.. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ElliotSilver/how-to-publish/ and changes regularly. See the Directory of published versions |
| web | argentixinfo.com |
IG © 2024+ Argentix Informatics, Inc.
. Package ca.argentixinfo.howtopub#1.2.0 based on FHIR 4.0.1
. Generated 2025-12-01
Links: Table of Contents | QA Report | Propose a change |
| web | github.com | Links: Table of Contents | QA Report | Propose a change |
| web | fhirnorth.mohawkcollege.ca | This Implementation Guide was originally presented during FHIR North , on October 23, 2024. |
| web | github.com | For questions or comments about this Style Guide, please contact the author , or propose a change via Github. |
| web | argentixinfo.com |
How to Publish a FHIR Implementation Guide
is © 2024 Argentix Informatics, Inc.
and is licensed under
CC BY-SA 4.0 |
| web | argentixinfo.com |
How to Publish a FHIR Implementation Guide
is © 2024 Argentix Informatics, Inc.
and is licensed under
CC BY-SA 4.0 |
| web | creativecommons.org |
How to Publish a FHIR Implementation Guide
is © 2024 Argentix Informatics, Inc.
and is licensed under
CC BY-SA 4.0 |
| img | mirrors.creativecommons.org | |
| img | mirrors.creativecommons.org | |
| img | mirrors.creativecommons.org | |
| web | github.com | Benefits of GitHub pages publication ( #1 ) |
| web | github.com | Strengthen mention of tagging releases ( #2 ) |
| web | github.com | Discussion of when to publish ( #3 ) |
| web | github.com |
New parameters
clone-xml-json
and server type cloud
( #4
)
|
| web | github.com |
Many implementation guide (IG) authors are familiar with using HL7
’s IG Publisher
to author and build an implementation guide. However the process of actually “publishing” an authored IG is less familiar to many. To make an IG available to the public (or at least to a larger audience than the author), it should be on an accessible website. Further, various FHIR tooling depends being able to find an IG and its packages listed in the central registries. This IG documents the process of publishing an IG to a website using IG Publisher. It also discusses the differences between “publishing” a FHIR IG by simply uploading the IG build output to your web server; and, by uploading the results of the IG Publisher -go-publish
functionality.
|
| web | fshschool.org | This IG is not a tutorial on IG authoring; on general IG Publisher usage; or, on related tooling, such as SUSHI . |
| web | fire.ly | Alternatively, the IG could be authored and published through Firely ’s Simplifier product. |
| web | fhirnorth.mohawkcollege.ca | Note: This guide was originally presented as a session at FHIR North 2024 : |
| web | github.com |
IG Publisher users who store their projects on Github
can make use of the IG auto-build
to “publish” their IG to the FHIR continuous integration site under build.fhir.org
. This is a convenient way to allow others to see your implementation guide.
|
| web | github.com |
IG Publisher users who store their projects on Github
can make use of the IG auto-build
to “publish” their IG to the FHIR continuous integration site under build.fhir.org
. This is a convenient way to allow others to see your implementation guide.
|
| web | example.com |
“Canonical redirect” is the resolution of the canonical URLs which identify the IG as well as IG profiles, CodeSystem, ValueSet, and so on, to the appropriate content. For example, the url
http://example.com/ig/myig/StructureDefinition/MyPatient
is expected to return an HTML descriptive page, or JSON- or XML-formatted StructureDefinition resource representation depending on the web request. This capability depends on both the IG being published at the location that the canonical URL references, and having appropriate website configuration or redirect scripts.
|
| web | github.io |
To make your content available, another option is to upload the contents of the IG Publisher-generated output
directory directly
to a web server, or to copy it to Github Pages
. (Setting up automated builds and copying to Github Pages is covered in the author’s blog
.)
|
| web | www.argentixinfo.com |
To make your content available, another option is to upload the contents of the IG Publisher-generated output
directory directly
to a web server, or to copy it to Github Pages
. (Setting up automated builds and copying to Github Pages is covered in the author’s blog
.)
|
| web | fire.ly | One of key and early decisions in authoring an IG is whether to use HL7’s IG publisher or Firely ’s Simplifier . Factors to consider between the two include: |
| web | fire.ly | Integration with resource authoring tools such as Firely’s Forge or HL7’s FSH language compiler, SUSHI . (Both tools can be used with either publication mechanism) |
| web | fshschool.org | Integration with resource authoring tools such as Firely’s Forge or HL7’s FSH language compiler, SUSHI . (Both tools can be used with either publication mechanism) |
| web | github.com |
As a pre-requisite for the processes described in this guide, you should have write access to a website that you control, and be familiar with the process for uploading content to it. This guide assumes your publication website aligns with the canonical URLs for your IGs. (Alignment of canonicals is not strictly necessary; however, this is the most common approach, and some functionality won’t work unless the canonicals align.) You should also be familiar with basic use of the IG Publisher, use of the git
source control tool, and have access to the Github
website. Github access is needed to obtain or modify certain HL7 resources. The guide describes use of Github to manage your IG as well, however you may use other (or no) content management tools for your IG and publication.
|
| web | 127.0.0.1 | The IG is accessible at http://127.0.0.1:4000 . |
| web | example.org |
Upload the contents of the webroot
directory to your website ( http://example.org/ig
), and review the publication.
|
| web | hl7.github.io | Getting Started with IG Publisher |
| web | github.com | IHE build process |
| web | www.youtube.com | Josh Mandel on Understanding FHIR IG Publication History |
| web | github.com |
Clone the HL7 history
, web templates
, and FHIR IG registry
repositories. You’ll need to commit changes to the ig-registry
repo, so you may need to fork the repo if you have insufficient privileges.
|
| web | github.com |
Clone the HL7 history
, web templates
, and FHIR IG registry
repositories. You’ll need to commit changes to the ig-registry
repo, so you may need to fork the repo if you have insufficient privileges.
|
| web | github.com |
Clone the HL7 history
, web templates
, and FHIR IG registry
repositories. You’ll need to commit changes to the ig-registry
repo, so you may need to fork the repo if you have insufficient privileges.
|
tree-filter.png
|