<response>

Container for response information

<concepts>

Container for a list of terms returned in a response

<concept>

Container for a term returned in a response; an object that holds information from rows in a metadata table

<level>

Also known as the hierarchy level. It represents the level of the concept 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)

<modifier>

Modifier associated with the concept, if it exists.

<ontology_process_status>

Container for the requested synchronization process status

<process_id>

The ID for the process we requested the status for

<process_type_cd>

Provides information about the type of process that is currently in progress. The following codes are in use:

value

Description

ONT_ADD_CONCEPT

A term has been added

ONT_DELETE_CONCEPT

A term has been deleted

ONT_EDIT_CONCEPT

A term has been edited

ONT_UPDATE_CRC_CONCEPT

An "update_only" has been performed.

ONT_SYNCALL_CRC_CONCEPT

A "synchronize_all" has been performed

<process_step_cd>

In the case of ONT_UPDATE_CRC_CONCEPT and ONT_SYNCALL_CRC_CONCEPT, provides additional information about the process step that is currently in progress. The following codes are in use:

value

Description

ONT_BUILD_PDO_START

Start the process

ONT_SENTTO_FRC

The file has been sent to the File Repository Cell (FRC)

ONT_SENTTO_CRCLOADER

Instructs the CRC to load the file

<start_date>

The date the process was requested

<end_date>

The date the process was completed

<process_status_cd>

Provides information about the process step:

value

Description

ERROR

An error has occurred

PROCESSING

The process step is in progress

COMPLETED

The process has completed

<crc_upload_id>

The corresponding CRC upload id for the ONT_SENTTO_CRC_LOADER process step

<message>

Miscellaneous status message

<dirty_state>

Container for the dirty state information

The following dirty state codes are in use:

value

Description

NONE

Indicates that no synchronization or update actions are required

ADD

Indicates an update action is required

DELETE_EDIT

Indicates a synchronization action is required

<modifier>

Container for a modifier returned in a response; an object that holds information from rows in a metadata table

<level>

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

<applied_path>

The path of the concept that the modifier applies to.

<key>

A "
table code\hierarchy path" pair:

\\i2b2\Mild

Equates to a table code of "i2b2" and the hierarchy of "\Mild\"

<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 modifier is a synonym of another modifier. 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 "O" (container), "D" (folder), "R" (leaf)
Y can be "A" (active), "I" (inactive), "H" (hidden)
Z can be "E" (editable) or null

<totalnum>

The number of patients having this modifier (not typically used).

<basecode>

The code representation of the modifier.

<metadataxml>

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

<facttablecolumn>

The observation fact table column associated with the modifier.

<tablename>

The dimension table associated with the modifier.

<columnname>

The name of the column in the dimension table associated with the modifier.

<columndatatype>

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

<operator>

The SQL comparison operator associated with the modifier.

<dimcode>

The dimension code that is associated with the modifier.

<comment>

The optional comment associated with the modifier.

<tooltip>

A tooltip that is associated with the modifier.