Server (Cells) Messaging Home
Space shortcuts
Space Tools
Skip to end of metadata
Go to start of metadata

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

Return Information Associated with a Node

The get_term_info message is used by the timeline to obtain information associated with a node. The sequence of events is as follows:

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


  1. If error, the client receives an error message with the code TABLE_ACCESS_DENIED.
  2. The client receives information about the node.



get_term_info Request Message

A get_term_info message implies that the user is passing a key / path for a node ("self") and wants information about that node returned. The attributes provide information about the results to be returned. The hiddens and synonyms attribute tells whether to return hiddens and synonyms. Be 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. getTermInfo'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.
<message_body>
<get_term_info max="200" hiddens="false" synonyms="false" type="default" blob="true">
<self>\\i2b2\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma</self>
</get_term_info>
</message_body>

Possible "hiddens" Settings

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

Value

Description

false

Do not return data categorized as "hidden"

true

Include data categorized as "hidden"



Possible "synonyms" Settings

Some ontology terms are listed as synonyms for other terms.

Value

Description

false

Do not return data categorized as "synonym"

true

Include data categorized as "synonym"



Possible "type" Settings


Value

Description

default

Return all data except system / date information

core

Return all data except system / date information (same as default)

all

Return all data



Possible "blob" Settings


Value

Description

Example

false

Do not return data stored as a blob or clob

xml, comments

true

Return xml and comments

 



get_term_info Response Message


The request has the following settings:
type=default
blob=false
Example:
<message_body>
<concepts>
<concept>
<level>4</level>
<key>\\i2b2\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma</key>
<name>Asthma </name>
<synonym_cd>N</synonym_cd>
<visualattributes>FA </visualattributes>
<totalnum/>
<basecode>ICD9:493</basecode>
<facttablecolumn>concept_cd</facttablecolumn>
<tablename>concept_dimension</tablename>
<columnname>concept_path</columnname>
<columndatatype>T</columndatatype>
<operator>LIKE</operator>
<dimcode>\RPDR\Diagnoses\Respiratory system (460-519)\Chronic obstructive diseases (490-496)(493) Asthma</dimcode>
<comment/>
<tooltip>Diagnoses \ Respiratory system \ Chronic obstructive diseases \ Asthma</tooltip>
</concept>
</concepts>
</message_body>

The request has the following settings:
type=default
blob=true
Example:
<message_body>
<concepts>
<concept>
<level>5</level>
<key>\\rpdr\RPDR\Labtests\LAB(LLB16) Chemistry(LLB31) Anemia Related Studies\B12USAT\BC1-107</key>
<name>B12 unsat bind (Test:bc1-107)</name>
<synonym_cd>N</synonym_cd>
<visualattributes>LA </visualattributes>
<totalnum>0</totalnum>
<basecode>BC1-107</basecode>
<metadataxml>
<ValueMetadata>
<Version>3.02</Version>
<CreationDateTime>10/07/2002 15:08:07</CreationDateTime>
<TestID>BC1-107</TestID>
<TestName>B12 UNSAT BIND</TestName>
<DataType>PosFloat</DataType>
<CodeType>TST</CodeType>
<Loinc>2171-7</Loinc>
<Flagstouse>HL</Flagstouse>
<Oktousevalues>Y</Oktousevalues>
<MaxStringLength />
<LowofLowValue>1000</LowofLowValue>
<HighofLowValue>1000</HighofLowValue>
<LowofHighValue>2000</LowofHighValue>
<HighofHighValue>2000</HighofHighValue>
<LowofToxicValue />
<HighofToxicValue />
<EnumValues>
<Val />
</EnumValues>
<CommentsDeterminingExclusion>
<Com>contamin</Com>
<Com>hemoly</Com>
</CommentsDeterminingExclusion>
<UnitValues>
<NormalUnits>ng/l</NormalUnits>
<EqualUnits>pg/ml</EqualUnits>
<ExcludingUnits />
<ConvertingUnits>
<Units />
<MultiplyingFactor />
</ConvertingUnits>
</UnitValues>
<Analysis>
<Enums />
<Counts />
<New />
</Analysis>
</ValueMetadata>
</metadataxml>
<facttablecolumn>concept_cd</facttablecolumn>
<tablename>concept_dimension</tablename>
<columnname>concept_path</columnname>
<columndatatype>T</columndatatype>
<operator>like</operator>
<dimcode>\RPDR\Labtests\LAB(LLB16) Chemistry(LLB31) Anemia Related Studies\B12USAT\BC1-107</dimcode>
<tooltip>Labtests \ Chemistry \ Anemia Related Studies \ B12 Unsaturated Binding (Group:B12USAT) \ B12 unsat bind (Test:bc1-107)</tooltip>
</concept>
</concepts>
</message_body>