Authoring
Last updated
Last updated
The authoring process of Custom Code Systems can flow on two different levels: schema and concept.
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:
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.
Different property types are indicated with different colors.
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.
You can specify alternative terms for a concept, and even move the preferred flag to the newly added terms.
If you specified a default value in the Schema, the property will automatically be populated with it when adding a new value.
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.
Users can create issues related to specific Code System concepts using the Raise an issue context menu option, while existing issues can be viewed by selecting the Show issues action.
Want to find out more about issues? Visit the Issue management page for more information.
| Attribute | Description |
|---|---|
Changes to the property can be persisted by clicking the button.
Existing properties can be edited after clicking the button.
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.
| Field | Description |
|---|---|
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.
The preferred term of the concept - by default, the one defined during creation - is indicated with an icon.
Property types defined in the Code System Schema are automatically displayed in the concept editor. Values can be added to the properties by pressing the button.
If you restricted the potential number of values of a property, e.g. to1..1, the button won't appear and you won't be able to add more values to the given property.
To access issue management related options, press the button.
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
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
