Freeplane CTS2-LE Plugin: Editing Terminologies

Aus CTS2-LE
Zur Navigation springen Zur Suche springen

The CTS2-LE-Addon for Freeplane applies the concept of mind mapping to the authoring of value sets and code systems. This section explains how to create and/or edit a new code system.

Create a new code system

To create a new code system:

  1. Use the menu item File -> New map from template…
  2. In the Open dialog, choose the file Neues-FHIR-ValueSet.mm. A mindmap containing a single root node is created.
  3. In the root node, adapt label and attribute values. See section Constituting a code system.

Open an existing code system for editing

The Freeplane CTS2-LE Add-On manages code systems as FHIR Value Set resources. By this you can use the tool for editing any existing FHIR Value Set resource file.

To import a FHIR ValueSet:

  1. Use the menu item File -> New map from template…
  2. Use the menu item Tools -> FHIR ValueSet Tools -> Import FHIR ValueSet. Or, use the keyboard shortcut F9.

Note: The imported FHIR ValueSet is not the working file. To update the imported FHIR ValueSet file with changes you made in Freeplane, use the feature Exporting as FHIR ValueSet file.

Constituting a code system

The root node comprises a label and a set of attributes (name-value pairs). Modify the label and attribute values to set the metadata of the code system:

Root Node Attribute Effect on Metadata
Label Sets the name.
description Sets the description.
groupName Selects the group, which contains the code system when published on CTS2-LE.
status Sets the status. The value shall be one of draft, active, and retired.
uri Sets the namespace URI.
language Sets the language code.

Adding a code to a code system

A code in a code system is a node in the mindmap. To add a code, you add a node to the mindmap and set its attributes.

To add a code to a code system:

  1. Open a code system by - creating a code system, or by - importing a FHIR ValueSet file, that defines a code system, or by - opening a Freeplane file, that models a code system.
  2. Select the node, that is parent to the new code. Code systems may be flat, in which case you would select the root node of the code system as a parent.
  3. Use the menu item Edit -> New node -> New child node. Or, use the keyboard shortcut INSERT.
  4. Set the label and attribute values of the new code-node.
Node Attribute Effect on Metadata
Label Sets the display name of the code.
code Sets the code value of the code. The code value is in the namespace URI of the code system as defined on the root node.
definition Sets the definition or description of the code.

Exporting a code system as a FHIR ValueSet file

Code systems authored with the CTS2-LE-Addon are not connected to any FHIR ValueSet Ressource in the first place. Instead, your working document is a Freeplane mindmap document.

To export the mindmap document as FHIR ValueSet file:

  1. Open the Freeplane working document that models the code system or value set.
  2. If working document has unsafed changes, save.
  3. Use the menu item Tools -> FHIR ValueSet Tools -> Export FHIR ValueSet. Or, use the keyboard shortcut F10.
  4. In the file chooser dialog, select or name the target file. If the file exists already, it will be overwritten.

Publishing to CTS2-LE

Code systems authored with the CTS2-LE-Addon are not connected to versions published on CTS2-LE.

To publish a value set or code system on CTS2LE:

  1. Open the Freeplane working document that models the code system.
  2. Use the menu item Tools -> FHIR ValueSet Tools -> CTS2-Upload. Or, use the keyboard shortcut F11.