Page History
...
max = 200 (or higher)
type = core
|
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
- The get_children message implies that the user is passing a key / path for a parent and wants the children returned. The parent tag will tell the service what metadata table / path to search in and for the get_children message must be specified. The structure of a parent is organized as follows:
\\table_key\path
The key (i2b2) plus the path (\RPDR\Diagnoses\Circulatory system (390-459)) is the parent:
<parent>\\i2b2\RPDR\Diagnoses\Circulatory system (390-459)</parent>
The remaining attributes provide information about the results to be returned. - If the number of rows found is greater than max, then an error message will be return in the i2b2 header. If max is left out then it is interpreted that there is no max.
- The hiddens and synonyms attributes tell 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 actually include it if you want the default set of columns returned. Each message will interpret "default" to be a different set of columns. get_children's default set of columns is set to 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" in this case). 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.
- The numLevel attribute (added in 1.7.13) specifies how many levels of children will be returned. 1, the default, will return immediate children. 0 will return all children. Larger numbers will return the specified number of levels of children.
<message_body>
<get_children max="200" numLevel="1" hiddens="true" synonyms="true" type="default" blob="false">
<parent>\\i2b2\RPDR\Diagnoses\Circulatory system (390-459)</parent>
</get_children>
</message_body>
| Anchor | ||||
|---|---|---|---|---|
|
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" |
...
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" |
...
Value | Description | Example | |
false | Do not return data stored as a blob or clob | xml, comments | |
true | Return xml and comments |
|
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
...
