Medlineplus Tools#

Configuration File: medlineplus_tools.json Tool Type: Local Tools Count: 5

This page contains all tools defined in the medlineplus_tools.json configuration file.

Available Tools#

MedlinePlus_connect_lookup_by_code (Type: MedlinePlusRESTTool)#

Look up corresponding MedlinePlus page information through MedlinePlus Connect Web Service using …

MedlinePlus_connect_lookup_by_code tool specification

Tool Information:

  • Name: MedlinePlus_connect_lookup_by_code

  • Type: MedlinePlusRESTTool

  • Description: Look up corresponding MedlinePlus page information through MedlinePlus Connect Web Service using clinical/drug/test codes (such as ICD-10 CM, RXCUI, LOINC, etc.), supports JSON or XML format return.

Parameters:

  • cs (string) (required) Code system OID, e.g., ICD-10 CM=2.16.840.1.113883.6.90, RXCUI=2.16.840.1.113883.6.88, LOINC=2.16.840.1.113883.6.1, etc.

  • c (string) (required) Specific code value to query, e.g., “E11.9” (ICD-10 CM) or “637188” (RXCUI).

  • dn (string) (optional) Optional, descriptive name (English) corresponding to the code, for drugs can fill in “Chantix 0.5 MG Oral Tablet”, can improve matching accuracy.

  • language (string) (optional) Return information language, “en” for English, “es” for Spanish, default “en”.

  • format (string) (optional) Return format, options “application/json” or “text/xml”, default “application/json”.

Example Usage:

query = {
    "name": "MedlinePlus_connect_lookup_by_code",
    "arguments": {
        "cs": "example_value",
        "c": "example_value"
    }
}
result = tu.run(query)

MedlinePlus_get_genetics_condition_by_name (Type: MedlinePlusRESTTool)#

Get detailed information from MedlinePlus Genetics corresponding to genetic condition name. Retur…

MedlinePlus_get_genetics_condition_by_name tool specification

Tool Information:

  • Name: MedlinePlus_get_genetics_condition_by_name

  • Type: MedlinePlusRESTTool

  • Description: Get detailed information from MedlinePlus Genetics corresponding to genetic condition name. Returns condition description, related genes, inheritance pattern, synonyms, and other details.

Parameters:

  • condition (string) (required) URL slug of genetic condition, e.g., “alzheimer-disease”, must match MedlinePlus page path.

  • format (string) (optional) Format parameter for the endpoint (note: API always returns XML regardless of this parameter).

Example Usage:

query = {
    "name": "MedlinePlus_get_genetics_condition_by_name",
    "arguments": {
        "condition": "example_value"
    }
}
result = tu.run(query)

MedlinePlus_get_genetics_gene_by_name (Type: MedlinePlusRESTTool)#

Get detailed information from MedlinePlus Genetics corresponding to gene name. Returns XML data p…

MedlinePlus_get_genetics_gene_by_name tool specification

Tool Information:

  • Name: MedlinePlus_get_genetics_gene_by_name

  • Type: MedlinePlusRESTTool

  • Description: Get detailed information from MedlinePlus Genetics corresponding to gene name. Returns XML data parsed into a dictionary with gene function, related health conditions, synonyms, and other details.

Parameters:

  • gene (string) (required) URL slug of gene name, e.g., “BRCA1”, must match MedlinePlus page path.

  • format (string) (optional) Format parameter for the endpoint (note: API always returns XML regardless of this parameter).

Example Usage:

query = {
    "name": "MedlinePlus_get_genetics_gene_by_name",
    "arguments": {
        "gene": "example_value"
    }
}
result = tu.run(query)

MedlinePlus_get_genetics_index (Type: MedlinePlusRESTTool)#

Download index file (XML) of all genetics entries in MedlinePlus, get complete list in one call.

MedlinePlus_get_genetics_index tool specification

Tool Information:

  • Name: MedlinePlus_get_genetics_index

  • Type: MedlinePlusRESTTool

  • Description: Download index file (XML) of all genetics entries in MedlinePlus, get complete list in one call.

Parameters:

No parameters required.

Example Usage:

query = {
    "name": "MedlinePlus_get_genetics_index",
    "arguments": {
    }
}
result = tu.run(query)

MedlinePlus_search_topics_by_keyword (Type: MedlinePlusRESTTool)#

Search MedlinePlus health topics by keyword via NLM’s wsearch Web Service. IMPORTANT: although th…

MedlinePlus_search_topics_by_keyword tool specification

Tool Information:

  • Name: MedlinePlus_search_topics_by_keyword

  • Type: MedlinePlusRESTTool

  • Description: Search MedlinePlus health topics by keyword via NLM’s wsearch Web Service. IMPORTANT: although the db parameter accepts seven historical database names, the live service only returns results for healthTopics (English) and healthTopicsSpanish (Spanish); drugs, drugsSpanish, genetics, medicalTests and medicalEncyclopedia are accepted but always answer with zero results. Use MedlinePlus_get_genetics_gene_by_name / MedlinePlus_get_genetics_condition_by_name for genetics, and MedlinePlus_connect_lookup_by_code for drug/test codes.

Parameters:

  • term (string) (required) Search keyword, e.g., “diabetes”, needs to be URL encoded before passing.

  • db (string) (required) Database to search. Only two values are actually served by NLM’s wsearch endpoint: healthTopics (English health topics) and healthTopicsSpanish (Spanish health topics). The remaining values (drugs, drugsSpanish, genetics, medicalTests, medicalEncyclopedia) are still accepted for backward compatibility but the service returns zero results for every query against them; the tool reports that explicitly instead of pretending the term had no match.

  • rettype (string) (optional) Result return format (default: topic). topic returns the full structured health-topic record (title, meta description, aliases, full summary, topic groups). brief returns the condensed search-result fields (title, alternate title, full summary, group names and a match snippet, which is surfaced as meta_desc); it carries no language attribute, so the language is derived from db. all returns the brief fields plus the same structured record as topic, and is parsed identically to topic. All three produce the same output keys.

Example Usage:

query = {
    "name": "MedlinePlus_search_topics_by_keyword",
    "arguments": {
        "term": "example_value",
        "db": "example_value"
    }
}
result = tu.run(query)