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

Document the use of the implySystem parameter on $validate-code

    XMLWordPrintableJSON

Details

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

      Add a new input parameter to $validate-code on ValueSet.
       # inferSystem
       # Description = If true, the terminology server is required to infer the system from  evaluation of the value set definition. The inferSystem parameter is only to be used with the code parameter, and not with the coding nor codeableConcept parameters.
       # Boolean
       # Optional (0..1)

      Change this text in the operation description from this: 

      If the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. One (and only one) of the in parameters code, coding, or codeableConcept must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code.

      To this:

      If the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. One (and only one) of the in parameters code, coding, or codeableConcept must be provided. If a code is provided, either a system or inferSystem SHOULD be provided. The operation returns a result (true / false), an error message, and the recommended display for the code.

      Show
      Add a new input parameter to $validate-code on ValueSet.  # inferSystem  # Description = If true, the terminology server is required to infer the system from  evaluation of the value set definition. The inferSystem parameter is only to be used with the code parameter, and not with the coding nor codeableConcept parameters.  # Boolean  # Optional (0..1) Change this text in the operation description from this:  If the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. One (and only one) of the in parameters code, coding, or codeableConcept must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code. To this: If the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. One (and only one) of the in parameters code, coding, or codeableConcept must be provided. If a code is provided, either a system or inferSystem SHOULD be provided. The operation returns a result (true / false), an error message, and the recommended display for the code.
    • Reuben Daniels / Carmela Couderc : 11 - 0 - 1
    • Enhancement
    • Compatible, substantive
    • R6

    Description

      When calling $validate-code on an element of type code, the validator passes the code it found, along with the applicable value set associated with the 'code' element. It does not pass a system, since the system is not explicit. The terminology server needs to look through the value set, any other dependent value sets and also the code system to decide whether the code it is passed is valid and known given the value set definitions. (the validator can't do it, since the value set might be open e.g. in the case of UCUM, so it might need terminological knowledge).

      To inform that the server that it should perform this logic, the validator passes the parameter implySystem = true.

      This is the last undocumented parameter that the validator uses, and we should add it to the definition of the $validate-code operation on ValueSet

      Attachments

        Activity

          People

            reuben.daniels Reuben Daniels
            GrahameGrieve Grahame Grieve
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: