Snow Owl Authoring Platform User Guide
9.5
9.5
  • Table of Content
  • 🦉Introduction
    • Getting Started
      • Features
      • How can I run it?
      • Login
        • Repositories
        • SNOMED CT Code Systems Configuration
        • Included SNOMED CT Version
    • User Interface
      • Editors
        • Introduction
        • Vertical Display
        • Horizontal Display
      • Views
        • Bookmarks View
          • Bookmarking
          • Delete
        • Remote Jobs View
      • Perspectives
      • Notification Center
    • Preferences
      • SNOMED CT Settings
      • Editor Tables
      • Reasoners
      • Keyboard Preferences
      • Avatars
  • 🔎Browsing and Searching
    • SNOMED CT View
      • Hierarchy
      • Sub-hierarchy
      • Link with Editor
      • Context Menu
      • Authoring Mode
      • Icons
      • Extension Modules
      • Parents View
    • Searching
      • Filter Search
        • Features
      • Quick Search
        • Features
      • Advanced Search
        • Search Dialog
          • SNOMED CT Concept Search
          • SNOMED CT Description Search
          • Searching for Reference Sets
        • Search View
          • Sorting Results
          • Toolbar
          • Preferences
    • Semantic Queries
      • ECL Operators
      • ECL Editor
      • Project Explorer View
        • Create
        • Expression File
          • Content Assist
          • Concept to Expression
          • Executing a Query
          • Validation
        • Template Preferences
    • Scripting
      • Create
      • Executing Scripts
    • Copying Content
  • 📝Editing and Authoring
    • Authoring Mode Selection
      • OWL Axiom Support
    • SNOMED CT Concept Editor
      • Preferences
      • Navigation
      • Features
      • Overview Page
        • Descriptions Section
        • Properties Section
        • SNOMED CT Properties Section
      • Descriptions Page
      • Relationship Pages
        • Source relationships Page
        • Destination relationships Page
      • Memberships Page
      • SNOMED CT Mappings Page
      • References Page
      • Visualization Page
    • SNOMED CT Editing
      • Concept Creation
        • Creating a Child Concept
        • Creating Sibling Concept
      • Concept Editing
        • Adding a Synonym
        • Changing the Preferred Term
        • Adding a Relationship
        • Editing Relationships
        • Adding Descriptions
        • Concept Reactivation
      • Removing Components
        • Concept Deleting
        • Concept Inactivation
        • Description Inactivation
    • Evaluating Changes
      • Concept History
      • Validation
      • Classification
  • 🧠Description Logic
    • Running the Classification
    • Classification Results
      • Relationship Changes Page
      • Equivalent Concepts Changes Page
      • Concept Changes Page
    • Reasoners
      • ELK
  • 🧱Concept model
    • Machine Readable Concept Model
      • MRCM domain members
      • MRCM attribute domain members
      • MRCM attribute range members
    • Editing MRCM
      • Module scope
      • Domain
      • Attribute
      • Range
  • 📄Reference Sets
    • Reference Set Types
      • Content type Reference Sets
        • Simple type Reference Sets
        • Query type Reference Sets
        • Attribute Value type Reference Sets
        • OWL Expression type Reference Sets
      • Language type Reference Sets
      • Map type Reference Sets
        • Simple Map type Reference Sets
        • Complex Map Type Reference Sets
        • Complex Map Extended with Map Block type Reference Sets
        • Extended Map type Reference Sets
      • Metadata type Reference Sets
        • MRCM Domain Reference Sets
        • MRCM Attribute Domain Reference Sets
        • MRCM Attribute Range Reference Sets
        • MRCM Module Scope Reference Set
        • Module Dependency Reference Set
        • Description Format type Reference Set
    • Reference Set View
      • Link Reference Set Editor with SNOMED CT View
      • Context Menu
      • Tooltips
    • Reference Set Editor
      • Toolbar
      • Context Menu
      • Preferences
    • Authoring
      • Creating Reference Sets
      • Removing/Inactivating Reference Sets
      • Adding Reference Set Members
      • Removing Reference Set Members
    • Combining Reference Sets
    • Compare Reference Sets
  • 🏥Local Code Systems
    • Import
      • Custom Spreadsheet
    • Searching
    • Authoring
      • Creating Local Code Systems
        • Additional Property Definitions
        • Property Validation
      • Deleting Local Code Systems
      • Adding Local Codes
      • Reparenting Local Codes
      • Inactivating Local Codes
      • Deleting Local Codes
    • Validation
    • Export
  • 📅Versioning
    • Introduction
    • Creating a New Version
    • Switching Between Versions
    • Version Compare
      • Browse Changes
      • Export Results
  • 🔁Content Management
    • Code Systems
    • Code Systems View
    • SNOMED CT Importing
    • SNOMED CT Publishing
      • SNOMED CT Reference Set Export
    • SNOMED CT Extensions
    • SNOMED CT Upgrade
      • Perform Upgrade
      • Complete Upgrade Process
  • 👩‍⚕️👨‍⚕️ Collaborative authoring
    • Task Life Cycle
    • The Task List View
    • Task Editor
      • Overview Page
      • Task Changes Page
      • Review Changes Page
    • Authoring
      • Creating a Task
      • Assigning Tasks
      • Activating Tasks
      • Synchronizing Tasks
      • Module-based Editing
      • Promoting and Closing Tasks
      • Commenting on Tasks
      • Review Tasks
        • Approve Changes
        • Reject Changes
        • Request Changes
    • Task Query
  • ✅Validation
    • Run Validation
    • Validation Issues View
      • Filters
      • Validation Result & Export
    • Whitelisting
      • Import
      • Export
  • 📓SNOMED CT Templates
    • SNOMED CT Templates
    • Import
    • Templates View
    • Authoring
      • Creating Templates
      • Deleting Templates
    • Concept Creation by Templates
      • Single Concept Creation
      • Bulk Concept Creation
    • Export
  • 🩺UMLS Code Systems
    • Import
    • Manage Code Systems
    • Searching and Browsing
  • 🛑Error Handling
    • Troubleshooting
      • Error Log View
    • Error Messages
Powered by GitBook
On this page
  1. Local Code Systems
  2. Authoring
  3. Creating Local Code Systems

Additional Property Definitions

PreviousCreating Local Code SystemsNextProperty Validation

Using the Local Code System Editor, Local Code Systems can be further configured by defining the properties for its Local Codes. For adding and defining these Additional Properties click on this button at the right end side of the Additional Properties section bar.

Local Code properties can be defined by the following attributes (* are mandatory):

  • Name*: unique name of the property

  • Type*: type of the property

Property types

Description

Boolean

true|false

String

text type

Integer

integer numbers

Decimal

decimal numbers

Date

date with time part

URI

  • Cardinality*:

Values

Description

0..1

Optional

1..1

Mandatory

0..*

Any

1..*

Minimum one mandatory

  • Default value: Initial value of the property.

  • Description: String attribute to capture the description of the given property.

  • Validation expression: JavaScript validation expression to evaluate when value is assigned to the property.

  • Validation message: Validation message in case invalid property value entered (the validation expression evaluates to a false).

Hovering over the name or its field of the property definition attributes brings up a tooltip, about the descriptions of the attributes.

As a concrete example, the following definitions would need to be created for a Local Code System that groups codes related to medicinal products:

  • tradeName

    • Type: String

    • Cardinality: 1..*

    • Description: Trade name of the medicinal product.

    • Validation expression: this.value == _this.value.toUpperCase()

    • Validation message: Trade name '%s' needs to be all uppercase.

  • isVaccine

    • Type: Boolean

    • Cardinality: 1..1

  • numberOfBlisters

    • Type: Integer

    • Cardinality: 0..1

    • Default value: 6

    • Description: The number of blisters in the product.

    • Validation expression: _this.value > 0

    • Validation message: Number of blisters '%s' needs to be a positive number.

URI property types do not support validation expressions. In case of trying to enter something in the Validation expression field of a URI-type property, an error message will be present in the editor.

Certain property names are reserved and cannot be used as names for additional properties. The following property names fall under the reserved category: Code, Term, Alternative Terms, Is active, and Parent Concept Code. Entering one of the reserved property names will trigger an error message in the editor.

The icon warns the user that if the value of cardinality is reduced, properties may be deleted from that terminology. Hovering over the icon reveals the warning message.

🏥
Universal Resource Identifier
Local Code System editor with additional property contex menu
Additional string property with a displayed tooltip information
Example Local Code System with 3 additional properties