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

Document the expansion parameter 'version'

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R6
    • Terminology Infrastructure
    • ValueSet
    • Terminology Service
    • 4.9.10
    • Hide

      Add the following output valueset expansion parameters to the table located at https://build.fhir.org/valueset.html#parameters:

      • used-system : uri. The canonical URL (system | {version} if available) of a code system that was used during the expansion of the value set 
      • used-supplement: uri. The canonical URL (system | {version} if available) of a code system supplement that was used during the expansion of the value set 
      • used-valueset: urii. The canonical URL (system | {version} if available) of a different value set that was used during the expansion of the value set 
      Show
      Add the following output valueset expansion parameters to the table located at https://build.fhir.org/valueset.html#parameters : used-system : uri. The canonical URL (system | {version} if available) of a code system that was used during the expansion of the value set  used-supplement: uri. The canonical URL (system | {version} if available) of a code system supplement that was used during the expansion of the value set  used-valueset: urii. The canonical URL (system | {version} if available) of a different value set that was used during the expansion of the value set 
    • Reuben Daniels /Grahame Grieve : 17-0-1
    • Enhancement
    • Non-substantive

    Description

      At present, tx.fhir.org and other conformant terminology services (e.g. Ontoserver) return a parameter in ValueSet.expansion.parameter called 'version' which is the version (or not) of a resource that was used generating the expansion. 

      This parameter is not documented anywhere, and 'version' is the wrong name (it's got that name for historical reasons, as the purpose behind it morphed). It's the parameter that leads to "based on LOINC 2.74" on the Value set expansions, which is important.

      This task proposes to split the parameter into 3 different parameters, and document them (see also task 41589):

      • used-system : uri. The canonical URL (system | {version} if available) of a code system that was used during the expansion of the value set 
      • used-supplement: uri. The canonical URL (system | {version} if available) of a code system supplement that was used during the expansion of the value set 
      • used-valueset: urii. The canonical URL (system | {version} if available) of a different value set that was used during the expansion of the value set 

      Note that the type us uri not canonical since the parameter types is limited to uri, canonical is a sub-type of uri, and we will preadopt this parameter immediately. 

      Further, we should add a description of these parameters as part of a new section "ValueSet Expansion Parameters" on the Value Set page, where also added the content added as a result of FHIR-41589

      Attachments

        Activity

          People

            Unassigned Unassigned
            GrahameGrieve Grahame Grieve
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: