Get HPO Term
get_termRead-onlyIdempotent
Retrieve a complete HPO term record including definition, synonyms, cross-references, and hierarchical relationships by providing an HP ID, label, or external reference.
Instructions
Return an HPO phenotype term record: definition, synonyms (exact/related/broad/narrow), alt_ids, subsets, comments, cross-references, direct parents and children, and obsolescence (replaced_by). The term accepts an HP id, a label/synonym, or an external xref CURIE (resolved first). Pass fields=['synonyms', 'definition'] for a sparse projection. Note on synonyms shape: compact (default) returns synonyms as plain strings; standard/full return {text, scope} objects. Signature: get_term(hpo_id, response_mode=, fields=).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset: return ONLY these top-level keys (dot into a grouped object, e.g. 'xrefs.UMLS'). Identity anchors (hpo_id, name, hpo_version) are always included. Omit for the full payload. | |
| hpo_id | Yes | Canonical HP id for the resolved HPO term (HP:0000118). Legacy `term` arguments are accepted as an alias. | |
| response_mode | No | Verbosity: minimal|compact|standard|full (default compact). | compact |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| name | No | ||
| _meta | No | ||
| field | No | ||
| hpo_id | No | ||
| alt_ids | No | ||
| message | No | ||
| parents | No | ||
| subsets | No | ||
| success | No | ||
| children | No | ||
| comments | No | ||
| obsolete | No | ||
| synonyms | No | ||
| retryable | No | ||
| candidates | No | ||
| definition | No | ||
| error_code | No | ||
| hpo_version | No | ||
| allowed_values | No | ||
| recovery_action | No | ||
| recommended_citation | No |