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

Clarify whether $ in alias name removes other name requirements

    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 update the corresponding section in the documentation to more specifically delineate the requirements for item names, slice names, and alias names. We propose wording similar to the following:

      Item names SHOULD follow FHIR naming guidance. All item names MUST be between 1 and 255 characters. Item names MUST begin with an uppercase ASCII letter and contain only ASCII 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. Slice names MUST contain only ASCII letters, numbers, underscores (“”), hyphens (“-”), at signs (“@”), and forward slashes (“”, used only for re-slicing). These conventions are consistent with FHIR naming conventions, aside from disallowing square brackets (“[” and “]”) since they are used by slice array path syntax.

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

      As noted in the proposed text, item name and slice name requirements are based on the requirements of the FHIR specification. Alias name requirements were clarified based on analysis of use in existing FHIR Shorthand projects.

      Show
      We will update the corresponding section in the documentation to more specifically delineate the requirements for item names, slice names, and alias names. We propose wording similar to the following: Item names SHOULD follow FHIR naming guidance . All item names MUST be between 1 and 255 characters. Item names MUST begin with an uppercase ASCII letter and contain only ASCII 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 . Slice names MUST contain only ASCII letters, numbers, underscores (“ ”), hyphens (“-”), at signs (“@”), and forward slashes (“ ”, used only for re-slicing). These conventions are consistent with FHIR naming conventions, aside from disallowing square brackets (“ [” and “] ”) since they are used by slice array path syntax. Alias names SHOULD begin with a dollar sign (“$”) and MUST otherwise contain only ASCII letters, numbers, underscores (“_”), hyphens (“-”), and dots (“.”). Beginning alias names with $ is a good practice, since this convention allows for additional error checking ( see Defining Aliases for details). As noted in the proposed text, item name and slice name requirements are based on the requirements of the FHIR specification. Alias name requirements were clarified based on analysis of use in existing FHIR Shorthand projects.
    • Chris Moesel/Mark Kramer: 12-0-0
    • Correction
    • Non-substantive

    Description

      Clarify whether the guidance should be read as:

      Alias names:

      • should begin with $, or
      • must begin with upper, and contain only letters numbers and underscore.

      Current text could be read to imply that there are no restrictions on names starting with a $.

      Existing Wording:

      Alias names SHOULD begin with $, otherwise, names MUST begin with an uppercase letter and contain only letters, numbers, and underscores (“_”).

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