Orphadata through GeneFoundry
Resolve rare disease concepts and explore Orphadata nomenclature, classifications and associations.
- Research area
- Ontologies
- Namespace
orphanet- Listed tools
- 19
- Upstream source
- Orphadata
Research tasks
- Resolve a disease name to an ORPHA code
- Review rare disease gene and phenotype associations
Start with tool discovery
The catalog lists orphanet_resolve_disease as a representative tool. After connecting your client, inspect the tools and input requirements returned by the service before submitting a query.
Identifiers to prepare
- Disease label or synonym
- ORPHA code
- External disease CURIE such as OMIM or MONDO
All available tools (19)
The router surfaces these tools namespaced under orphanet_*:
get_server_capabilitiesReturn the orphanet-link discovery surface: identity/build/Orphanet release, the tool list WITH call signatures, response modes, recommended workflows, the cross-reference source ranking, the error taxonomy, and limits. detail='full' adds the full policy notes. Call this first in a cold session, or read orphanet://tools / orphanet://capabilities. Signature: get_server_capabilities(detail=).
Return the orphanet-link discovery surface: identity/build/Orphanet release, the tool list WITH call signatures, response modes, recommended workflows, the cross-reference source ranking, the error taxonomy, and limits. detail='full' adds the full policy notes. Call this first in a cold session, or read orphanet://tools / orphanet://capabilities. Signature: get_server_capabilities(detail=).
Input parameters
detail(string) — summary (default, light) or full (adds policy notes).
get_diagnosticsReport the local Orphanet index status: whether the data is built, the loaded Orphanet release version, disorder counts, schema version, and when it was built, plus a runtime block (request/error counts, latency percentiles p50/p95/p99, a response_mode distribution that surfaces over-fetch, and a version-hash cache hit/miss ratio). Use this to confirm freshness or diagnose a data_unavailable error. Signature: get_diagnostics().
Report the local Orphanet index status: whether the data is built, the loaded Orphanet release version, disorder counts, schema version, and when it was built, plus a runtime block (request/error counts, latency percentiles p50/p95/p99, a response_mode distribution that surfaces over-fetch, and a version-hash cache hit/miss ratio). Use this to confirm freshness or diagnose a data_unavailable error. Signature: get_diagnostics().
resolve_diseaseResolve a disease label, synonym, or ORPHAcode (ORPHA:166024 or 166024) to the canonical Orphanet term {orpha_code, name, match_type}. An ambiguous label returns ambiguous_query with candidates. Signature: resolve_disease(query, response_mode=).
Resolve a disease label, synonym, or ORPHAcode (ORPHA:166024 or 166024) to the canonical Orphanet term {orpha_code, name, match_type}. An ambiguous label returns ambiguous_query with candidates. Signature: resolve_disease(query, response_mode=).
Input parameters
query(string) [required] — A disease label, synonym, or ORPHAcode (ORPHA:166024 or 166024).response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).
search_diseasesFull-text search over Orphanet disease names, synonyms, and definitions (FTS, relevance-ranked). Returns {orpha_code, name, score} plus a pagination block {total, returned, limit, offset, truncated, next_offset}. When truncated, next_commands carries a forward-page step. Obsolete terms are excluded unless include_obsolete=true. Signature: search_diseases(query, limit=, offset=, include_obsolete=, response_mode=).
Full-text search over Orphanet disease names, synonyms, and definitions (FTS, relevance-ranked). Returns {orpha_code, name, score} plus a pagination block {total, returned, limit, offset, truncated, next_offset}. When truncated, next_commands carries a forward-page step. Obsolete terms are excluded unless include_obsolete=true. Signature: search_diseases(query, limit=, offset=, include_obsolete=, response_mode=).
Input parameters
include_obsolete(boolean) — Include obsolete terms (default false).limit(integer) — Max hits (default 25).offset(integer) — Rows to skip for forward paging (default 0).query(string) [required] — A disease label, synonym, or ORPHAcode (ORPHA:166024 or 166024).response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).
get_diseaseReturn an Orphanet disease record: definition, synonyms, grouped cross-references, classification parents/children, age of onset, inheritance, and disorder type. The term accepts an ORPHAcode, a label/synonym, or an external xref CURIE (resolved first). xrefs are grouped by source; any nested count is leaf rows, not groups. Pass fields=['xrefs.OMIM', ...] for a sparse projection, or include=['genes','phenotypes','prevalence','disability'] to compose a full entity in ONE call. Signature: get_disease(term, response_mode=, fields=, include=).
Return an Orphanet disease record: definition, synonyms, grouped cross-references, classification parents/children, age of onset, inheritance, and disorder type. The term accepts an ORPHAcode, a label/synonym, or an external xref CURIE (resolved first). xrefs are grouped by source; any nested count is leaf rows, not groups. Pass fields=['xrefs.OMIM', ...] for a sparse projection, or include=['genes','phenotypes','prevalence','disability'] to compose a full entity in ONE call. Signature: get_disease(term, response_mode=, fields=, include=).
Input parameters
fields(any) — Sparse fieldset: return ONLY these top-level keys (dot into a grouped object, e.g. 'xrefs.OMIM'). Identity anchors (orpha_code, name, orphanet_version) are always included. Omit for the full payload.include(any) — Compose extra association sections into the single record (any of: genes, phenotypes, prevalence, disability) so a full entity needs one call instead of a per-section fan-out. Omit for the base record only.response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
get_disease_genesReturn gene-disease associations for an Orphanet disorder: gene symbol, HGNC id, association type, and cross-references (OMIM, Ensembl, etc.). count is the number of leaf gene rows, not grouped associations. Signature: get_disease_genes(term, response_mode=).
Return gene-disease associations for an Orphanet disorder: gene symbol, HGNC id, association type, and cross-references (OMIM, Ensembl, etc.). count is the number of leaf gene rows, not grouped associations. Signature: get_disease_genes(term, response_mode=).
Input parameters
response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
get_disease_phenotypesReturn HPO phenotype annotations for an Orphanet disorder: HPO id, term name, and frequency category. Optionally filter by frequency label. Frequency values: Obligate (100%), Very frequent (99-80%), Frequent (79-30%), Occasional (29-5%) (and others). Signature: get_disease_phenotypes(term, frequency=, response_mode=).
Return HPO phenotype annotations for an Orphanet disorder: HPO id, term name, and frequency category. Optionally filter by frequency label. Frequency values: Obligate (100%), Very frequent (99-80%), Frequent (79-30%), Occasional (29-5%) (and others). Signature: get_disease_phenotypes(term, frequency=, response_mode=).
Input parameters
frequency(any) — Filter by HPO frequency bucket. A CLOSED vocabulary (see the enum): the label must match exactly, including its percentage range -- 'Frequent' is not 'Frequent (79-30%)'. An unrecognised label is rejected with invalid_input, never silently matched to nothing. Omit to return all.response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
get_disease_prevalenceReturn prevalence data for an Orphanet disorder: prevalence class, geographic area, and source reference. Signature: get_disease_prevalence(term, response_mode=).
Return prevalence data for an Orphanet disorder: prevalence class, geographic area, and source reference. Signature: get_disease_prevalence(term, response_mode=).
Input parameters
response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
get_disease_natural_historyReturn natural history data for an Orphanet disorder: age of onset categories and inheritance patterns. Signature: get_disease_natural_history(term, response_mode=).
Return natural history data for an Orphanet disorder: age of onset categories and inheritance patterns. Signature: get_disease_natural_history(term, response_mode=).
Input parameters
response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
get_disease_disabilityReturn functional consequence (disability) data for an Orphanet disorder: ability categories affected and severity grades. Data coverage is partial: many disorders carry no Orphadata functional-consequence annotation, so a valid result can be empty -- coverage:'none' with count:0 marks this explicitly (it is NOT an error); coverage:'present' means rows exist. Signature: get_disease_disability(term, response_mode=).
Return functional consequence (disability) data for an Orphanet disorder: ability categories affected and severity grades. Data coverage is partial: many disorders carry no Orphadata functional-consequence annotation, so a valid result can be empty -- coverage:'none' with count:0 marks this explicitly (it is NOT an error); coverage:'present' means rows exist. Signature: get_disease_disability(term, response_mode=).
Input parameters
response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
find_diseases_by_geneFind all Orphanet disorders associated with an HGNC gene symbol. Returns {orpha_code, name} per disorder with pagination. Signature: find_diseases_by_gene(gene_symbol, limit=, offset=, response_mode=).
Find all Orphanet disorders associated with an HGNC gene symbol. Returns {orpha_code, name} per disorder with pagination. Signature: find_diseases_by_gene(gene_symbol, limit=, offset=, response_mode=).
Input parameters
gene_symbol(string) [required] — HGNC gene symbol, e.g. 'KIF7' or 'HNF1B'.limit(integer) — Max rows returned (default 50).offset(integer) — Rows to skip for forward paging (default 0).response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).
find_diseases_by_phenotypeFind all Orphanet disorders annotated with an HPO term id. Returns {orpha_code, name} per disorder with pagination. Signature: find_diseases_by_phenotype(hpo_id, limit=, offset=, response_mode=).
Find all Orphanet disorders annotated with an HPO term id. Returns {orpha_code, name} per disorder with pagination. Signature: find_diseases_by_phenotype(hpo_id, limit=, offset=, response_mode=).
Input parameters
hpo_id(string) [required] — HPO term id, e.g. 'HP:0000256'.limit(integer) — Max rows returned (default 50).offset(integer) — Rows to skip for forward paging (default 0).response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).
get_disease_classificationReturn the immediate Orphanet classification parents and children for a disorder. Use get_disease_ancestors / get_disease_descendants for the transitive closure. Signature: get_disease_classification(term, response_mode=).
Return the immediate Orphanet classification parents and children for a disorder. Use get_disease_ancestors / get_disease_descendants for the transitive closure. Signature: get_disease_classification(term, response_mode=).
Input parameters
response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
get_disease_ancestorsReturn all transitive ancestors (broader diseases) of an Orphanet disorder via the precomputed closure, with a pagination block {total, returned, limit, offset, truncated, next_offset}. When truncated, next_commands carries a forward-page step. Use get_disease_classification for only the immediate parents. Signature: get_disease_ancestors(term, limit=, offset=, response_mode=).
Return all transitive ancestors (broader diseases) of an Orphanet disorder via the precomputed closure, with a pagination block {total, returned, limit, offset, truncated, next_offset}. When truncated, next_commands carries a forward-page step. Use get_disease_classification for only the immediate parents. Signature: get_disease_ancestors(term, limit=, offset=, response_mode=).
Input parameters
limit(integer) — Max rows returned (default 200).offset(integer) — Rows to skip for forward paging (default 0).response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
get_disease_descendantsReturn all transitive descendants (more specific diseases) of an Orphanet disorder via the precomputed closure, with a pagination block {total, returned, limit, offset, truncated, next_offset}. When truncated, next_commands carries a forward-page step. Use get_disease_classification for only the immediate children. Signature: get_disease_descendants(term, limit=, offset=, response_mode=).
Return all transitive descendants (more specific diseases) of an Orphanet disorder via the precomputed closure, with a pagination block {total, returned, limit, offset, truncated, next_offset}. When truncated, next_commands carries a forward-page step. Use get_disease_classification for only the immediate children. Signature: get_disease_descendants(term, limit=, offset=, response_mode=).
Input parameters
limit(integer) — Max rows returned (default 200).offset(integer) — Rows to skip for forward paging (default 0).response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode, label, or xref CURIE for a grouping/category term (a specific disease is a leaf and has no descendants).
resolve_xrefResolve an external cross-reference CURIE (OMIM/MONDO/ICD-10/ICD-11/UMLS/GARD/MeSH/MedDRA) back to the Orphanet disorder(s) that map to it. Returns matches[] plus a pagination block {total, returned, limit, offset, truncated, next_offset}; when truncated, next_commands carries a forward-page step. Miss semantics (list-shaped, unlike resolve_disease): a malformed CURIE is rejected with invalid_input, while a well-formed but unmapped CURIE returns an empty page (total: 0), not not_found. Signature: resolve_xref(xref_id, limit=, offset=, response_mode=).
Resolve an external cross-reference CURIE (OMIM/MONDO/ICD-10/ICD-11/UMLS/GARD/MeSH/MedDRA) back to the Orphanet disorder(s) that map to it. Returns matches[] plus a pagination block {total, returned, limit, offset, truncated, next_offset}; when truncated, next_commands carries a forward-page step. Miss semantics (list-shaped, unlike resolve_disease): a malformed CURIE is rejected with invalid_input, while a well-formed but unmapped CURIE returns an empty page (total: 0), not not_found. Signature: resolve_xref(xref_id, limit=, offset=, response_mode=).
Input parameters
limit(integer) — Max matches (default 50).offset(integer) — Rows to skip for forward paging (default 0).response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).xref_id(string) [required] — An external cross-reference CURIE (prefix:local), e.g. OMIM/MONDO/ICD-10, to resolve back to the Orphanet term(s) that map to it.
map_cross_ontologyList an Orphanet disorder's cross-references to other ontologies, grouped by source (OMIM/MONDO/ICD-10/ICD-11/UMLS/GARD/MeSH/MedDRA), each with its mapping relation. Returns them under `mappings` (get_disease returns the same data under `xrefs`). Use prefixes=['OMIM'] to restrict to a subset of sources. count is the number of leaf mapping rows (individual targets), not the number of source groups. Signature: map_cross_ontology(term, prefixes=, response_mode=).
List an Orphanet disorder's cross-references to other ontologies, grouped by source (OMIM/MONDO/ICD-10/ICD-11/UMLS/GARD/MeSH/MedDRA), each with its mapping relation. Returns them under `mappings` (get_disease returns the same data under `xrefs`). Use prefixes=['OMIM'] to restrict to a subset of sources. count is the number of leaf mapping rows (individual targets), not the number of source groups. Signature: map_cross_ontology(term, prefixes=, response_mode=).
Input parameters
prefixes(any) — Restrict the cross-reference sources returned to this subset (any of the xref sources: OMIM/MONDO/ICD-10/ICD-11/UMLS/GARD/MeSH/MedDRA). Omit to return every source.response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).term(string) [required] — An ORPHAcode (ORPHA:33069 or 33069), a disease label/synonym, or an external xref CURIE that resolves to a single Orphanet term.
resolve_disease_batchResolve many labels/ORPHAcodes/xrefs in one call (partial success: each item returns its resolution {orpha_code, name, match_type} or its own ok=false/error_code/message; the call never fails wholesale). Max 50 items; compact per item. Signature: resolve_disease_batch(queries, response_mode=).
Resolve many labels/ORPHAcodes/xrefs in one call (partial success: each item returns its resolution {orpha_code, name, match_type} or its own ok=false/error_code/message; the call never fails wholesale). Max 50 items; compact per item. Signature: resolve_disease_batch(queries, response_mode=).
Input parameters
queries(array) [required] — A LIST of 1..50 disease labels, ORPHAcodes or xref CURIEs to resolve — one entry per item, not a comma-joined string.response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).
get_disease_batchFetch many disease records in one call (partial success per item: each row is the record or its own ok=false/error_code/message). Each term accepts an ORPHAcode, label, or xref CURIE; pass fields=[...] for a sparse projection. Max 50 items; compact per item. Signature: get_disease_batch(terms, response_mode=, fields=).
Fetch many disease records in one call (partial success per item: each row is the record or its own ok=false/error_code/message). Each term accepts an ORPHAcode, label, or xref CURIE; pass fields=[...] for a sparse projection. Max 50 items; compact per item. Signature: get_disease_batch(terms, response_mode=, fields=).
Input parameters
fields(any) — Sparse fieldset: return ONLY these top-level keys (dot into a grouped object, e.g. 'xrefs.OMIM'). Identity anchors (orpha_code, name, orphanet_version) are always included. Omit for the full payload.response_mode(string) — Verbosity: minimal|compact|standard|full (default compact).terms(array) [required] — A LIST of 1..50 ORPHAcodes, disease labels or xref CURIEs to fetch — one entry per item, not a comma-joined string.
Database & release provenance
- Data mode
external-reference- Attestation
- attested-reference
- Data release tag
data-1.3.42-4.1.8-2025-03-03-r20260623T075350Z-r2- Release version
v0.4.7
sha256:cc32164c7f64bfb053fabdb2c739ff0236cc039000d3827e7c64160d70dec62fghcr.io/berntpopp/orphanet-link@sha256:f812b7db0ef824beb2691b9f83466d84e3115265ad714f3b1f55288f770d277aReview the response
Keep the source record link and submitted identifiers with your notes. Record the dataset version and retrieval date when available. This page does not contain a captured Orphadata response.