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

Clarify Extension keywords.

    XMLWordPrintableJSON

Details

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

      Instead of enumerating Extension keywords, the spec currently refers readers to the Profile keywords since they are nearly identical:

      Defining extensions is similar to defining profiles, except that the parent of an extension is not required.

      We agree, however, that it would be better to list the keywords here as in other sections. This is not only more consistent, but prevents the reader from having to jump to another section of the specification.

      Many keywords do not require additional explanation, as their use is fairly obvious. Other keywords, however, do require additional explanation in the text. These keywords may support multiple options, have complicated requirements, or exhibit non-obvious behaviors. As such, we believe it is important for us to specifically call them out and provide the detail necessary for proper use and implementation. Extension Context is one of these keywords, hence the more thorough description.

       

      Show
      Instead of enumerating Extension keywords, the spec currently refers readers to the Profile keywords since they are nearly identical: Defining extensions is similar to defining profiles , except that the parent of an extension is not required. We agree, however, that it would be better to list the keywords here as in other sections. This is not only more consistent, but prevents the reader from having to jump to another section of the specification. Many keywords do not require additional explanation, as their use is fairly obvious. Other keywords, however, do require additional explanation in the text. These keywords may support multiple options, have complicated requirements, or exhibit non-obvious behaviors. As such, we believe it is important for us to specifically call them out and provide the detail necessary for proper use and implementation. Extension Context is one of these keywords, hence the more thorough description.  
    • Chris Moesel/Gino Canessa: 14-0-2
    • Clarification
    • Non-substantive

    Description

      Other sections include statements like "Instances are defined using the declaration Instance, with the REQUIRED keyword InstanceOf, RECOMMENDED keywords Title and Description, and OPTIONAL keyword Usage." Add parallel language for Extensions.

      Also, it seems that the thorough description of Context is inconsistent with other keywords. Consider if a different approach for keyword descriptions is needed.

      (Comment 45 - 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: