Stream: IG creation
Topic: Jira specification file warning does not go away
Stefan Karl (Aug 08 2021 at 17:10):
I updated the Jira specification file "FHIR-pocd.xml" in https://github.com/HL7/JIRA-Spec-Artifacts with content from the IG publisher output and some changes:
- Modified names to distinguish between CodeSystem and ValueSet
- Added two "deprecated" entries for version and Observation resource, which have been present in the previous version
Without these changes .buildlocal.bat failed.
After pull request and successful merge, rebuilding the IG still generates the warning "The jira specification file appears to be out of date …" in QA.html.
Comparing jira-current.xml and jira-new.xml shows the following differences:
diff (cat jira-current.xml) (cat jira-new.xml)
InputObject SideIndicator
----------- -------------
<artifact id="CodeSystem/kind-of-relation" key="ValueSet-kind-of-relation" name="Kind of relation codes (ValueSet)"/> =>
<artifact id="CodeSystem/metric-availability" key="ValueSet-metric-availability" name="Metric availability codes (ValueSet)"/> =>
<artifact id="CodeSystem/operating-mode" key="ValueSet-operating-mode" name="Operating mode codes (ValueSet)"/> =>
<artifact id="CodeSystem/safety" key="ValueSet-safety" name="Safety classification codes (ValueSet)"/> =>
<artifact id="CodeSystem/kind-of-relation" key="CodeSystem-kind-of-relation" name="Kind of relation codes (CodeSystem)"/> <=
<artifact id="CodeSystem/metric-availability" key="CodeSystem-metric-availability" name="Metric availability codes (CodeSystem)"/> <=
<artifact deprecated="true" key="Observation" name="Observation"/> <=
<artifact id="CodeSystem/operating-mode" key="CodeSystem-operating-mode" name="Operating mode codes (CodeSystem)"/> <=
<artifact id="CodeSystem/safety" key="CodeSystem-safety" name="Safety classification codes (CodeSystem)"/> <=
How can I get rid of the warning?
Lloyd McKenzie (Aug 08 2021 at 17:33):
It looks like you have keys that changed - you've got ValueSet keys on CodeSystem resources. Did you used to have value sets and got rid of them? If so, you'll need to deprecate those artifacts
Stefan Karl (Aug 08 2021 at 19:59):
I was also wondering about that. Nothing changed in the IG. With the default FHIR-pocd.xml in JIRA-Spec-Artifacts (having only deprecated artifact entries for base resources) the publisher created entries that are now in jira-current.xml. I changed the name by appending "(CodeSystem)" or "(ValueSet)" for the four pairs with equal names. After the update on JIRA-Spec-Artifacts the IG publisher seems to mix up CodeSystem and ValueSet entries in jira-new.xml.
The build log has warnings "Jira file generation will not be correct because multiple artifacts have the same name (ignoring content in '()')". What does that mean? In the IG, identical names for CodeSystem and ValueSet are not an issue because they are clearly separated. In Jira they need to be distinguished, therefore I changed the names.
Lloyd McKenzie (Aug 09 2021 at 01:34):
Actually, even within the IG, you should have distinct names for code systems and value sets because in the table of contents, there won't be anything else that distinguishes them.
Stefan Karl (Aug 09 2021 at 11:28):
I can change names after ballot. But the warning "The jira specification file appears to be out of date with the versions, artifacts and pages currently defined in the IG. ..." is still wrong, because the Jira specification isn't out of date. Can we consider it a tooling issue?
Lloyd McKenzie (Aug 09 2021 at 14:50):
Why can't you change the titles now? That's something that should happen before the ballot opens. It's definitely not a tooling issue as having unique names across all artifacts is definitely an intended behavior.
Jean Duteau (Aug 09 2021 at 14:59):
it sounds like you are taking the created Jira spec file and then manually modifying it:
I updated the Jira specification file "FHIR-pocd.xml" in https://github.com/HL7/JIRA-Spec-Artifacts with content from the IG publisher output and some changes:
Modified names to distinguish between CodeSystem and ValueSet
Added two "deprecated" entries for version and Observation resource, which have been present in the previous version
If you didn't actually change the guide content, then that is why the warning is there.
Last updated: Apr 12 2022 at 19:14 UTC
