Page tree
Skip to end of metadata
Go to start of metadata


Publishing a FHIR IG

This process is followed by anyone when publishing a FHIR IG to http://hl7.org/fhir/

Pre-conditions

To follow this process, you must have:

You must also know how to run the IGPublisher locally

Record Keeping

All publication runs must be recorded in the [FHIR IG Publication Record]

When you being processing the publication request, create a new row in the sheet, and add the following columns:

  • Operator : Your name
  • IG Name : The formal name for the ballot or publication request
  • Publication Request: a link to the publication request that initiated the work (a link to confluence)
  • IG approval: a link to the IG approval by FMG (a link to confluence - if there isn't one, consult the FHIR product director and put "(n/a)")
  • PPS Link: a link to the original project approval (either confluence or project manager - if there isn't one, consult the TSC co-chair)
  • TSC Approval: a link to the TSC approval (if this is a formal publication, otherwise blank)
  • Primary Editor : the name of the editor who will handle any QA issues
  • IG Source : The github repository URL where the source is located - Check that the repository URL is HL7 (or an other wise approved Organization - consult CTO for approved list)
  • Branch: the branch that is being published (defaults to master)
  • new IG : "yes" if this is the first time that any version is being published for this IG (whatever version - draft or ballot)
  • Milestone?: "yes" if this a formal publication release (usually approved by TSC)

Checks

The following checks must be run. All these checks confirm that the various HL7 paper work which lives all over the place is all lined up, and that the IG correctly identifies itself as approved. Note that these records are all over the place, and it's really hard to work to get everything aligned, so expect to find problems.

0. Preparation

  1. Realm
  • IG Approved realm: enter the realm that FMG approved when the IG was approved 
  • Project Realm: enter the realm that was approved for the project under which this IG is approved. If the project realm does not match the IG realm, consult the FHIR Product Director or the TSC co-chair
  • Requested Realm - enter the realm that was specified in the publication request
  • IG Actual realm - enter the realm stated for "Realm Rules" in the QA page. Make sure it is lowercase. If it's not, or either the stated or the actual realm doesn't match the approved realm, consult the FHIR Product Director

2. Code

  • IG Approved Code: add the code as identified in the IG Approval page (note that the name of the github repository does not need to be the same)
  • IG Actual Code: add the code as stated in the QA page ("Publication Code"). If there is in error shown, or if the codes does not match what was approved, consult the FHIR product director (important: this code is case sensitive - make sure you check the case)

3. Version

  • Requested Version: enter the version requested in the publication request. 
  • Stated Milestone: if this is a milestone, the stated version (e.g. "STU 1") - you can get this from the version check in the QA file. If it is not populated, or doesn't match the publication request, consult the editor and/or TSC co-chair
  • Actual Version: copy this from the version specified in the "Version Check" row in the QA page. if there are any errors shown, or it doesn't match the requested version, consult the FHIR Product Director
  • Check the stated version against the sequence and the stated STU intent.
    • The major version should match the STU intent (per the NIB) and this should also match the sequence too.
    • If the publication is a milestone, there should be no label e.g. 2.0.0 for STU 2 in the sequence STU 2.
    • If the publication is not a milestone, there should be a ballot label e.g. 2.0.0-ballot. For the first ballot, the version label will simply be '-ballot'. Subsequent ballots of the same document will be -ballot2 -ballot3 etc.
    • FMG may authorise additional publications such as -draft and -preview. FMG approves the labels explicitly in this case 
    • If clarification is needed, either the FHIR Product director or the FMG co-chairs can advise.

4. Publishing Integrity

  • fill out the canonical from the Publication Code row in the QA page, and check that it's the same as http://hl7.org/fhir/{realm}/{code} - consult the FHIR Product Directory if it's not 
  • fill out the package id from the Publication Code row in the QA page, and check that the package id the same as hl7.fhir.{realm}.{code} - consult the FHIR Product Directory if it's not. Add the version (#version)
  • fill out the subdir column using the value from the version check row. if the value is ??, consult the FHIR product director
    • If it does not conform to the pattern YYYYMMM (with the date correct) or STU{X}, check with the FHIR product director
  • validate the location of the URLs listed in the package-list.json e.g. ci-build URL

5. Content quality

  • Check the QA page Quality Checks section. Specific things to review:
    • Publisher Version is identified, and not reported as out of date 
    • Publication Code: no errors reported
    • Realm Check:  FMG / US Steering committee checks this - can be ignored
    • Version Check: check no errors reported 
    • Dependency checks: no errors / issues identified 
    • HL7 Publication rules: no errors/issues identified 
    • HTA Analysis: this can be ignored (for now)
    • Previous version comparison: can be ignored 
    • Summary: copy to "QA Summary column"
      • if the error count > 0, refer to the FMG co-chairs or the FHIR Product director, unless you are sure that the list is unchanged from FMG approval 
  • Template checks
    • Check template currency (at end of Dependency Checks). The stated version for fhir.base.template must be 'current' or more recent than '0.2.1"
    • If there is no stated template, or it is older than 0.2.1, consult the FHIR product director 
    • record the fhir.base.template version in the spreadsheet
  • IG Review 
    • Open index.html, and check that the header shows the name of the IG and the ballot status correctly

ok. if you get to here, we are good to publish.

Local Build

Now that the main checks have been done, you need to do a local build. To do that, you need a copy of the IG Publisher - see IG Publisher Documentation for assistance

  • Download the latest igpublisher from https://github.com/HL7/fhir-ig-publisher/releases
  • Check sushi version using command "npm install -g fsh-sushi"

  • clone the github repository to your local drive = {clone}
    • you should call it {packageId}#{version}
  • run the IG publisher, clearing the terminology cache (run the publisher.jar -ig {clone} -resetTx -publish {url})
    • where {url} is the url that the guide will be published at (which is the path entered into the spreadsheet above}
  • check that the local {clone}/output/qa.html file matches the CI build qa.html 

You are now good to publish the IG

Publishing the IG

Note: Publish one IG at a time - finish the process for each IG before starting the next one.

  1. check that {registry}, {history} and {templates} are up to date (git PULL)
  2. run publisher.jar -go-publish -source {clone} -web http://hl7.org/fhir -registry {registry}\fhir-ig-list.json -history {history} -templates {templates} (If this process fails then consult the FHIR Product Director)
  3. At the end of the run, the IG publisher will provide a directory. Use FTP to copy all the files from that directory to /implement/standards/FHIR on hl7.org, overwriting any that already exist.
  4. The IG publisher might give you a list of files to delete on the server too - these must be deleted
  5. mark "yes" in the Published column
  6. If this is a milestone publication, let Lynn know that it's time to mark applied tasks as published, and considered for future use tasks as open (see Administering Specification Feedback Projects#Publishingissues)
  7. check the changes to {registry}/fhir-ig-list.json (use git diff) and fill out any missing information (look for ?? in the changes) - may need to talk to FHIR product director to decide what to put
  8. commit and push the changes to the FHIR IG registry to github to a new branch, let Grahame know, & mark "yes" in the Register IG column
  9. If this is a milestone publication (not for ballots) make an announcement on the https://chat.fhir.org/#narrow/stream/179240-Announcements/topic/FHIR.20Publication.20Announcement topic in Zulip using the following template:
  •  new Publication: [publication name] of the [IG Name] implementation guide: {canonical}/{subdir}
    

    e.g. New Publication: STU Update 3.2 of the QI-Core implementation guide: http://hl7.org/fhir/us/qicore/STU32/


6 Comments

  1. Lynn LaaksoIs this primarily 'internal HL7 process' or are any of these expected of IG publishers? I am wondering if we should move this to a broad category 'HL7 Staff (internal) Process'

    1. Brett, AFAIK this is internal HL7 process, as Grahame Grieve and I are the only ones with access to FTP to the production FHIR fileset.

  2. It would be great to have a similar documentation for those who are using the publisher to create non-HL7 hosted IGs for organizations wanting to create and host their own IGs.

  3. I agree with Bob Milius- as affiliate chair, I'm also in need of that sort of documentation

    1. Jose Costa-Teixeira that page still explains how to use publish-update, not go-publish.