Stream: implementers
Topic: QA Report unresolved URL error where the URL exists
May Terry (Feb 18 2021 at 00:04):
I'm getting some URL resolution errors where the referenced link actually exists.
For example, The error is The link 'http://hl7.org/fhir/us/core/3.2.0/StructureDefinition-us-core-patient.html' for "US Core Patient version 3.2" cannot be resolved but that link actually resolves when selecting it in the IG.
Any suggestions on why this error is happening?
Here's the link to the CI build QA Report: http://build.fhir.org/ig/HL7/fhir-mCODE-ig/branches/master/qa.html#internal
Lloyd McKenzie (Feb 18 2021 at 00:18):
Do you have a declared dependency to that (exact) version of US-Core? Have you checked for case errors? Case must be exact.
May Terry (Feb 18 2021 at 00:51):
Thanks for the quick reply, @Lloyd McKenzie . ah...Interesting. Seems to be a couple of things going on - the IG Publisher seems to be not happy with validating URLs that redirect to another absolute URL. So our original link is http://hl7.org/fhir/us/core/3.2.0/StructureDefinition-us-core-patient.html but when accessing it, resolves to http://hl7.org/fhir/us/core/2021Jan/StructureDefinition-us-core-patient.html. Changing our link to the absolute URL http://hl7.org/fhir/us/core/2021Jan/StructureDefinition-us-core-patient.html fixes the "resolve" error but then introduces a ImplementationGuide.dependency[1].url warning. The jira specification file appears to be out of date with the versions, artifacts and pages currently defined in the IG. A proposed revised file to be reviewed and, if appropriate, submitted as a pull request against the XML folder in https://github.com/HL7/JIRA-Spec-Artifacts. To see the differences, perform a file compare on 'template/jira-current.xml' (a normalized view of what is in Github) and 'template/jira-new.xml' (reflects current IG content).
Since we only reference US Core 3.2 in documentation within a markdown file and not directly in any substantial artifact (e.g.: profile), should it matter?
Lloyd McKenzie (Feb 18 2021 at 01:32):
When you have an IG dependency, there's a specific URL assigned to that that you're required to use. (You can - and should - actually use a {{site.data.fhir....}} variable to reference that URL - that way if you ever change what version you depend on, the URL will automatically change everywhere it needs to). The validator explicitly checks that all references to HL7 artifacts are declared properly as references. If the URLs aren't exactly correct, it'll yell.
Mark Kramer (Feb 18 2021 at 01:40):
@Lloyd McKenzie There may be a misunderstanding. We aren't talking about a IG dependency. This is just a link that is part of our narrative. We want to refer to documentation in a particular version of US Core. We aren't doing anything except trying pointing the user to an HTML page. The page exists on the web, like any other page on the web. Why the error message?
Lloyd McKenzie (Feb 18 2021 at 01:53):
Right now, if you want to point to something in another IG, there's an expectation of a dependency on that IG. I know there's a way around it, but I forget what it is. @Grahame Grieve?
Mark Kramer (Feb 18 2021 at 12:00):
It is perfectly reasonable in a narrative to draw comparisons between several versions of the same profile, with links, explaining how the profiled changed from version to version to version. This restriction to only link to pages in IGs that are declared dependencies should be eliminated.
Grahame Grieve (Feb 24 2021 at 03:36):
This restriction to only link to pages in IGs that are declared dependencies should be eliminated.
Easy to say, but in fact, editors routinely reference the wrong thing, and this check picks it up
Lloyd McKenzie (Feb 24 2021 at 03:43):
@Grahame Grieve - what's the process so Mark can bypass it for the specific links he wants to reference (without declaring a dependency)?
Grahame Grieve (Feb 24 2021 at 03:47):
there is no process. It's reasonable for us to have one though
Last updated: Apr 12 2022 at 19:14 UTC
