Make rendering of ElementDefinition text elements clearer - 2018-May Core Norm Infrastructure #77

XMLWordPrintableJSON

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

      Make changes as suggested except for "(The text you are reading is specified in ElementDefinition.short.)" - put this in the format documentation instead

      Show
      Make changes as suggested except for "(The text you are reading is specified in ElementDefinition.short.)" - put this in the format documentation instead
    • Grahame Grieve/Rick Geimer: 9-0-0
    • Enhancement
    • Non-substantive
    • STU3

      Existing Wording: ElementDefinition.definition

      Definition:

      Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.

      ElementDefinition.comment

      Comments: If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element.

      Proposed Wording: ElementDefinition.definition

      Definition:

      Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (The text you are reading is specified in ElementDefinition.definition.)

      ElementDefinition.comment

      Comments: If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element. (The text you are reading is specified in ElementDefinition.comments.)

      Comment:

      ElementDefinition.short, definition, comment, definition, and requirements would benefit from a more obvious linke to the rendered format. See added parenthetical comments

      Summary:

      Make rendering of ElementDefinition text elements clearer

            Assignee:
            Unassigned
            Reporter:
            Elliot Silver
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: