Stream: IG creation
Topic: Proposed update to HL7 template
Lloyd McKenzie (Feb 02 2020 at 04:52):
I would like to push out a new release of the HL7 template. This won't change the base template at all, but will add logic to the HL7 template that will help generate a file for each IG that will drive the Jira drop-downs for that IG - so that each guide will show the artifacts and pages that are relevant for that IG. I would like this to be committed so it's available for demoing at our Tuesday lunch session. This will impact all IGs using the HL7 template directly (which should only be UTG I think?) as well as those using the HL7 FHIR, CDA or Da Vinci templates which I would also increment the version on.
When this upgrade occurs, it's possible that some IGs will cease to build correctly. The new process relies on certain information being captured correctly in the IG file and in the package-list.json - some of which has not been checked/enforced before. The specific additional rules are:
- IGs using one of the HL7 templates must have an id of the form hl7.[family].[realm].[id]. This general syntax has been enforced previously, but the new process will enforce that the first part is "hl7", the family is "fhir" or "cda" and the realm is "us" or "uv".
- The IG must have a contact of type 'url' that starts with "http://hl7.org/Special/committees/" followed by the appropriate web code for your work group (whatever is used by the HL7 website). This is used to identify the responsible work group when generating needed Jira file - which will eventually help in the issue triage process.
- the package-list.json file needs to exist in the root folder and needs to have exactly one package defined with a status of "ci-build". All other packages must have a status that matches one of the values listed on this page: https://confluence.hl7.org/display/FHIR/FHIR+IG+PackageList+doco (nothing was checking these previously)
I've tested this update with SDC and it seems to work well. Please let me know if you have any concerns with this resource being pushed sometime on Monday (auzzie time) or at the latest, first thing on Tuesday so things are ready to demo on Tuesday lunch (and anyone who has issues has a chance to ask about them on Tuesday lunch).
@Sean McIlvenna
Lloyd McKenzie (Feb 02 2020 at 04:52):
(@Sarah Gaunt @Rick Geimer @Mark Kramer)
Grahame Grieve (Feb 02 2020 at 05:15):
this is not true for a number of IGs:
IGs using one of the HL7 templates must have an id of the form hl7.[family].[realm].[id]
Grahame Grieve (Feb 02 2020 at 05:15):
some are hl7.family.id
Sarah Gaunt (Feb 02 2020 at 05:24):
*Aussie
Sarah Gaunt (Feb 02 2020 at 05:28):
I'm fine with it. I just won't re-build BSeR until I've tested/fixed the build locally, or until after TSC approves publication on the current CI Build version.
Grahame Grieve (Feb 02 2020 at 05:36):
I'll see if I can get template versioning in place by then
Lloyd McKenzie (Feb 02 2020 at 05:44):
Is no realm equivalent to UV? If so, I can adjust the code to take that into account. (Though less variability would be nice...). Is there an IG I can test against?
Grahame Grieve (Feb 02 2020 at 06:06):
no realm pretty much implies UV yes
Lloyd McKenzie (Feb 02 2020 at 10:09):
Is there a reason to have two id conventions that convey the same thing?
Grahame Grieve (Feb 02 2020 at 10:57):
the guides that don't have uv. in the name have those names because they are infrastructural things for which the concept of realm is not applicable - e.g. smart app launch
Grahame Grieve (Feb 02 2020 at 10:57):
and some testing and internal infrastructure
Grahame Grieve (Feb 02 2020 at 10:57):
and fhirpath
Rick Geimer (Feb 03 2020 at 03:54):
I'd like @Sean McIlvenna to chime in. I have pinged him on our internal Zulip, but for the moment the new template support is in our Dev environment and I think only Sarah is using it in production. We do plan to move the new template stuff to our production environment on Feb 7 though.
Mark Kramer (Feb 03 2020 at 04:00):
Can you release it as a beta first? Can you create a formal release with a release number and release notes? Can you allow a time for transition and testing where both the old and new versions are available?
Lloyd McKenzie (Feb 03 2020 at 04:02):
Grahame has added the ability for IGs to point to a specific version if they need to. I think the general expectation will be for everyone to use the 'current' template, but you can roll back to an earlier one if the new one gives you grief - at least for a little while.
Grahame Grieve (Feb 03 2020 at 04:09):
if you want to use the existing stable version, append #0.0.2 to the template in your IG. Anything Lloyd commits won't affect you
Sean McIlvenna (Feb 04 2020 at 20:12):
@Rick Geimer I've modified the UI for editing IGs in ToF to indicate to the user that the packageId is required, to validate the format of the packageId, and to allow the user to enter a working group when the packageId starts with "hl7".
Last updated: Apr 12 2022 at 19:14 UTC
