Stream: IG creation
Topic: Publishing Round
Grahame Grieve (Jan 29 2019 at 01:51):
@Melva Peters I'm getting ready to publish a rund of IGs. I have these IGs on my list:
- US Core Release 1 (https://build.fhir.org/ig/HL7/US-Core/)
- US Meds (http://build.fhir.org/ig/HL7/FHIR-ONC-Meds/index.html)
- Healthcare Associated Infection Reports (https://build.fhir.org/ig/HL7/HAI)
Grahame Grieve (Jan 29 2019 at 01:56):
do you have others for me to publish?
@Sarah Gaunt @Brett Marquard I may have questions for editors when publishing. Sarah - does your guide meet the criteria for publishing? (which I can't find right now.. Brett, do you remember where I stored that? )
Grahame Grieve (Jan 29 2019 at 01:56):
does anyone have any other IGs for me to pubish?
Sarah Gaunt (Jan 29 2019 at 02:03):
do you have others for me to publish?
@Sarah Gaunt @Brett Marquard I may have questions for editors when publishing. Sarah - does your guide meet the criteria for publishing? (which I can't find right now.. Brett, do you remember where I stored that? )
I _presume_ it does. It didn't have any errors when I requested publication back in Sept (other than some vocab stuff that you said you needed to fix, I think)
Grahame Grieve (Jan 29 2019 at 02:04):
there's a specific check list somewhere. when I find it (Or Brett reminds me where it is) I'll get you to check. For sure you don't meet it - e.g. package-list.json
Sarah Gaunt (Jan 29 2019 at 02:05):
This is what I had in the email to Lloyd about publication: "I am still getting 2 errors for the SNOMED code 765107002 – but I don’t think I can do anything about it. See the linked Zulip thread – Rob Hausam thinks it’s an issue with the code being new and not updated in the terminology server yet: https://chat.fhir.org/#narrow/stream/99-IG-creation/topic/IG.20Publisher.20terminology.20error . If that’s not the case, please let me know and I’ll fix it before publication."
Sarah Gaunt (Jan 29 2019 at 02:06):
What is package-list.json? Where do I find out about it?
Sarah Gaunt (Jan 29 2019 at 02:07):
(I presume the file Brett needs to remind you about is just a list of criteria, not detailed explanations).
Sarah Gaunt (Jan 29 2019 at 02:12):
Ok, I found the page for package-list.json. But this is a requirement from November and I requested publication of this in September. How hard is it going to be for me to manage to include all the requirements for publication that have been added since then?
Sarah Gaunt (Jan 29 2019 at 02:12):
I don't mind doing it, I just have no visibility of what the changes are and how long they are going to take to retro-fit
Sarah Gaunt (Jan 29 2019 at 02:13):
Also I'm not likely to be able to get around to fixing it until tomorrow at the earliest.
Grahame Grieve (Jan 29 2019 at 02:24):
not sure. In the past, I was just doing stuff like that, but we're moving towards a simpler publication routine, which means the editors get to do it
Bryn Rhodes (Jan 29 2019 at 02:48):
@Grahame Grieve , I have an update to QI-Core that has been approved.
Melva Peters (Jan 29 2019 at 03:20):
@Grahame Grieve Other than US Meds, I wasn't aware of the others. The list I gathered seems to be IGs for the upcoming ballot or for publishing. I've just sent another email to the Co-chairs to clarify balloting vs publishing. Here's the list on Confluence https://confluence.hl7.org/display/FHIR/2019+May+-+Ballot+Cycle
Brian Postlethwaite (Jan 29 2019 at 03:29):
PA is up to date on there, just rechecked and fixed link.
Melva Peters (Jan 29 2019 at 03:46):
@Grahame Grieve I just heard from Bryn that there is an update for QI Core, but I don't know if it is ready yet. @Bryn Rhodes can you confirm?
Bryn Rhodes (Jan 29 2019 at 03:47):
I have a few fixes I need to apply based on FMG feedback.
Eric Haas (Jan 29 2019 at 08:02):
What US Core Guide are you thinking we need to publish? US Core Implementation Guide v2.0.0 was published in December and we are doing ballot recon on US Core R4 v 2.1.0?
Eric Haas (Jan 29 2019 at 08:03):
What about VHDIR @ Brian have we got all the fixes in?
Brian Postlethwaite (Jan 29 2019 at 11:34):
It's not ready to go yet. But isn't going in for ballot, only publishing once ready. So no rush.
Brett Marquard (Jan 29 2019 at 13:23):
You published US Core STU2 12/4/2018, so that one is all set! There was a December ballot for US Core and it should be ready to publish Q1 2019.
Brett Marquard (Jan 29 2019 at 13:24):
here is the list you provided to me:
Brett Marquard (Jan 29 2019 at 13:24):
the realm in the ig matches the specified jurisdiction
the realm in the ig matches the announced realm in the ballot
the code matches between package name, and canonical URL
the version is as agreed with the FHIR product director, and specified in fixed-business-version
the npm package name must be consistent with the realm and code
the IG must build on the CI build to say which ballot it is correctly in the header and the details in the header must be consistent with realm and version
the IG must not refer to build.fhir.org at all
the page footer must specify the IG version, and the FHIR version
package-list.json must exist and have a correctly populated entry (except for date)
John Moehrke (Jan 29 2019 at 14:47):
eTLSS is striving for May ballot, but just yesterday got going on the IG. Dave Pyke and I are helping them.
Eric Haas (Jan 29 2019 at 18:50):
I created this script to create the package-list.json from excel last month: https://github.com/Healthedata1/MyNotebooks/blob/master/Package-list-maker/package-list-maker.ipynb
Sarah Gaunt (Jan 29 2019 at 19:34):
@Grahame Grieve Other than US Meds, I wasn't aware of the others. The list I gathered seems to be IGs for the upcoming ballot or for publishing. I've just sent another email to the Co-chairs to clarify balloting vs publishing. Here's the list on Confluence https://confluence.hl7.org/display/FHIR/2019+May+-+Ballot+Cycle
Just to be clear @Melva Peters - HAI is both being published and going to ballot in May. We need it to be published now so that we can work on the new version for ballot in May.
Rick Geimer (Jan 29 2019 at 19:52):
@Grahame Grieve Is the list that Brett pasted above published somewhere? Seems kind of critical to have that info readily available to all, not squirreled away in some private chats or emails. Maybe add to (or link from) here:
http://wiki.hl7.org/index.php?title=IG_Publisher_Documentation
Eric Haas (Jan 29 2019 at 20:24):
start here: http://wiki.hl7.org/index.php?title=FHIR_Implementation_Guide_Publishing_Requirements
here
http://wiki.hl7.org/index.php?title=FHIR_NPM_Package_Spec
and here
http://wiki.hl7.org/index.php?title=FHIR_IG_PackageList_doco
Rick Geimer (Jan 29 2019 at 20:28):
Thanks Eric!
Anyone have additional links? I still think it would be good to corral all these in one spot so we have a place to point to when someone asks "what do I need in order to create and publish an HL7 FHIR IG".
Grahame Grieve (Jan 29 2019 at 21:00):
I just updated http://wiki.hl7.org/index.php?title=FHIR_Implementation_Guide_Publishing_Requirements
Grahame Grieve (Jan 29 2019 at 21:07):
All guides submitted for publishing must meet all the SHALL requirements on that page. From this thread, I have the following guides to be published now:
- US Meds (http://build.fhir.org/ig/HL7/FHIR-ONC-Meds/index.html) @Brett Marquard
- Healthcare Associated Infection Reports (https://build.fhir.org/ig/HL7/HAI) @Sarah Gaunt
- QI-Core (https://github.com/cqframework/qi-core) @Bryn Rhodes
IPS is coming, but not ready yet.
Authors: please use the requirements from the link above as a check list, and advise me when you believe your IG meets all the requirements
(and yes, I know these checks are onerous - it's what I've been doing (and fixing) each time I publish. But HQ/TSC is hammering me to move to a more reproducible and timely publishing schedule, and these are the primary things preventing that. I expect that clariifcation and education will be required here)
Grahame Grieve (Jan 29 2019 at 21:12):
(and most of these thing will become a lot easier once we finally get to a standard HL7 template)
Rick Geimer (Jan 29 2019 at 21:21):
@Grahame Grieve
On this page:
http://wiki.hl7.org/index.php?title=FHIR_Implementation_Guide_Publishing_Requirements
There is the following line:
"implementation guides shall contain an openAPI file for each CapabilitiesStatement (see FHIR IG Swagger Documentation) "
But the FHIR IG Swagger Documentation page is empty.
Grahame Grieve (Jan 29 2019 at 21:23):
hah, well, the IG publisher does generate something that will meet that purpose for now
Grahame Grieve (Jan 29 2019 at 21:23):
swagger is work in progress
Rick Geimer (Jan 29 2019 at 21:43):
Ok, would be good to note on that page which requirements the IG publisher satisfies so that people don't stress over how to meet them.
Rick Geimer (Jan 29 2019 at 21:45):
But in general seems odd to require something that we feel is a work in progress and for which we have no documentation. Just my 2 cents.
Grahame Grieve (Jan 29 2019 at 22:07):
that's fair with regard to Swagger. We'll waive that for this round anyway
Bryn Rhodes (Jan 30 2019 at 03:19):
In this documentation, the last paragraph on differentiation says: "The header and footer are 'product' and the content is 'standard', as shown on this diagram, where the shaded yellow is the content: "
Bryn Rhodes (Jan 30 2019 at 03:19):
I'm confused by that, is it supposed to say "The header and footer are 'standard' and the content is 'product'"?
Bryn Rhodes (Jan 30 2019 at 03:21):
Also, this SHALL for HL7/FHIR Foundation Requirements:
Bryn Rhodes (Jan 30 2019 at 03:21):
Implementation Guides shall reference [canonical]/history.html as the source of information about other releases of the guide, and SHALL do at least from index.html
Bryn Rhodes (Jan 30 2019 at 03:21):
The current QI-Core history is a .cfml
Bryn Rhodes (Jan 30 2019 at 03:21):
Is that allowed, or do I need to change it?
Grahame Grieve (Jan 30 2019 at 03:25):
product vs standard is technical language for me.
- Product = under the control of the product manager
- Standard = under the control of the standards process
Bryn Rhodes (Jan 30 2019 at 03:31):
(y)
Grahame Grieve (Jan 30 2019 at 03:46):
missed the .html/.cfml bit. HL7 hosted guides, .cfml - updated the page
Bryn Rhodes (Jan 30 2019 at 04:14):
Okay, QI-Core is committed, I've got everything except the history page and the banners. For the history page, I looked at the cfml and there's some magic going on there I don't understand. Do I just replace the contents of the PageJSON script with the updated package-list.json?
Bryn Rhodes (Jan 30 2019 at 04:16):
And for the banner, that's only on the index page, yes? I've set up a qi-core-site repository to hold the actual published site, but I don't have the current site contents, is that something you can send me?
Grahame Grieve (Jan 30 2019 at 04:19):
you don't edit the history page - don't even have it in the repo. You just have package-list.json. Get the current copy from the web site, and make a new entry in it with the correct details
Grahame Grieve (Jan 30 2019 at 04:33):
not sure what you mean by 'the current site contents'
Bryn Rhodes (Jan 30 2019 at 05:05):
That's what I did for the package-list so I've got that part. I mean the contents of the website (at http://hl7.org/fhir/us/qicore) so I can add the new build to a folder and the root, and then send you a complete package that you can just replace the contents of the site with. Or is that something you would do as part of publishing? Just trying to take as much off your plate as I can.
Grahame Grieve (Jan 30 2019 at 05:07):
no we don't regenerate the older versions - mostly, we can't reproduce them. FHIRPath is the only spec we do that for.
Grahame Grieve (Jan 30 2019 at 05:07):
so just make sure that the current is generating.....
Bryn Rhodes (Jan 30 2019 at 05:09):
Current site is generating, and I believe I've checked off all the requirements then, so it's ready for publishing.
Grahame Grieve (Jan 30 2019 at 05:15):
great. 1 down... @Sarah Gaunt and @Brett Marquard any progress?
Brett Marquard (Jan 30 2019 at 18:51):
US Meds should be ready. Thanks to @Eric Haas for helping me understand many of the items on the wiki
Grahame Grieve (Jan 30 2019 at 19:02):
thx
Rick Geimer (Jan 30 2019 at 19:19):
@Grahame Grieve One more suggested edit to this page:
http://wiki.hl7.org/index.php?title=FHIR_Implementation_Guide_Publishing_Requirements
It says "package-list.json must exist in the repository, and have a correctly populated entry for the proposed release (except for date)", but does not point to the documentation for package-list.json.
Eric posted the following link in this thread:
http://wiki.hl7.org/index.php?title=FHIR_IG_PackageList_doco
Assuming that is the correct link, then we should add that to the IG publishing requirements page.
Grahame Grieve (Jan 30 2019 at 19:20):
do you want to do that?
Grahame Grieve (Jan 30 2019 at 19:20):
yes that is the link
Rick Geimer (Jan 30 2019 at 19:20):
Added
Eric Haas (Jan 31 2019 at 01:06):
overlooked this: what does this mean:...
Profiles should at least have the following elements presented:
- full metadata <<< ??? currently the tooling does not create a summary table for these artifact
Grahame Grieve (Jan 31 2019 at 01:10):
this, at least, is required:
Grahame Grieve (Jan 31 2019 at 01:10):
The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan
Published on Mon Aug 01 00:00:00 AEST 2016 as a draft by HL7 US Realm Steering Committee.
Grahame Grieve (Jan 31 2019 at 01:10):
from http://www.hl7.org/fhir/us/core/StructureDefinition-us-core-careplan.html
Grahame Grieve (Jan 31 2019 at 01:11):
technically, this is -header.html
Grahame Grieve (Jan 31 2019 at 01:11):
I had intended to go towards a summary table like the one on this page:
Grahame Grieve (Jan 31 2019 at 01:12):
http://hl7.org/fhir/valueset-account-status.html
Melva Peters (Jan 31 2019 at 17:58):
As I work on the checklist in Confluence, I'd like to pull in any "lessons learned" and new requirements from this publishing cycle. Feel free to send them my way.
Grahame Grieve (Feb 01 2019 at 06:02):
@Brett Marquard / @Eric Haas please check the change I made in the US core dependency for US meds
Eric Haas (Feb 01 2019 at 06:22):
yes that is correct.
Brett Marquard (Feb 01 2019 at 14:12):
What would be amazing Melva is to have someone with fresh eyes review the checklist against an IG that meets the criteria -- and create screen shots and more explicit instructions for the wiki.
Grahame Grieve (Feb 01 2019 at 21:19):
@Brett Marquard @Eric Haas something I found by accident while reviewing the IG is that all the external links have an icon added after them by the style sheet - nice - but this also happens in the rendered xml and json (not nice). Is this something we should fix before publication?
Grahame Grieve (Feb 01 2019 at 21:21):
also, this, from package-list.json:
Grahame Grieve (Feb 01 2019 at 21:21):
"changes": "n/a",
Grahame Grieve (Feb 01 2019 at 21:21):
can't we do better than that?
Grahame Grieve (Feb 01 2019 at 21:57):
@Bryn Rhodes I do not see a reference to the history page in QI-Core?
Grahame Grieve (Feb 01 2019 at 21:58):
and do we have a change list anywhere?
Eric Haas (Feb 01 2019 at 22:02):
I missed the external pngs in the json and xml. I can fix that. As far as the change log. We could add to the discriptuon and remove the links like Bryn’s
Bryn Rhodes (Feb 01 2019 at 22:02):
It's in the banner on the current publication.
Bryn Rhodes (Feb 01 2019 at 22:02):
So I thought that's where it would end up?
Bryn Rhodes (Feb 01 2019 at 22:03):
The change list is in the package-list.json.
Bryn Rhodes (Feb 01 2019 at 22:03):
Is that not where it's supposed to go now?
Rick Geimer (Feb 01 2019 at 22:11):
I'm still a little unclear about where we put package-list.json in source control. Does that go at the root of the github repo, or somewhere else?
Bryn Rhodes (Feb 01 2019 at 22:17):
Root of the github repo is where I put it in QI-Core.
Grahame Grieve (Feb 02 2019 at 00:23):
root
Grahame Grieve (Feb 02 2019 at 00:23):
@Bryn Rhodes I found your changes (less than I was looking for) but not the history link
Grahame Grieve (Feb 02 2019 at 00:24):
@Eric Haas yes please remove the xml / json external link markers.
Grahame Grieve (Feb 02 2019 at 00:24):
"remove the links"- not following.
Grahame Grieve (Feb 02 2019 at 00:24):
but please add some information about changes
Bryn Rhodes (Feb 02 2019 at 00:35):
@Grahame Grieve , I just added a link to history.html in the navbar. But in the current published, it's the link that says "Directory of published versions" in the banner, which isn't on the homepage in the QICore repo.
Bryn Rhodes (Feb 02 2019 at 00:39):
I don't know what that error is it just got:
Bryn Rhodes (Feb 02 2019 at 00:40):
Publishing Content Failed: Unknown Package hl7.fhir.us.core#3.0.1
Bryn Rhodes (Feb 02 2019 at 00:41):
The version is wrong on the package, the ig.json says US Core 2.0.0
Eric Haas (Feb 02 2019 at 02:25):
‘Remove the links’ means remove the element “changes “ from the package list json. And add the changes to the description element
Brett Marquard (Feb 02 2019 at 02:33):
I updated changes element
Melva Peters (Feb 04 2019 at 15:45):
Definitely agree @Brett Marquard - would be a good idea. I'm working on creating the checklist in Confluence so will see what I can reference/add
Rick Geimer (Feb 04 2019 at 19:49):
@Melva Peters Add me as a beta tester of the checklist too.
Melva Peters (Feb 04 2019 at 19:50):
@Rick Geimer Definitely!
Last updated: Apr 12 2022 at 19:14 UTC
