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

$validate-code and $expand should have a parameter for related value sets and code systems

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Low Low
    • FHIR Core (FHIR)
    • R5
    • Terminology Infrastructure
    • ValueSet
    • Hide

      For $validate-code (on both CodeSystem and ValueSet) and $expand add an optional 'tx-resource' parameter with the definition:

      "One or more additional resources that are referred to from the value set provided with the $expand or $validate-code invocation. These may be additional value sets or code systems that the client believes will or may be necessary to perform the operation. Resources provided in this fashion are used preferentially to those known to the system, though servers may return an error if these resources are already known to the server (by URL and version) but differ from that information on the server."

      Will further consider the impact of conflicting resource and parameter data and may provide additional guidance on this in the future.

      Show
      For $validate-code (on both CodeSystem and ValueSet) and $expand add an optional 'tx-resource' parameter with the definition: "One or more additional resources that are referred to from the value set provided with the $expand or $validate-code invocation. These may be additional value sets or code systems that the client believes will or may be necessary to perform the operation. Resources provided in this fashion are used preferentially to those known to the system, though servers may return an error if these resources are already known to the server (by URL and version) but differ from that information on the server." Will further consider the impact of conflicting resource and parameter data and may provide additional guidance on this in the future.
    • Grahame Grieve / Rick Geimer : 12-0-0
    • Enhancement
    • Compatible, substantive

    Description

      When executed against a ValueSet, the $validate-code operation can take the valueSet to use for validation as a parameter to the operation, rather than against an existing value set already on the server. This is used a lot by the IG publisher, when using value sets defined in the IG being published, so that they don't need to be registered in advance on the server.

      But what if a valueSet being passed to the server imports another valueSet not known on the server? This is a very common thing in IGs now. In order to evaluate the valueSet, the imported valueSet (and it's code systems and imported value sets recursively) are also needed. But right now, there's no way to pass them to the server. 

      tx.fhir.org is using the parameter "tx-resource" to pass these to the server. Both the validator and the IG publisher use this parameter to include related value sets that the server will need to know.

      Given that this is a challenge shared generally by any client passing value sets to the server on the fly, as already defined, we should formally document the tx-resource parameter 

      Terminology servers should be encourage to pre-adopt this in earlier versions of FHIR

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated:
              Resolved: