Uploaded image for project: 'FHIR Specification Feedback'
  1. FHIR Specification Feedback
  2. FHIR-37753

Add 'Conformance Summary'

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R5
    • FHIR Infrastructure
    • Search
    • Hide

      Will make the tools change necessary to allow conformance statements to be 'tagged' within the page text and auto-generate a summary of all such tagged statements.  Will also spit out warnings in the log if there are SHALL/SHOULD/MAY/SHALL NOT/etc. statements in the text that aren't tagged if there are any such tags.  (As part of tagging you can say 'do not include in summary' if that seems appropriate for a given statement.)

      Once the tooling is done, Gino can get tagging

      Show
      Will make the tools change necessary to allow conformance statements to be 'tagged' within the page text and auto-generate a summary of all such tagged statements.  Will also spit out warnings in the log if there are SHALL/SHOULD/MAY/SHALL NOT/etc. statements in the text that aren't tagged if there are any such tags.  (As part of tagging you can say 'do not include in summary' if that seems appropriate for a given statement.) Once the tooling is done, Gino can get tagging
    • Grahame Grieve/Rick Geimer: 4-0-0
    • Correction
    • Non-substantive

    Description

      While working through the search page, I realized that conformance language is embedded in text, sometimes long text, that can make it difficult for people that just need to see 'requirements' to find them.

      I propose adding a 'Conformance Summary' section to the end of the search page. It will contain a list of sections and each relevant conformance language sentence. A mock-up can be found here.

      For the mock-up I manually added entries - if this is a desired feature in general, I would recommend adding it to tooling. Conformance sentences can be wrapped in something like: <span class="fhir-conformance">[language]</span>, which could be picked up by tooling during the build process.

      Attachments

        Activity

          People

            Unassigned Unassigned
            ginocanessa Gino Canessa
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: