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

Improve description of CodeSystem expansion-processing-rule

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R4
    • Terminology Infrastructure
    • CodeSystem
    • Hide

      Change the description:

      all-codes All Codes The expansion (when in UI mode) includes all codes and any defined groups (in extensions).
      ungrouped Groups + Ungrouped codes The expanion (when in UI mode) lists the groups, and then any codes that have not been included in a group
      groups-only Groups Only The expansion (when in UI mode) only includes the defined groups.

      all-codes: The expansion (e.g. when in UI mode) includes all codes; those included in a group and those not included in a group, as well as the codes for the groups themselves (e.g. a parent node in a hierarchical code system). 

      ungrouped: The expansion (e.g. when in UI mode) includes the codes for the groups, and any codes that are not  included in a group

      groups-only: The expansion (e.g. when in UI mode) only includes the codes for the groups

       

      Show
      Change the description: all-codes All Codes The expansion (when in UI mode) includes all codes and any defined groups (in extensions). ungrouped Groups + Ungrouped codes The expanion (when in UI mode) lists the groups, and then any codes that have not been included in a group groups-only Groups Only The expansion (when in UI mode) only includes the defined groups. all-codes: The expansion (e.g. when in UI mode) includes all codes; those included in a group and those not included in a group, as well as the codes for the groups themselves (e.g. a parent node in a hierarchical code system).  ungrouped: The expansion (e.g. when in UI mode) includes the codes for the groups, and any codes that are not  included in a group groups-only: The expansion (e.g. when in UI mode) only includes the codes for the groups  
    • Rob Hausam/Peter Jordan: 2-0-0
    • Clarification
    • Non-substantive
    • R5

    Description

      The CodeSystem http://www.hl7.org/fhir/codesystem-expansion-processing-rule.html is the basis for the ValueSet http://www.hl7.org/fhir/valueset-expansion-processing-rule.html used by the extension http://www.hl7.org/fhir/codesystem-expansion-processing-rule.html defining how concepts are processed into the expansion when it's for UI presentation.

      Currently three different codes are possible all-codes, ungrouped, and groups-only. However, the description of the three codes is not clear.

      • What is the difference between all-codes and ungrouped? The first includes "all codes and any defined groups" while the latter "lists the groups, and then any codes that have not been included in a group". As a result, in both cases all codes would be included.
        • Reading only the name of the code ungrouped one could assume that only those codes are included in the expansion which are not part of a group.

      Furthermore, a reference to the  http://www.hl7.org/fhir/valueset-operation-expand.html operation and its parameter excludeNotForUI (respectively, forUI according to FHIR-30700) would help to understand what "(when in UI mode)" means.

      Attachments

        Activity

          People

            marc.duteau Marc Duteau
            gkleinoscheg Gabriel Kleinoscheg
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: