---
title: "Symbols"
slug: "symbols"
updated: 2025-12-12T21:14:07Z
published: 2025-12-12T21:14:07Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.imat.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Symbols

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 resolves to the appropriate list of words or values.

---

[Video](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/symbols.mp4)

## Create Symbols

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

1. Click add_circle.
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 with commas. For the values, use the different field names that have the same information. They must match the spelling used while indexing the data.
6. Click add_circle.
7. Click Add Symbol.

---

![symbols-edit(1)](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/symbols-edit(1).png)Click on image to zoom.

## Edit 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 or description.

---

![symbols-edit-description](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/symbols-edit-description.png)Click on image to zoom.

### Edit the Description

1. Click edit.
2. Change the description.
3. Click Update Symbol.

---

![symbols-manage-symbols](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/symbols-manage-symbols.png)Click on image to zoom.

### Manage Values

1. Click **Manage Values**to edit the values.
2. Enter new values for the symbol, then click add_circle. Use a comma-separated list to add multiple values at once.
3. Remove values by clicking clear.
4. Click Update.

---

  

## Use Symbols

Symbols are used in queries after they've been created. See [Query Syntax](/query-syntax#symbols-symbol-map) for more information.

---

  

### Fields

The proper syntax for using fields is below. Note the use of [FOR](/query-syntax#for) with *hedis* being the category name and *a1c* being the symbol name. The value is a wild card search indicated by the asterisk.

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

Use the symbol in the field parameter.

```python
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](/query-syntax#in).

```python
psfieldnames:IN(<hedis.a1c>)
```

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

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

---

![symbols-delete(1)](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/symbols-delete(1).png)Click on image to zoom.

## Delete Symbols

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

---

![symbols-xml-access](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/symbols-xml-access.png)

Click on image to zoom.

![symbols-XML](https://cdn.document360.io/5bf5f14a-9e3f-48aa-a2b9-2be6d9100091/Images/Documentation/symbols-XML.png)

Click on image to zoom.

## Edit Category XML

It is possible to edit the XML of a symbol; however, we suggest that if you are not familiar with XML, 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.