Skip to content

Latest commit

Β 

History

History
75 lines (52 loc) Β· 2.95 KB

docs.md

File metadata and controls

75 lines (52 loc) Β· 2.95 KB

Classes

ClinicalTrial

Clinical trials

Typedefs

SearchProps : object

ClinicalTrial

Clinical trials

Kind: global class

ClinicalTrial.search(props) β‡’ object

Search for clinical trials using search criteria

Kind: static method of ClinicalTrial

Param Type
props SearchProps

ClinicalTrial.searchConditions(search_query) β‡’ array

Search the conditions and diseases list

Kind: static method of ClinicalTrial

Param Type Description
search_query string Search query. E.g. "Cancer"

ClinicalTrial.getDetails(id) β‡’ object

Get details for a specific trial from a ClinicalTrials.gov Identifier

Kind: static method of ClinicalTrial

Param Type Description
id string ClinicalTrials.gov Identifier

SearchProps : object

Kind: global typedef

Param Type Description
status string Specify whether you want to search for studies that are recruiting participants or in other stages.
condition string Specify the disease, disorder, syndrome, illness, or injury that is being studied. On ClinicalTrials.gov, conditions may also include other health-related issues such as lifespan, quality of life, and health risks.
terms string Specify words or phrases related to the studies you want to find. This performs a general search of the study information, including the title, brief description, conditions, interventions, and locations. Also use this field to find studies by NCT number.
country string Studies are often conducted in many locations around the world. Use this field to select up to three locations to search for studies. For the United States, you can narrow your search by selecting a state.
gender string Search by the sex of persons who may participate in a study.
healthy bool Limit your search to studies which accept healthy participants (people who do not have the condition or related conditions or symptoms being studies).
count number Number of results to return. Default is 25.