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

Normative text not used consistently

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • Shorthand (FHIR)
    • 1.0.0
    • FHIR Infrastructure
    • Normative
    • Language Reference
    • intro
    • Hide

      1) It is clearly stated that the entire language specification is normative unless explicitly indicated as trial use (which we clearly indicate with the TU system and colored background).

      2) In presenting syntax and usage, it is possible to overdo the use of formal normative language.  However, we do not deny there are cases where formal language would be helpful. We propose doing a sweep through the specification to find where formal language should be used.

      Here is an example:

      Numerical array references can be replaced with so-called “soft indexing.” In soft indexing, [+] is used to increment the last referenced index by 1, and [=] is used to reference the same index that was last referenced. When an array is empty, [+] refers to the first element ([0]). FSH also allows for soft and numerical indices to be mixed.

       

      Will be changed as follows:

      Numerical array references MAY be replaced with so-called “soft indexing.” In soft indexing, [+] is used to increment the last referenced index by 1, and [=] is used to reference the same index that was last referenced. When an array is empty, [+] refers to the first element ([0]). FSH also allows for soft and numerical indices to be mixed.

       

       

      Show
      1) It is clearly stated that the entire language specification is normative unless explicitly indicated as trial use (which we clearly indicate with the TU system and colored background). 2) In presenting syntax and usage, it is possible to overdo the use of formal normative language.  However, we do not deny there are cases where formal language would be helpful. We propose doing a sweep through the specification to find where formal language should be used. Here is an example: Numerical array references can be replaced with so-called “soft indexing.” In soft indexing,  [+]  is used to increment the last referenced index by 1, and  [=]  is used to reference the same index that was last referenced. When an array is empty,  [+]  refers to the first element ( [0] ). FSH also allows for soft and numerical indices to be mixed.   Will be changed as follows: Numerical array references MAY be replaced with so-called “soft indexing.” In soft indexing,  [+]  is used to increment the last referenced index by 1, and  [=]  is used to reference the same index that was last referenced. When an array is empty,  [+]  refers to the first element ( [0] ). FSH also allows for soft and numerical indices to be mixed.    
    • Mark Kramer / Rick Geimer : 16 - 0 - 1
    • Enhancement
    • Non-substantive
    • Yes

    Description

      Normative text is not used consistently. Many normative sections do not have mandatory text. Does this mean the content is informative? Please check use of normative language in each normative part of the document.

      Attachments

        Activity

          People

            Unassigned Unassigned
            bvdh Bas van den Heuvel
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: