Authoring

The authoring process of Custom Code Systems can flow on two different levels: schema and concept.

Schema

New property definitions can be added to the Code System on the Schema tab, after clicking on the button in the middle area.

The following attributes can be specified for a property definition:

Attribute

Description

Name

Unique name of the property (mandatory)

Type

Type of the property (mandatory)

Cardinality

Defines the number of elements (mandatory)

Default value

Initial value of the property

Description

Captures the purpose of the property

Once you added a property definition you can customize it by clicking in the text fields and entering an attribute value, or selecting one from the drop-down.

Changes to the property definition can be persisted by clicking the button.

Different property types are indicated with different colors and icons.

Existing property definitions can be edited after clicking the button.

Concept

To enter editing mode and access functionalities related to authoring, click on the button in the upper right corner of the selected Code System's content page.

New concepts can be added to the Code System on the Content tab, after clicking on the button.

The concept selected in the tree at the time of creation will be considered the parent concept. If no concept is selected, the new concept will be placed in the root of the Code System, i.e. not under another concept. The selected parent can be modified either in the creation wizard or even after creation, through reparenting.

Field

Description

Term

The name of the new concept (mandatory)

Code

The identifier of the new concept. If you leave this field empty, the system will automatically generate an ID for your Concept

Parent

The concept under which the new concept will be created

After pressing the button, the new concept will be added to the Code System tree and its editor will automatically open on the right side.

By default, the term defined during creation becomes the preferred term of the concept.

Additional descriptions can be specified using the button.

You can also change the description type, and even add descriptions in other languages.

If you specify a new preferred term for a concept in a given language, the existing one will be switched to a synonym.

Properties

New properties conforming to the schema can be added using the button.

If you specify a default value in the Schema, the property will automatically be populated with it in the wizard.

If you restrict the potential number of values of a property, e.g. to1..1, it will be greyed out in the dropdown in case the cardinality is already reached.

Concept reparenting

The parent of a concept is specified during concept creation but it is also possible to modify the parent concept after the creation process.

Being mandatory for all concepts, the parent of a concept is considered a special property that is not maintained in the schema.

Clicking in the value field of the parent property offers a drop-down with the available concepts of the given Code System.

You can either browse the drop-down list or start typing in the value field to restrict the results, and then select the new parent.

Once the changes are accepted, the tree is updated and the concept is relocated under the new parent's node.

Issues

Users can create issues related to specific Code System concepts using the button, while existing issues can be viewed in the Issues tab.

Want to find out more about issues? Visit the Issue management page for more information.

Was this helpful?