Clarify and revise the text descriptions (under Documentation) for the 'code', 'source', 'target' and 'reverse' parameters of $translate.

XMLWordPrintableJSON

    • Type: Change Request
    • Resolution: Persuasive with Modification
    • Priority: Medium
    • FHIR Core (FHIR)
    • STU3
    • Terminology Infrastructure
    • ConceptMap
    • Hide

      The only changes that need to be made are for the 'source' and 'target' parameters of $translate.  The existing text for the 'source' and 'target' parameters will be replaced by the text below.  A related tracker will be added to see if portions of the current text should be retained in different place.

      Change the 'source' parameter description to:

      Limits the scope of the $translate operation to source codes (ConceptMap.group.element.code) that are members of this value set.

      Change the 'target' parameter description to:

      Limits the scope of the $translate operation to target codes (ConceptMap.group.element.target.code) that are members of this value set.

      Show
      The only changes that need to be made are for the 'source' and 'target' parameters of $translate.  The existing text for the 'source' and 'target' parameters will be replaced by the text below.  A related tracker will be added to see if portions of the current text should be retained in different place. Change the 'source' parameter description to: Limits the scope of the $translate operation to source codes (ConceptMap.group.element.code) that are members of this value set. Change the 'target' parameter description to: Limits the scope of the $translate operation to target codes (ConceptMap.group.element.target.code) that are members of this value set.
    • Carmela Couderc/Michael Lawley : 3-0-0
    • Clarification
    • Non-substantive

      This was discussed on the SNOMED on FHIR call 2019-06-04. The description of the 'reverse' parameter appears partially incorrect, as "This parameter reverses the meaning of the source and target parameters" doesn't seem to be a true statement. When 'reverse = true', the meaning of 'source' and 'target' actually remains the same, but instead the meaning of the 'code' parameter is changed from "The code that is to be translated" to "The code that is translated to". The documentation for 'reverse' should therefore be revised to "if this is true, then the operation should return all the codes that might be mapped to the specified code (this changes the meaning of the code parameter to "the code that is translated to")". The documentation for 'code' should also be revised accordingly, as "The code that is to be translated (or, if reverse = true, the code to be translated to)."

      The phrase "... used when the concept (system/code pair) was chosen" in regard to the source value set also seems incorrect or misleading - instead, that sentence probably should be revised to "Identifies the value set that contains the concept(s) to be translated."

      The documentation for 'target' may not require any changes, but the documentation for all of the parameters needs to be consistent.

            Assignee:
            Marc Duteau
            Reporter:
            Robert Hausam
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: