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

get_modifier_code_info

The get_modifier_code_info message provides inf= ormation needed to populate a tree node for a given search keyword. This me= ssage requires the user to pass a string that is queried against the _C_BAS= ECODE_ column.

=20

Return Name / Info= rmation Associated with a Code

=20

To generate a list of base tree nodes or a list of names associated with= a given keyword, the sequence of events is as follows:

=20
    =20
  1. A client requests modifier(s) associated with a concept. These modifier= s are specified as a basecode containing a given keyword.
  2. =20
  3. The ONT server performs the following steps:=20
      =20
    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 th= at is referenced by the table key that is passed in. If not, the client rec= eives an error message with the code "TABLE_ACCESS_DENIED"
    2. =20
    3. If max is set, query the database for the number of entries that meet t= he search criteria.
    4. =20
    5. If count <max or no max is set, query the database for entries that = meet the search criteria.
    6. =20
    7. If count > max send an error message back.
    8. =20
  4. =20
=20


=20
    =20
  1. The client generates a list of modifiers that match the search criteria= .
  2. =20
  3. 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.
  4. = =20
=20



= =20

get_modifier_code_info = Request Message

=20

A get_modifier_code_info message implies that the user = is passing a code and wants the associated modifier information ab= out that code returned.
The attributes provide information about the re= sults to be returned. The hiddens and synonyms attributes tell us whether t= o return hiddens and synonyms. By default hiddens and synonyms are false, s= o if they are left out it will be false. The type tells which columns to se= lect (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. E= ach message will interpret the default to be a different set of columns. Th= e default set of columns for get_modifier_code_info consis= ts of name only.

=20 =20


The blob attribute indicates = whether or not to return the blob along with the default / core / all retur= n columns.
Example:
<message_body>
<get_modifier_co= de_info blob=3D"t= rue" type=3D"limit= ed" max=3D"200" synonyms=3D"true" hiddens=3D"false">
<match_= str strategy=3D"e= xact">SNO:255604002</
match_str>=
<self>
\\i2b2_DEMO\i2b2\Diagnoses\Circulatory system (390-459)\Arterial vascular = disease (440-447)(444) Arterial embolism and throm~{color:#0000ff}</self= >
</get_modif= ier_code_info>
</message_body>

= =20

Possible "type" Settings

=20


=20
=20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20 =20

Value

Description

default

Return only the name

limited

Return all data except the system / date and = dimension information

core

Return all data except the system / date info= rmation

all

Return all data

=20



= =20

get_modifier_code_info= Response Message

=20


The ONT request to map a code to a mod= ifier has the following settings:
type=3Dlimited
blob=3Dfalse

= Response Message:
<message_body>
= <modifiers>
<modifier><= /span>
<level>= ;1</level>=
<applied_path>\i2b2\Diagnoses%</<= /span>applied_path>
<key>\\i2b2_DEMO\Severity\Mild{color:#0000f= f}</key>
<fullname>\Severity\M= ild{color:#0000ff}</fullname>
<name>Severity: Mild</name>
<visualattributes>RA </<= /span>visualattributes>
<synonym_cd= >N</synonym_cd>
<totaln= um />
<basecode>SNO:2556040= 02</basecode>
<comment /&g= t;
<tooltip>Severity \ Mild</tooltip>
<= ;/modifier>
</modifiers>

</message_body<= /span>>

------=_Part_8257_2120283942.1711665738766--