The get_code_info message provides information about codes. A get_code_info message implies that the user is passing a scheme:code pair and wants the associated information about that pair returned.

Return Name / Information Associated with a Code

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

1. A client requests information for a given scheme:code (type=default)
2. The ONT server performs the following steps:
   1. Get the project / role available for the user from the PM cell; this also serves to validate the user.
   2. Query the table of tables to confirm that the user / role can access category passed in. If not, return coded error.
   3. Queries a list of tables for entries that match the scheme:code pair.

1. If error, the client receives an error message with the code TABLE_ACCESS_DENIED.
2. The client maps name / information to request.

get_code_info Request Message

A get_code_info message implies that the user is passing a scheme:code pair and wants the associated information about that pair returned.
The attributes provide information about the results to be returned. The hiddens and synonyms attributes tell us whether to return hiddens and synonyms. 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). 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 the default to be a different set of columns. The default set of columns for get_code_info consists of name only.

• If type = core, then all columns except the blob and the system / date information will be returned.
• 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.
Example:
<message_body>
<get_code_info hiddens="true" synonyms="true" type="default" blob="false">
<match_str strategy="exact">ICD9:493</match_str>
</get_code_info>
</message_body>

Possible "type" Settings

get_code_info Response Message

The ONT request to map scheme:code pair to a name has the following settings:
type=default
blob=false

Response Message:
<message_body>
<concepts>
<concept>
<name>Asthma</name>
</concept>
</concepts>
</message_body>

The find terms search by code has the following settings:
type=core
blob=false
Response Message:
<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>0</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>
<tooltip>Diagnoses \ Respiratory system \ Chronic obstructive diseases \ Asthma</tooltip>
</concept>
</concepts>
</message_body>