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

Clarify source of truth for keywords

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Not Persuasive
    • Icon: Highest Highest
    • Shorthand (FHIR)
    • 2.0.0
    • FHIR Infrastructure
    • Language Reference
    • 3.5
    • Hide

      While it makes sense to clarify a "source of truth" when informal items (like examples) are involved, we do not feel we can accurately clarify a "source of truth" between different formal parts of the specification. Any discrepancy between formal parts of the spec is unintended. Given that they have equal authority, we cannot determine ahead of time which is "more correct". It would be better for these discrepancies to be surfaced in the community, decided upon, and addressed via a technical correction.

      Furthermore, the FSH specification contains a fair amount of intended redundancy for the sake of usability (e.g., to prevent users from needing to constantly jump all over the specification, to support summaries of information, to minimize context-switching, etc). As such, it would be quite difficult, and possibly distracting, to identify every instance of redundant information and clarify a single source of truth for it.

      Show
      While it makes sense to clarify a "source of truth" when informal items (like examples) are involved, we do not feel we can accurately clarify a "source of truth" between different formal parts of the specification. Any discrepancy between formal parts of the spec is unintended. Given that they have equal authority, we cannot determine ahead of time which is "more correct". It would be better for these discrepancies to be surfaced in the community, decided upon, and addressed via a technical correction. Furthermore, the FSH specification contains a fair amount of intended redundancy for the sake of usability (e.g., to prevent users from needing to constantly jump all over the specification, to support summaries of information, to minimize context-switching, etc). As such, it would be quite difficult, and possibly distracting, to identify every instance of redundant information and clarify a single source of truth for it.
    • Chris Moesel/Gino Canessa: 14-0-2

    Description

      Sections on defining various types of items include statements like "Instances are defined using the declaration Instance, with the REQUIRED keyword InstanceOf, RECOMMENDED keywords Title and Description, and OPTIONAL keyword Usage."

      Clarify if table 6 or these statements take precedence in case of disagreement.

      (Comment 46 - imported by: Ron G. Parker)

      Attachments

        Activity

          People

            Unassigned Unassigned
            Rongparker Ron G. Parker
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: