Value Set Naming Conventions

From HL7Wiki
Jump to navigation Jump to search


Overview

In order to provide consistency in how models and value sets are interpreted, a set of naming conventions pertaining to value sets has been in common use. This will help vocabulary users in identifying existing value sets that may meet their requirements, as well as provide a consistency for developing and reviewing vocabulary updates.


Naming Convention

  1. Uniqueness: The names used for Value Sets in the "Universal" vocabulary repository must be unique. Therefore any proposed name SHALL have been researched to be certain that the name is not already in use.
  2. Structure: Value Set names SHALL be UpperCamelCase, with no special characters.
  3. Value Sets drawing values solely from code systems:
    ActClass, ActMood, ActRelationshipType, ParticipationType, RoleClass, RoleLinkType, EntityClass, EntityDeterminer
    SHALL follow the following pattern rules:
    1. Code system name: The first element of the Value set name SHALL BE the code system name as above.
    2. "all codes" If the Value set is "all codes" from the designated code system, the first element name is sufficient. I.e. The Value Set name will be identical to the code system name
    3. code-based content, transitive If the value set is defined as a code from the primary code system and all of that codes descendants, the name SHALL be formed by concatenating an UpperCamelCase rendition of the "print name" for that code to the first element.
    4. code-based content, enumerated If the Value set is being enumerated, an upper case word or a CamelCase phrase MUST be concatenated to the first element.
  4. Value Sets drawing values from other HL7-maintained code systems SHOULD follow the following pattern rules:
    1. Code system name: The first element of the Value set name SHOULD be the "short" code system name for the primary HL7-maintained code system from which it draws value.
      • Review existing value sets based on that code system to determine any previously used pattern involving the code system name. Some of these are not in the first element, and others split the name. If an existing pattern is present, it SHOULD be used.
    2. "all codes" If the Value set is "all codes" from the designated code system, the first element name is sufficient.
    3. code-based content, transitive If the value set is defined as a code from the primary code system and all of that codes descendants, the name SHOULD be formed by combining an UpperCamelCase rendition of the "print name" with the pattern selected for the code system name.
    4. code-based content, enumerated If the Value set is being enumerated, an upper case word or a CamelCase phrase SHOULD be combined with the pattern selected for the code system name.
  5. Value Sets Based on external code systems for use in the Universal realm need to be identifiable and unique. For that reason, the following are recommended:
    1. Code system name: Some element of the value set name should indicate the primary code system from which the value set draws values.
      • This element SHOULD be used in the same location in all value sets based on that code system.
      • Review existing value sets based on that code system to determine any previously used pattern. If present, an existing pattern SHOULD be used.