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

Rearrange item names for readability

    XMLWordPrintableJSON

Details

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

      We will incorporate the proposed wording as suggested.

      Show
      We will incorporate the proposed wording as suggested.
    • Chris Moesel / Gino Canessa: 10-0-0
    • Clarification
    • Non-substantive

    Description

      Consider rearranging section for readability and to remove duplicated callout to FHIR naming conventions

      Existing Wording:

      Item names SHOULD follow FHIR naming guidance. All names MUST be between 1 and 255 characters. Alias names SHOULD begin with $, otherwise, names MUST begin with an uppercase letter and contain only letters, numbers, and underscores (“_”).

      By convention, item names SHOULD use PascalCase (also known as UpperCamelCase). Slice names and local slice names for extensions SHOULD use lower camelCase. These conventions are consistent with FHIR naming conventions.

      Beginning alias names with $ is a good practice, since this convention allows for additional error checking (see Defining Aliases for details).

      Note: Instances have identifiers rather than names, so instance declarations should follow the recommendations for Item Identifiers.

      Proposed Wording:

      All names MUST be between 1 and 255 characters.

      Alias names SHOULD begin with $, otherwise, names MUST begin with an uppercase letter and contain only letters, numbers, and underscores (“_”). Beginning alias names with $ is a good practice, since this convention allows for additional error checking (see Defining Aliases for details).

      Other names SHOULD follow FHIR naming guidance, including:

      • item names SHOULD use PascalCase (also known as UpperCamelCase)
      • slice names and local slice names for extensions SHOULD use lower camelCase

      Note: Instances have identifiers rather than names, so instance declarations should follow the recommendations for Item Identifiers.

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

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated:
              Resolved: