Stream: implementers
Topic: IG Publication
AbdulMalik Shakir (Aug 06 2018 at 01:58):
Is there someone that can assist me in publishing an FHIR IG in preparation for the September HL7 ballot. I'm developing the IG in Trifolia. It is still a work in progress. However, I need to get familiar with how to prepare it for publication and inclusion in an HL7 ballot. I've read the documentation and I've done some experimenting on my own. But I don't think I am progressing at the pace I need to to meet the August deadline for ballot content. I have GoToMeeting and can set up a meeting with someone willing to walk me through the procedure. Thanks.
I've downloaded the FHIR Build Package from Trifolia, unzipped it, downloaded the hl7.fhir.igpublisher.jar into the same folder and executed the RunIGPublisher.bat. I get this error and have no idea how to process or where to reach out for help.
Have you seen this? Where should I go from here? Thanks.
Lloyd McKenzie (Aug 06 2018 at 02:00):
You have the most recent igpublisher from build.fhir.org? Is there any chance your network environment is preventing you from getting to the terminology server?
Lloyd McKenzie (Aug 06 2018 at 02:00):
You could try passing the "-tx n/a" param to see if it'll run
AbdulMalik Shakir (Aug 06 2018 at 02:02):
Lloyd..... I downloaded the jar from build.fhir.org today. So ai believe its most recent. There is a good chance my network environment is preventing me from getting to the terminology server. Do you have a minute to work with me. Can we schedule some time to work together?
Grahame Grieve (Aug 06 2018 at 02:16):
tx server is back up
Lloyd McKenzie (Aug 06 2018 at 02:36):
@AbdulMalik Shakir looks like the issue was not on your end. Is it working now?
Lloyd McKenzie (Aug 06 2018 at 02:37):
Note that you will need to get your IG set up on GitHub with the continuous integration publication process.
Lloyd McKenzie (Aug 06 2018 at 02:38):
I don't have experience doing that with trifolia-published IGs, so it might be better to consult with @Rick Geimer or @Sarah Gaunt
AbdulMalik Shakir (Aug 06 2018 at 02:51):
Thanks Lloyd. I am still having issues. I will reach out to Rick. Sarah tried to help, but she is up to her eyeballs with alligators of her own.
Lloyd McKenzie (Aug 06 2018 at 03:39):
There's a lot of alligators around at the moment... :(
AbdulMalik Shakir (Aug 06 2018 at 03:45):
Lloyd..... I have started using my own GitHub to store and version artifacts for the BSeR project. https://github.com/AbdulMalikShakir/BSeR_HL7_FHIR_IG. Is this a proper location to place the IG once I figure out how to convert the Trifolia output into a publishable version? Or, is there some other GitHub repository I should use.
Lloyd McKenzie (Aug 06 2018 at 03:48):
It needs to be a Git repository under the HL7 space. Desire what URL you'd like under that and send me your Git id and I can get one created for you
Sarah Gaunt (Aug 06 2018 at 03:51):
@Lloyd McKenzie he will need a npm-name also (that's why his ig publisher build is failing now) is that something you can get?
AbdulMalik Shakir (Aug 06 2018 at 03:54):
Desired URL: http://hl7.org/fhir/phwg/bser/ GitHub account: AbdulMalikShakir
Sarah Gaunt (Aug 06 2018 at 03:56):
Should that maybe be: http://hl7.org/fhir/us/bser (not pher)...
Sarah Gaunt (Aug 06 2018 at 03:57):
I presume it's us realm?
Sarah Gaunt (Aug 06 2018 at 03:58):
Then you should have "npm-name": "hl7.fhir.us.bser"
AbdulMalik Shakir (Aug 06 2018 at 04:01):
Would http://hl7.org/fhir/us/phwg-bser be acceptable?
Sarah Gaunt (Aug 06 2018 at 04:02):
And if that is the case, you will need to change the canonical url in the ig.json file and fix up all the structureDefinition urls etc. (You will get error messages pointing you to where the issues are, if this happens).
AbdulMalik Shakir (Aug 06 2018 at 04:02):
I can do that. Thanks.
Sarah Gaunt (Aug 06 2018 at 04:02):
Not sure - I don't usually put the name of the workgroup as part of my igs. Not sure what best practice is though.
ecr is a phwg ig and we don't have the name in there...
AbdulMalik Shakir (Aug 06 2018 at 04:05):
Sarah..... May I look at your FHIR work in Trifolia to see the pattern you use? What is the title of your IG?
Sarah Gaunt (Aug 06 2018 at 04:06):
It's not in Trifolia - Eric Haas started the work for the for comment ballot in January and he used the spread sheets. I have converted the spread sheets to xml structure definitions and I'm mostly updating the xml manually ( and sometimes using forge to edit if I need to add something complicated like slicing).
Lloyd McKenzie (Aug 06 2018 at 04:06):
Actually, that part of the URL is dealt with by your proposal. My part will be under github - which based on the pattern of your names, I've called https://github.com/HL7/bser
Sarah Gaunt (Aug 06 2018 at 04:08):
@AbdulMalik Shakir now that you have exported from Trifolia, I would recommend the same approach - use Forge and/or manual editing of the xml...
Sarah Gaunt (Aug 06 2018 at 04:09):
Trifolia is great for producing the initial package, but isn't good for the editing that you will need to do on the fly as you develop the look and feel you want for your IG.
AbdulMalik Shakir (Aug 06 2018 at 04:13):
Ouch. I was hoping to avoid manual editing of the XML. That's one of the reasons I choice to use Trifolia in the first place. I still have a bit of development work to do before the guide is ready for publication. Right now I just want to publish the work in progress so that I can farmiliarize myself with the process and get a preview version out for other to comment upon prior to submission of the final content. Thanks for your help. It looks like I need to go back into trifolia update my URLs and try exporting again.
Sarah Gaunt (Aug 06 2018 at 04:16):
Yeah, that probably the best way to do it then... Forge won't help you with the updates of the ig.xml file or the ig.json file unfortunately. Just remember if you do an export from Trifolia after you have made changes, you will need to rename the xxxx.json file to ig.json otherwise the CI build won't work later....
I'd say you'd be lucky if you end up not having to change any xml manually though - it's kind of the nature of the beast right now.
Sarah Gaunt (Aug 06 2018 at 04:18):
And there will be some things you will have to manually add to the ig.json file for sure - like the npm-name, etc.
AbdulMalik Shakir (Aug 06 2018 at 04:30):
Sarah..... Thanks so much. Lloyd created my respository on the HL7 site and invited me to join as administrator. I will now go back into Trifolia to update all of my URL to use http://hl7.org/fhir/us/bser as the root and replace the underscores in my structure definitions ids with dashes. THEN I will export and attempt the publication.bat again. You mentioned something about needing a "npm-name". Where does that come into play? You also mentioned needing to get a "package name" from Grahame. When, where, how, and why?
Sarah Gaunt (Aug 06 2018 at 04:31):
npm-name is the same as the package name - @Lloyd McKenzie is this something you can get? I would imagine it would be "hl7.fhir.us.bser"
Lloyd McKenzie (Aug 06 2018 at 04:32):
That's managed by @Grahame Grieve He should be back online in a bit.
Lloyd McKenzie (Aug 06 2018 at 04:32):
The npm package name will have to go into your json config file when you use the IG publisher
Sarah Gaunt (Aug 06 2018 at 04:33):
Once you have that npm-name from @Grahame Grieve , you will need to add the following to your ig.json file: "npm-name": "hl7.fhir.us.bser",
"license": "CC0-1.0",
Sarah Gaunt (Aug 06 2018 at 04:33):
Snap!
Sarah Gaunt (Aug 06 2018 at 04:34):
Trifolia doesn't add it - it's a new thing since the Trifolia export was last updated.
AbdulMalik Shakir (Aug 06 2018 at 04:35):
Thanks guys. I've got plenty of clean-up to do before Grahame is back online. I will assume for the moment that my assigned package name will be "hl7.fhir.us.bser".
Sarah Gaunt (Aug 06 2018 at 04:35):
I think that is safe to assume, yes
AbdulMalik Shakir (Aug 06 2018 at 04:38):
Things are so much clearer than they were an hour ago. Thank you Sarah and thank you Lloyd. I will leave you each to your respective allegators. The shore of this swamp is in sight and I am swimming in that direction. Wish me luck.
Sarah Gaunt (Aug 06 2018 at 04:38):
No problem! Good luck for sure!! :)
Lloyd McKenzie (Aug 06 2018 at 04:55):
Good luck indeed :)
Grahame Grieve (Aug 06 2018 at 05:41):
I'm back. the npm-name and the canonical URL are related - hl7.org/fhir/us/bser and hl7.fhir.us.bser
AbdulMalik Shakir (Aug 06 2018 at 05:54):
Thanks.
Vadim Peretokin (Aug 06 2018 at 11:00):
The other alternative solution is to use Forge and publish the IG with Simplifier's own IG tool - the roundtripping in that scenario is painless
AbdulMalik Shakir (Aug 06 2018 at 13:56):
Vadim..... is there a migration path from Trivolia to Simplifier?
Lloyd McKenzie (Aug 06 2018 at 14:42):
Does Simplifier now meet HL7 publication requirements?
Vadim Peretokin (Aug 06 2018 at 18:16):
@AbdulMalik Shakir doesn't look like it'll help you, sorry, Simplifier is DSTU2 and STU3 only right now. R4 will come when that is published.
AbdulMalik Shakir (Aug 06 2018 at 18:51):
@Vadim Potapenko My IG is for STU3.
AbdulMalik Shakir (Aug 06 2018 at 19:15):
IgPublicationError.txt
@Grahame Grieve Attached is the debug summary from the error I'm getting with the IG Publisher. My IG is on GitHub at https://github.com/HL7/bser. I am unable to get past this error. @Sarah Gaunt was assisting me last night and was able to get beyond this point to more downstream errors. This causes me to think that there is a problem with my setup. Do you have any advice as how I should proceed?
Lloyd McKenzie (Aug 06 2018 at 21:42):
That looks like one of your files got corrupted somehow. Try wiping your temporary folder and if that's not enough, try wiping your cache. (On Windows that'll be C:\users\[account]\.fhir\packages)
Vadim Peretokin (Aug 07 2018 at 06:37):
@AbdulMalik Shakir for STU3 - we can have a look, PM me
AbdulMalik Shakir (Aug 11 2018 at 07:15):
I am interested in giving Simplifier a try. I've started migrating my resource structure definitions from Trifolia into Forge. Is there someone farmiliar with simplifier that can introduce me to the IG publishing tool?
Alexander Zautke (Aug 11 2018 at 10:15):
I'm sure @Vadim Peretokin or @Ardon Toonstra are happy to help you. Just sent us a message and we will help you get started.
AbdulMalik Shakir (Aug 11 2018 at 20:17):
Thanks. I will.
Mark Kramer (Aug 21 2018 at 17:37):
Terminology server to be down now (13:30 eastern US time) (tx.fhir.org). Anyone else having a problem?
Grahame Grieve (Aug 21 2018 at 20:42):
it's back up
Jens Villadsen (Jan 15 2019 at 10:28):
Where should I be able to find the examples referred in http://wiki.hl7.org/index.php?title=IG_Publisher_Documentation#Examples
Blessed Tabvirwa (Jan 15 2019 at 11:02):
Where should I be able to find the examples referred in http://wiki.hl7.org/index.php?title=IG_Publisher_Documentation#Examples
From here - https://github.com/FHIR/ig-registry which points to http://www.fhir.org/guides/registry, @Grahame Grieve may confirm for us if that is indeed the correct place.
Jens Villadsen (Jan 15 2019 at 11:06):
Those links do not point towards a github repo that have the folders named 'tests/ig' or 'guides'
Blessed Tabvirwa (Jan 15 2019 at 11:19):
Ah yes you are right, my apologies
Grahame Grieve (Jan 15 2019 at 13:43):
in the main build (github.com/hl7/fhir) in /tests
Jens Villadsen (Jan 15 2019 at 13:50):
feature request: put that link into the doc
Jens Villadsen (Jan 15 2019 at 13:50):
eg: https://github.com/HL7/fhir/tree/master/tests
Last updated: Apr 12 2022 at 19:14 UTC
