Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added warning to ignoreWarnings.txt #889

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

mjosborne1
Copy link
Collaborator

Added Warnings to ignoreWarnings.txt for problems caused by validator unable to access NCTS Complete CodeSystem and NCTS Composed ValueSet for github-887

@mjosborne1 mjosborne1 requested a review from dbojicic December 2, 2024 01:49
@dt-r dt-r closed this Dec 2, 2024
@dt-r dt-r reopened this Dec 2, 2024
@dt-r dt-r self-requested a review December 2, 2024 22:14
@@ -121,7 +121,8 @@ To help implementers, only the more significant changes are listed here.
</li>
<li>Updated AU Base ValueSet resources to remove conformance to HL7 International <a href="http://hl7.org/fhir/StructureDefinition/shareablevalueset">ShareableValueSet</a> and instead claim conformance to <a href="https://healthterminologies.gov.au/fhir/StructureDefinition/composed-value-set-4"> NCTS Composed ValueSet</a> (<a href="https://jira.hl7.org/browse/FHIR-47149">FHIR-47149</a>)
</li>
<li>Removed codes from <a href="ValueSet-au-v3-ActEncounterCode-extended.html" >ActEncounterCode - AU Extended</a> (<a href="https://jira.hl7.org/browse/FHIR-47120">FHIR-47120</a>)
<li>Added Warnings to ignoreWarnings.txt for problems caused by validator unable to access <a href="https://healthterminologies.gov.au/fhir/StructureDefinition/complete-code-system-4"> NCTS Complete CodeSystem</a> and <a href="https://healthterminologies.gov.au/fhir/StructureDefinition/composed-value-set-4"> NCTS Composed ValueSet</a> for <a href="https://github.com/hl7au/au-fhir-base/issues/887">github-887</a></li>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change log is substantive changes for implementers, warnings that are suppressed are not considered substantive.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed Warnings line

@@ -4,3 +4,7 @@
The HTML fragment 'ip-statements.xhtml' is not included anywhere in the produced implementation guide
An HTML fragment from the set [cross-version-analysis.xhtml, cross-version-analysis-inline.xhtml] is not included anywhere in the produced implementation guide
The HTML fragment 'globals-table.xhtml' is not included anywhere in the produced implementation guide

# === These warnings are suppressed as the validator cannot currently fetch the NCTS Codesystem and ValueSet profiles ===
Copy link
Collaborator

@dt-r dt-r Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI build does not ignore warnings (couple of exceptions) as that allows for continuous QA of both the IG and the toolchain. The release branches will ignore warnings.

What should be added, if the underlying source of the error will not be fixed in the very short term is an editorial note on how and when this will be fixed potentially with reference to a Jira or GitHub or zulip or some other tracker that provides evidence a fix is progressing..

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated suppression comment as per feedback

Copy link
Collaborator

@dt-r dt-r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comments.

@mjosborne1 mjosborne1 requested a review from dt-r December 3, 2024 05:29
@@ -121,7 +121,7 @@ To help implementers, only the more significant changes are listed here.
</li>
<li>Updated AU Base ValueSet resources to remove conformance to HL7 International <a href="http://hl7.org/fhir/StructureDefinition/shareablevalueset">ShareableValueSet</a> and instead claim conformance to <a href="https://healthterminologies.gov.au/fhir/StructureDefinition/composed-value-set-4"> NCTS Composed ValueSet</a> (<a href="https://jira.hl7.org/browse/FHIR-47149">FHIR-47149</a>)
</li>
<li>Removed codes from <a href="ValueSet-au-v3-ActEncounterCode-extended.html" >ActEncounterCode - AU Extended</a> (<a href="https://jira.hl7.org/browse/FHIR-47120">FHIR-47120</a>)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes to changes.md are outside the scope of this PR. Please remove (this file should not be included in the PR).

@@ -4,3 +4,7 @@
The HTML fragment 'ip-statements.xhtml' is not included anywhere in the produced implementation guide
An HTML fragment from the set [cross-version-analysis.xhtml, cross-version-analysis-inline.xhtml] is not included anywhere in the produced implementation guide
The HTML fragment 'globals-table.xhtml' is not included anywhere in the produced implementation guide

# === These warnings are suppressed as the IG Publisher cannot validate code systems and value sets until a package dependency is available from NCTS. There is no timeline for completion of this enhancement. For more details see JIRA-48933 (https://jira.hl7.org/browse/FHIR-48933). ===
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be helpful to include more details about why the warnings appear - the IG Publisher cannot validate code systems and value sets against NCTS profiles because it cannot access them.
This is implied by the current note but not explicitly stated.

Copy link
Collaborator

@dbojicic dbojicic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants