cqframework / opioid-cds-r4

CDC Opioid Prescribing Support Guideline (for FHIR R4)
Other
5 stars 3 forks source link

Apply QA for 2022 Content #340

Closed c-schuler closed 8 months ago

alackerbauer commented 1 year ago

Q&A report can be found here: http://build.fhir.org/ig/cqframework/opioid-cds-r4/qa.html

alackerbauer commented 1 year ago

PR (not yet finished): https://github.com/cqframework/opioid-cds-r4/pull/342

cannot find value set that replaces

 <li><a href="ValueSet-medicationrequest-category-community.html">MedicationRequest Category Community</a></li>

i can only find it in the archive. was this replaced by another one or removed entirely?

alackerbauer commented 1 year ago

5 errors:

alackerbauer commented 1 year ago

I did a comparison of what is listed in input/pagecontent/terminology.xml and which value sets are present in input/vocabulary/valueset.

There is a discrepancy that I'd need feedback on before resolving the last 3 errors from the comment above:

This is what we have in the value set folder but not listed in the terminology.xml: --> should those be included to terminology.xml?

This is what is mentioned in the list in terminology.xml but cannot be found in the vocabulary folder:

alackerbauer commented 1 year ago

try this for value sets: {% include list-simple-codesystems.xhtml %} check how it renders.

if not, add all valuesets from the valueset folder to the list.

also, add everything that was checked but not resolved for now to supporess warnings file.

alackerbauer commented 1 year ago

the include list-simple-codesystems.xhtml works generally speaking. It uses the ValueSet.title for the hyperlink texts. But the ValueSet titles aren't as speaking as the manually listed ones. E.g.:

ValueSet title: ValueSet - US Core Health Concern Condition Category Manually defined name (nowhere to be found in this ValueSet): Condition Category US Core Health Concern

alackerbauer commented 1 year ago

Tried to fix the QA warning for embedded HTML in valueMarkdown of a ValueSet's rulestest. Was not successful, neither escaping all special characters (e.g. to unicode), neither putting the code into a MD code block solved the problem. I worked with a JSON escaper: https://www.freeformatter.com/json-escape.html#before-output as well as manual unicode and markdown changes.

The only escaping that resolved the warning was a double-backslash before any special character: e.g. \\<WFE\\>--> but with that, the snippet cannot be copied anymore straight to rxmix.

alackerbauer commented 1 year ago

I have asked a zulip question about embedded XML inside markdown here - in short the answer is we won't be able to avoid this warning: https://chat.fhir.org/#narrow/stream/179252-IG-creation/topic/Warning.3A.20markdown.20with.20embedded.20HTML.20tag