<request>

Container for request information

<get_children>

Container for vocabulary data request

max

The maximum number of results requested.

hiddens

A flag to indicate if hidden terms should be returned.

synonyms

A flag to indicate if synonymous terms should be returned.

type

Indicates the amount of data to be returned (default / core / all).

blob

A flag to indicate if the blob / clob fields should be returned.

<parent>

The name of the parent node at which the request is targeted.

<get_term_info>

Container for vocabulary data request

max

The maximum number of results requested.

hiddens

A flag to indicate if hidden terms should be returned.

synonyms

A flag to indicate if synonymous terms should be returned.

type

Indicates the amount of data to be returned (default / core / all).

blob

A flag to indicate if the blob / clob fields should be returned.

<get_name_info>

Container for vocabulary data request

category

The category to search in

<get_code_info>

Container for vocabulary data request

category

The category to search in

<match_str>

Stores the value of a string that should be matched

strategy

Matching strategy (exact / left / right / contains)

<get_categories>

Container for vocabulary data request

type

Indicates the amount of data to be returned (default / core / all)

blob

A flag to indicate if the blob / clob fields should be returned

hiddens

A flag to indicate if hidden terms should be returned

synonyms

A flag to indicate if synonymous terms should be returned

<get_schemes>

Container for vocabulary data request

type

Indicates the amount of data to be returned (default / core / all)

blob

A flag to indicate if the blob / clob fields should be returned.

<add_child>

Container for term addition request

<level>

Also known as the hierarchy level. It represents the level of the item in the ontology tree where the root level is level 0.

<key>

A "
table code\hierarchy path" pair:

\\i2b2\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma

Equates to a table code of "i2b2" and the hierarchy of "\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma"

<name>

The name of the metadata term.
The following characters are not allowed for leaf names:

\ / " < ? %

Due to their prevalence in genomics the following characters are allowed but their general use is discouraged.
_ > :

The following characters are not allowed for folder or container names:

\ / " < ? % > :

<synonym_cd>

Indicates whether or not the term is a synonym of another term. The value can be "Y" or "N".

<visualattribues>

Three character string that indicates the graphical representation of the term.
Example:
String XYZ, where
X can be "C" (container), "F" (folder), "L" (leaf), "M" (multi)
Y can be "A" (active), "I" (inactive), "H" (hidden)
Z can be "E" (editable) or null

<totalnum>

The number of items found (not typically used).

<basecode>

The code representation of the term.

<metadataxml>

Additional xml that may be associated with the term (optional).

<facttablecolumn>

The observation fact table column associated with the term.

<tablename>

The dimension table associated with this term.

<columnname>

The name of the column in the dimension table associated with this term.

<columndatatype>

The data type for the column in the dimension table associated with this term.
"T" = text
"N" = number

<operator>

The SQL comparison operator associated with this term.

<dimcode>

The dimension code that is associated with the term.

<comment>

The optional comment associated with the term.

<tooltip>

A tooltip that is associated with the term.

<valuetype_cd>

Indicates the type of term
DOC = the term represents a document or note
LAB = the term is associated with a lab result
KEY = a keyword associated with a term (may be used for NLP)

<delete_child>

Container for term deletion request

include_children

A flag to indicate if the children of this node should also be deleted.

<level>

Also known as the hierarchy level. It represents the level of the item in the ontology tree where the root level is level 0.

<key>

A "
table code\hierarchy path" pair:

\\i2b2\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma

Equates to a table code of "i2b2" and the hierarchy of "\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma"

<name>

The name of the metadata term.

<synonym_cd>

Indicates whether or not the term is a synonym of another term. The value can be "Y" or "N".

<basecode>

The code representation of the term.

<modify_child>

Container for request to modify a term

incl_synonyms

A flag to indicate if synonyms of this node should also be modified.

<level>

Also known as the hierarchy level. It represents the level of the item in the ontology tree where the root level is level 0.

<key>

A "
table code\hierarchy path" pair:

\\i2b2\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma

Equates to a table code of "i2b2" and the hierarchy of "\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma"

<name>

The name of the metadata term.
The following characters are not allowed for leaf names:

\ / " < ? %

