Message-ID: <1563697796.7436.1711617862237.JavaMail.confluence@ip-172-30-4-17.ec2.internal> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_7435_1550667076.1711617862235" ------=_Part_7435_1550667076.1711617862235 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html Getnameinfo

Getnameinfo

The get_name_info message returns the informati= on needed to populate a tree node for a given search keyword or name. This = message requires the user to pass a string that is queried against the = name column.

Gene= rate Tree NoDes for a Given Name

To generate a list of base tree nodes associated with a given search key= word or name, the sequence of events is as follows:

  1. The client requests node(s) for a given name / category. If the request= message indicates all categories should be searched, loop through all know= n categories for the user (type =3D default)
  2. The WORK server performs the following steps:
    1. Query the table of tables to confirm that the user / role can access ca= tegory passed in. If not, return coded error. The client receives an error = message with the code "TABLE_ACCESS_DENIED"
    2. If max is set, query the database for the number of entries that meet t= he search criteria.
    3. If count <max or no max is set, query the database for entries that = meet the search criteria.
    4. If count > max send an error message back.


  1. The client generates a list of nodes that match the search criteria.
  2. The client receives an error message with the code "MAX_EXCEEDED" and d= isplays a dialog asking if the user wants to see all nodes. If no =E2=80=93= done. If yes =E2=80=93 client sends another message with max empty.



get_nam= e_info Request Message

This message requires the user to pass a string that is queried against = the "name" column. The category attribute does not have to be incl= uded and if it is not, all categories the user is allowed to see will be se= arched.
The remaining attributes provide = information about the results to be returned. If the number of rows found i= s greater than the max, then an error message will be returned in the i2b2 = header. If the max is left out then it is interpreted that there is no max.= 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). B= y default, the type is set to default. Each message will interpret= the default to be a different set of columns. The default set of columns f= or get_name_info includes the name column only.



The = blob attribute indicates whether or not to return the blob along w= ith the default / core / all return columns.
The <match_str> tag tells the service which string to se= arch for. It is implied by the message get_name_info that = the column to search is the name. The strategy attribute explains = how the search must match (exact, left, right, contains).
<message_body>
<<= span style=3D"color: rgb(163,21,21);">get_name_info category= =3D"demo" max=3D"200""hiddens=3D"true" type=3D"= core" blob =3D "false">
<<= span style=3D"color: rgb(163,21,21);">match_str
strategy=3D"contains">asthma&= lt;/match_str>
</get_name_info>
</message= _body>

Possible "hidden= s" Settings

Some ontology terms exist but for various reasons are not displayed in t= he query tree.

Value

Description

false

Do not return data categorized as "hidden"

true

Include data categorized as "hidden"


Possible "blob" Set= tings


Value

Description

Example

false

Do not return data stored as a blob or clob

xml, comments

true

Return xml and comments

 


Possible "strat= egy" Settings


Value

Description

contains

Return data whose name contains the match str= ing

exact

Return data whose name exactly matches the ma= tch string

left

Return data whose name starts with the match = string

right

Return data whose name ends with the match st= ring


get_na= me_info Response Message

The request has the following settings:
type=3Dcore
blob=3Dfalse

Example:
<message_body><= br> <ns4:folders>
=  <folder>
<= ;name>
11 years old d= emo
</name>
&l= t;user_id>
demo
&= lt;/user_id>
<group_id>
Demo
</<= span style=3D"color: rgb(136,18,128);">group_id>
<share_id>
N
</share_id>
<index>
\\demo\u5eHaJVYD2iaZ5LJu7Tw9<= br> </index>
<<= span style=3D"color: rgb(136,18,128);">parent_index>
c6Y5JaJi= g614lNQNPSob8
</parent_index= >
<visual_attribut= es>
ZA
</visua= l_attributes>
<too= ltip>
Demo - 11 years old demo
</tooltip>
<work_xml>
<ns2:plugin_drag_drop>
<ns5:concepts>
 <concept>
<level>
4
</level>
<key
>
\\i2b2_DEMO\demo\Demographics\Age\10-17 years old\11 years old de= mo\
</key>
<= ;name>
11 years old d= emo
</name>
&l= t;synonym_cd>
N
&= lt;/synonym_cd>
<<= span style=3D"color: rgb(136,18,128);">visualattributes>
LA </visualattributes>=
<totalnum>
un= defined
</totalnum>= ;
<basecode />= ;
<facttablecolumn>= ;
patient_num
</facttabl= ecolumn>
<tablenam= e>
patient_dimension
</tablename>
<columnname>
birth_date
</columnname>
<columndatatype>
N
</columndatatype>
<operator>
BETWEEN
</operator>
<dimcode>
getdate() - (365.25 *12) +1 AND getdate= () - (365.25 * 11) + 1
</dim= code>
<comment />
<tooltip>
Demographics \ Age \ 10-17 years old \ 11 years old demo
<= ;/tooltip>
 <= /concept>
</ns5:concepts>
</ns2:plugin_drag_drop>
</work_xml
>
<work_xml_i2b2_type>
CONCEPT </work_xml_i2b2_type>= ;
 </folder><= br> </ns4:folders>
= </message_body><= /span>

------=_Part_7435_1550667076.1711617862235--