A get_modifier_info message implies that the user is passing a key / path for a modifier ("self") and wants information about that modifier returned.

Return Information Associated with a Modifier

The get_modifier_info message is used by the CRC to obtain information associated with a modifier. The sequence of events is as follows:

1. The client requests information for a given modifier (type = core).
2. The ONT server performs the following steps:
   1. Parses <self> to obtain the table key and path. Queries the table of tables to confirm that the user / role can access the table that is referenced by the table key passed in. If not, return coded error.
   2. Query the database for the modifier that meets <self>, <applied_path> criteria.

• If an exact match is found then the information about the requested modifier will be sent.
• If the <self> is found but the <applied_path> is not then all modifiers with the requested <self> will be returned.

1. The client receives information about the modifier.

get_modifier_info Request Message

A get_modifier_info message implies that the user is passing a key / path for a modifier ("self") and wants information about that modifier returned. The attributes provide information about the results to be returned. The hiddens and synonym tell whether to return hidden and synonyms. By default hiddens and synonyms are false, so if they are left out it will be false. The type tells which columns to select (default / core / all). By default, the type is set to default so you don't have to include it if you want the default set of columns returned. Each message will interpret "default" to be a different set of columns. GetModifierInfo's default set of columns consists of all columns except the blob and the system / date information. If type = core, then all columns except the blob and the system / date information will be returned (same as default). If type = all, then all columns except the blob are returned. The blob attribute indicates whether or not to return the blob along with the default / core / all return columns.
Example:
<message_body>
<get_modifier_info hiddens="false" synonyms="false" type="core" blob="true">
<self>\\i2b2\Severe{color:#0000ff}</self>
<applied_path>\i2b2\Diagnoses%</applied_path>
</get_modifier_info>
</message_body>

Possible "hiddens" Settings

Some modifiers exist but for various reasons are not displayed in the query tree.

Possible "synonyms" Settings

Some modifiers are listed as synonyms for other modifiers.

Possible "type" Settings

Possible "blob" Settings

get_modifier_info Response Message

The request has the following settings:
type=default
blob=false

Response Message:
<message_body>
<modifiers>
<modifier>
<level>1</level>
<applied_path>\i2b2\Diagnoses%</applied_path>
<key>\\i2b2\Severe{color:#0000ff}</key>
<fullname>\Severe{color:#0000ff}</fullname>
<name>Severe</name>
<visualattributes>DA </visualattributes>
<synonym_cd>N</synonym_cd>
<totalnum xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true" />
<basecode>severe</basecode>
<tooltip>Severe</tooltip>
</modifier>
</modifiers>
</message_body>