Due to their prevalence in genomics the following characters are allowed but their general use is discouraged.
_ > :

The following characters are not allowed for folder or container names:

\ / " < ? % > :

<synonym_cd>

Indicates whether or not the term is a synonym of another term. The value can be "Y" or "N".

<visualattribues>

Three character string that indicates the graphical representation of the term.
Example:
String XYZ, where
X can be "C" (container), "F" (folder), "L" (leaf), "M" (multi)
Y can be "A" (active), "I" (inactive), "H" (hidden)
Z can be "E" (editable) or null

<totalnum>

The number of items found (not typically used).

<basecode>

The code representation of the term.

<metadataxml>

Additional xml that may be associated with the term (optional).

<facttablecolumn>

The observation fact table column associated with the term.

<tablename>

The dimension table associated with this term.

<columnname>

The name of the column in the dimension table associated with this term.

<columndatatype>

The data type for the column in the dimension table associated with this term.
"T" = text
"N" = number

<operator>

The SQL comparison operator associated with this term.

<dimcode>

The dimension code that is associated with the term.

<comment>

The optional comment associated with the term.

<tooltip>

A tooltip that is associated with the term.

<valuetype_cd>

Indicates the type of term
DOC = the term represents a document or note
LAB = the term is associated with a lab result
KEY = a keyword associated with a term (may be used for NLP)

<update_crc_concept>

Container for the synchronize dimension table request

operation_type

Indicates the synchronization operation request type.

value

Description

update_only

Only add new terms from metadata to dimension table

synchronize_all

Perform a full synchronization between metadata and dimension table

hiddens

A flag to indicate if hidden terms should be included in the request.

synonyms

A flag to indicate if synonymous terms should be included in the request.

<get_ont_process_status>

Container for synchronization process status request

<process_id>

The ID of the process we are requesting the status for

<get_dirty_state>

Container for the dirty state request

<get_modifiers>

Container for vocabulary modifier data request

max

The maximum number of results requested.

hiddens

A flag to indicate if hidden modifiers should be returned.

synonyms

A flag to indicate if synonymous modifiers should be returned.

type

Indicates the amount of data to be returned (default / core / all).

blob

A flag to indicate if the blob / clob fields should be returned.

<get_modifier_children>

Container for vocabulary modifier data request

max

The maximum number of results requested.

hiddens

A flag to indicate if hidden modifiers should be returned.

synonyms

A flag to indicate if synonymous modifiers should be returned.

type

Indicates the amount of data to be returned (default / core / all).

blob

A flag to indicate if the blob / clob fields should be returned.

<parent>

The fullname of the parent modifier at which the request is targeted.

<applied_path>

The concept path that the parent modifier applies to.

<applied_concept>

The concept we are ultimately linking this modifier to.

<get_modifier_info>

Container for vocabulary modifier data request

max

The maximum number of results requested.

hiddens

A flag to indicate if hidden modifiers should be returned.

synonyms

A flag to indicate if synonymous modifiers should be returned.

type

Indicates the amount of data to be returned (default / core / all).

blob

A flag to indicate if the blob / clob fields should be returned.

<self>

The fullname of the modifier at which the request is targeted.

<applied_path>

The concept path the modifier applies to.

<get_modifier_name_info>

Container for vocabulary modifier data request

max

The maximum number of results requested.

hiddens

A flag to indicate if hidden modifiers should be returned.

synonyms

A flag to indicate if synonymous modifiers should be returned.

type

Indicates the amount of data to be returned (default / core / all).

blob

A flag to indicate if the blob / clob fields should be returned.

<self>

The fullname of the concept at which the requested for the specified modifier is targeted.

<match_str>

The keyword specifying the name of the modifier to return

<get_modifier_code_info>

Container for vocabulary modifier data request

max

The maximum number of results requested.

hiddens

A flag to indicate if hidden modifiers should be returned.

synonyms

A flag to indicate if synonymous modifiers should be returned.

type

Indicates the amount of data to be returned (default / core / all).

blob

A flag to indicate if the blob / clob fields should be returned.

<self>

The fullname of the concept at which the requested for the specified modifier is targeted.

<match_str>

The keyword specifying the code of the modifier to return