Resolve HPO Term
resolve_termRead-onlyIdempotent
Resolve phenotype labels, synonyms, HP IDs, or external cross-references to canonical HPO terms, handling ambiguous queries and obsolete IDs with replacement suggestions.
Instructions
Resolve a phenotype label, synonym, HP id (HP:0000118), or external cross-reference CURIE (UMLS:C0036572, SNOMEDCT_US:193046000, ...) to the canonical HPO term {hpo_id, name, match_type}. An ambiguous label returns ambiguous_query with candidates; an obsolete HP id returns not_found with its successor in replaced_by. This is the recommended first step — resolve any query to a canonical HP id before calling get_term. Signature: resolve_term(query, response_mode=).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | A phenotype label, synonym, HP id (HP:0000118), or external xref CURIE (UMLS:C0036572, SNOMEDCT_US:193046000, ...). | |
| response_mode | No | Verbosity: minimal|compact|standard|full (default compact). | compact |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| success | No | ||
| _meta | No | ||
| error_code | No | ||
| message | No | ||
| retryable | No | ||
| recovery_action | No | ||
| field | No | ||
| allowed_values | No | ||
| hint | No | ||
| candidates | No | ||
| query | No | ||
| hpo_id | No | ||
| name | No | ||
| match_type | No | ||
| obsolete | No | ||
| hpo_version | No | ||
| recommended_citation | No |