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

Consistent description of keywords

    XMLWordPrintableJSON

Details

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

      Section 3.5.1.2 Keyword Statements is intended to introduce the keywords at a high level. More specific details about how to use these keywords is included in the sections detailing how to define each FSH item. We feel this approach is preferable since most readers visit the item-specific documentation when authoring a specific type of FSH item.

      To make this clear to readers viewing section 3.5.1.2 Keyword Statements, we will add a statement like the following in that section:

      For additional information about the use of these keywords, consult the documentation pertaining to the specific item(s) to which they apply.

      Show
      Section 3.5.1.2 Keyword Statements is intended to introduce the keywords at a high level. More specific details about how to use these keywords is included in the sections detailing how to define each FSH item. We feel this approach is preferable since most readers visit the item-specific documentation when authoring a specific type of FSH item. To make this clear to readers viewing section 3.5.1.2 Keyword Statements, we will add a statement like the following in that section: For additional information about the use of these keywords, consult the documentation pertaining to the specific item(s) to which they apply.
    • Chris Moesel/Gino Canessa: 14-0-2
    • Clarification
    • Non-substantive

    Description

      Consider whether, for consistency, the descriptions of Context (in section 3.5.4), Usage (in section 3.5.5) and Characteristics (in section 3.5.7) should be lifted from the Item definition sections and moved to a keyword description section, and whether other keywords should be similarly described.

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

      Attachments

        Activity

          People

            jafeltra Julia Afeltra
            Rongparker Ron G. Parker
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: