Symbols
  • 02 May 2024
  • 2 Minutes to read
  • Dark
    Light

Symbols

  • Dark
    Light

Article summary

Often a list of either field names or values recurs in query expressions. For example, if the same type of data has been given different field names, a search must be done to include all the field names that contain the same data: age, patient_age, age_of_patient, age_patient. To facilitate data entry, the administrator can define a Symbols map where a named symbol can resolve to the appropriate list of words or values.


Click on image to zoom

Creating Symbols

Categories are used to group the same types of information together. For example, you may choose to name a category name. You then can create symbols for given names, middle names, last names, titles, etc. Create categories by using the following steps:

  1. Click add_circle (Add symbols).
  2. Type in the Category name. Category names must be made of only letters and numbers.
  3. Type in the Name. Symbol names must be made of only letters and numbers. Names are case insensitive, so capitalization is unimportant.
  4. Type in the Description.
  5. Enter the Values; enter more than one at a time by separating the values by commas. For the values, use the different field names that have the same information. They must match the spelling as used while indexing the data.
  6. Click add_circle (Add items).
  7. Click Add Symbol.

Click on image to zoom

Editing Symbols

Some items of symbols can be edited after they've been created. Click on the symbol name. Utilize the search to find the symbol without having to scroll through the entire list. Searching for any combination of letters finds any symbol with those letters anywhere in the name. In the details pane that opens, you can edit the following:

  1. Edit the Description by clicking on edit.
  2. Click on Manage Values to edit the values. In the new dialog that opens, follow the steps below:
    1. Add new values to the symbol. Once again, you can add multiple values at a time if you separate them by commas.
    2. Remove values by clicking, clear.
    3. Click Update.


Using Symbols

Symbols are used in queries after they've been created. See here for more information.



Fields

The proper syntax for using fields is below. Note the use of FOR with hedis being the category name and a1c being the symbol name. The value is a wild card search indicated by the asterisk.

()FOR(<hedis.a1c>):[*]

Use the symbol in the field parameter.

https://<appliance_ip>/search?q=()boolean&fields=<category.symbol_name>


Values

The proper syntax for using values is below. Note the use of psfieldnames and IN.

psfieldnames:IN(<hedis.a1c>)

It is also possible to combine the field names and values.

()FOR(field_name.<category.symbol>):IN(<category.symbol>)

Click on image to zoom

Deleting Symbols

  1. Locate and click on the correct symbol.
  2. Click Delete.
  3. Confirm you want to delete the symbol.

Click on image to zoom

Editing Category XML

It is possible to edit the XML of a symbol; however, we suggest that if you are not familiar with XML, that you contact professional services rather than editing the XML directly. The other option is to add or edit symbols through the steps listed above. To edit the XML directly, follow the steps below.

  1. Access the menu by clicking more_vert found in the top right next to the add symbols icon.
  2. Click Edit Category XML.
  3. Either select a category or add a new category by clicking add_circle.
  4. Edit the fields, the values, or both. In most cases you'll want to update both.
  5. Click Update Fields, Update Values, or both.
  6. Click arrow_back to return to the Symbols home screen.

Was this article helpful?

What's Next