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

Clarify what should be included in Library.description

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Highest Highest
    • US Public Health Profiles Library (FHIR)
    • 1.0.0-ballot
    • Public Health
    • STU
    • US Public Health Supplemental ValueSet Library
    • Hide

      Agreed, that the Library description is important, but this profile is actually a derived profile from US Public Health Value Set Library, we should establish the preferred description there, and the commenters proposed description is good:

      Library.description:comments (https://hl7.org/fhir/us/ph-library/2022Sep/StructureDefinition-us-ph-valueset-library-definitions.html#Library.description)

      Current:

      This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created).

      Proposed:

      The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection).

      Also agree that the examples could use work (will consider using the RCTC example value set library from the eCR IG - otherwise will update current examples/add new examples).

      Show
      Agreed, that the Library description is important, but this profile is actually a derived profile from US Public Health Value Set Library, we should establish the preferred description there, and the commenters proposed description is good: Library.description:comments ( https://hl7.org/fhir/us/ph-library/2022Sep/StructureDefinition-us-ph-valueset-library-definitions.html#Library.description ) Current: This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the library is presumed to be the predominant language in the place the library was created). Proposed: The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection). Also agree that the examples could use work (will consider using the RCTC example value set library from the eCR IG - otherwise will update current examples/add new examples).
    • Sarah Gaunt / Nagesh Bashyam : 21-0-0
    • Clarification
    • Non-substantive

    Description

      Library.description will be an important human readable description of this useful sharable library. Given this is an early example of these asset collections, we need good descriptions for all the important elements. Please improve the description of this element (it is currently the default text.)

      Some thing like:
      The description should succinctly and lucidly state the scope of the value sets included (the domains covered with as much specificity as to make the collection unique) and the intended use of the collection (a sense of what guides can use the collection).

      In addition good examples need to be provided - the current example needs work.

      Attachments

        Activity

          People

            minigrrl Sarah Gaunt
            Rob_McClure Rob McClure
            Rob McClure
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: