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

Rename parameters of operation $expand on ValueSet and improve their description

    XMLWordPrintableJSON

Details

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

      4.1.1. Improve description of excludeNested

      Replace existing text with the following:

      Controls whether or not the value set expansion may nest codes or not (i.e. ValueSet.expansion.contains.contains). If excludeNested is set to true, the expansion MUST be flat (no nesting). If excludeNested is set to false (default),  however, nesting is possible but not required.

      https://github.com/gabriel0316/FHIR-30700#412-improve-description-of-excludenotforui4.1.2. Improve description of excludeNotForUI

      Replace existing text with the following:{{}}

      Controls whether or not the value set expansion might include

      One purpose of such concepts is helping a user navigate through the list efficiently. If excludeNotForUI is set to true, the concepts as described above will be excluded from the expansion. If excludeNotForUI is set to false (default), all concepts as described above may be part of the expansion. In the FHIR Specification itself, the value set expansions are generated with excludeNotForUI = false, and the expansions used when generating schema / code etc, or performing validation, are all excludeNotForUI = true.

       

      Show
      4.1.1. Improve description of  excludeNested Replace existing text with the following: Controls whether or not the value set expansion may nest codes or not (i.e. ValueSet.expansion.contains.contains). If excludeNested is set to  true , the expansion MUST be flat (no nesting). If excludeNested is set to  false  (default),  however, nesting is possible but not required. https://github.com/gabriel0316/FHIR-30700#412-improve-description-of-excludenotforui 4.1.2. Improve description of  excludeNotForUI Replace existing text with the following: {{}} Controls whether or not the value set expansion might include codes from the CodeSystem with a  notSelectable  property set to  true  as specified in  http://www.hl7.org/fhir/codesystem.html#status  and in  https://hl7.org/fhir/R4/codesystem-concept-properties.html nested  contains  with no code (see  http://www.hl7.org/fhir/valueset-definitions.html#ValueSet.expansion.contains.code ) nested  contains  in the ValueSet with  abstract = true  (see  http://www.hl7.org/fhir/valueset-definitions.html#ValueSet.expansion.contains.abstract ) One purpose of such concepts is helping a user navigate through the list efficiently. If excludeNotForUI is set to  true , the concepts as described above will be excluded from the expansion. If excludeNotForUI is set to  false (default), all concepts as described above may be part of the expansion. In the FHIR Specification itself, the value set expansions are generated with  excludeNotForUI = false , and the expansions used when generating schema / code etc, or performing validation, are all  excludeNotForUI = true .  
    • Gabriel Kleinoscheg/Rob Hausam: 4-0-1
    • Clarification
    • Non-substantive
    • R5

    Description

      The operation http://www.hl7.org/fhir/valueset-operation-expand.html on ValueSets contains among others the following two parameters:

      • excludeNested 
      • excludeNotForUI 

      excludeNested

      Proposal for renaming of excludeNested because of the uncertainty in the name:

      • apply[Hierarchy|Nesting]FromCodeSystem 

      or negated, so that the parameter values stay the same for systems, that already implemented this parameter:

      • ignore[Hierarchy|Nesting]FromCodeSystem

      Proposal for update of description of excludeNested:

      "Depending on the server's implementation it may be that the server takes the hierarchy of the underlying CodeSystem for this ValueSet into account when creating the expansion. As a result the ValueSet expansion may nest codes or not (i.e. ValueSet.expansion.contains.contains). With excludeNested  true (default) the expansion will be flattened."

      excludeNotForUI

      Proposal for renaming of excludeNotForUI because of double negation in name: 

      • forUI

      Proposal for update of description of forUI:

      The last sentence of the description would have to be updated: "In the FHIR Specification itself, the value set expansions are generated with forUI = true, and the expansions used when generated schema / code etc, or performing validation, are all forUI = false."

      Attachments

        Activity

          People

            GrahameGrieve Grahame Grieve
            gkleinoscheg Gabriel Kleinoscheg
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: