--- name: clinical-trials-database-1aec54af542e description: > Query ClinicalTrials.gov via APIv2. Use when you want to search for trials by condition, drug, location, status, or phase; retrieve trial details by NCT ID; check eligibility/inclusion criteria; count trials across conditions or time periods; identify a sponsor's trial portfolio; find recruiting trials for patient matching. --- # Clinical Trials Database ## Prerequisites 1. **`uv`**: Read the `uv` skill and follow its Setup instructions to ensure `uv` is installed and on PATH. 2. **User Notification**: If LICENSE_NOTIFICATION.txt does not already exist in this skill directory then (1) prominently notify the user to check the terms at https://clinicaltrials.gov/, then (2) create the file recording the notification text and timestamp. ## Overview Access worldwide clinical trial data from ClinicalTrials.gov via the REST API v2. The CLI script at `scripts/clinical_trials_api.py` wraps the API with dedicated flags for common filters (phase, age group, status, intervention, sponsor, etc.) so you rarely need to construct raw queries. ## Core Rules - **Use the Wrapper**: ALWAYS execute the provided helper scripts to query the database rather than accessing the database directly. The scripts automatically enforce the required rate limit gracefully. - **Always use `--fields`** — trial JSON records can be very large; restrict to the data points you need. - **Use `--count-total` first** — check result volume before fetching all records. - **Paginate large result sets** — use `--limit` with `--page-token` to iterate. - **Trust Search Filters**: Do not manually re-filter results unless explicitly asked to verify detailed eligibility. - **Notification**: If this skill is used, ensure this is mentioned in the output. ## Context Efficiency Warning Trial JSON records can be very large. **Always** use the `--fields` parameter to restrict the response to only the data points you need. After writing to file, read only the fields you need rather than the entire file. > [!TIP] Use `references/studies_schema.md` to identify exact field paths for > `--fields`. ## Response Layout Summary API responses contain a list of studies (usually in a `studies[]` array). Each study is split into `protocolSection` and optional `resultsSection`. > [!Tip] Use the **shorthand aliases** below with the `--fields` parameter to > request specific data and keep responses small. ### Top-Level Fields - `totalCount` — Total studies matching query (integer) - `studies[]` — Array of study objects - `nextPageToken` — cursor string for pagination ### Common Study Fields (and shorthand alias) - **Identification** - `protocolSection.identificationModule.nctId` (`NCTId`) — Unique trial ID - `protocolSection.identificationModule.briefTitle` (`BriefTitle`) — Short title - **Status** - `protocolSection.statusModule.overallStatus` (`OverallStatus`) — Recruitment status - **Description** - `protocolSection.descriptionModule.briefSummary` (`BriefSummary`) — Short description - **Arms & Interventions** - `protocolSection.armsInterventionsModule.interventions` (`ArmsInterventionsModule`) - **Eligibility** - `protocolSection.eligibilityModule.eligibilityCriteria` (`EligibilityCriteria`) — Inclusion/Exclusion - `protocolSection.eligibilityModule.stdAges` (`StdAge`) — CHILD, ADULT, etc. Consult `references/studies_schema.md` for full paths (Locations, Outcomes, Results) and common `--fields` recipes. ## Commands ### Search for studies Use for: finding trials by disease, drug, phase, status, age group, or any combination of these filters. ```bash uv run scripts/clinical_trials_api.py search \ --condition "" \ --intervention "" \ --status "" \ --phase "" \ --age-group "" \ --study-type "" \ --sponsor "" \ --has-results \ --sort ":" \ --fields "" \ --limit \ --count-total \ --page-token "" \ --output /tmp/search_results.json ``` All flags are optional and combine via AND logic. **Flag reference:** - `--condition` — Disease or condition to search for (e.g. `"cystic fibrosis"`). - `--intervention` — Drug, device, or treatment name (e.g. `"pembrolizumab"`). - `--status` — Recruitment status filter. Values: RECRUITING, COMPLETED, NOT_YET_RECRUITING, ACTIVE_NOT_RECRUITING, ENROLLING_BY_INVITATION, TERMINATED, SUSPENDED, WITHDRAWN. - `--phase` — Trial phase filter. Values: PHASE1, PHASE2, PHASE3, PHASE4, EARLY_PHASE1, NA. - `--age-group` — Patient age group filter. Values: CHILD (0–17), ADULT (18–64), OLDER_ADULT (65+). - `--study-type` — Type of study. Values: INTERVENTIONAL, OBSERVATIONAL, EXPANDED_ACCESS. - `--sponsor` — Lead sponsor or institution name (e.g. `"National Cancer Institute"`). - `--has-results` — Boolean flag (no value needed). When present, filters for studies that have results available on ClinicalTrials.gov. - `--sort` — Sort order as `FieldName:asc` or `FieldName:desc`. Common fields: `LastUpdatePostDate`, `EnrollmentCount`, `StudyFirstPostDate`, `StartDate`. - `--fields` — Comma-separated list of JSON field names to include in the response. Use this to keep responses small (e.g. `"NCTId,BriefTitle,OverallStatus,Phase"`). See `references/studies_schema.md` for available field paths. - `--limit` — Maximum number of studies to return per request (1–1000, default 10). - `--count-total` — Boolean flag (no value needed). When present, the response includes a `totalCount` field showing the total number of matching studies across all pages. - `--page-token` — An opaque cursor string used to fetch the next page of results. Obtain this value from the `nextPageToken` field in a previous search response. Do not construct this string yourself; always copy it verbatim from the API response. See the Pagination section below. - `--advanced` — Raw Essie filter expression for structured queries beyond the dedicated flags (e.g. `"AREA[LocationCountry]United States"`). Combined with other flags via AND. See `references/clinical_trials_api.md` for syntax. - `--output` — **(Required)** File path where the JSON response is written. **Example — actively recruiting Phase 3 pediatric cystic fibrosis trials:** ```bash uv run scripts/clinical_trials_api.py search \ --condition "cystic fibrosis" \ --status RECRUITING \ --phase PHASE3 \ --age-group CHILD \ --fields "NCTId,BriefTitle,OverallStatus,Phase" \ --limit 10 \ --output /tmp/cf_trials.json ``` **Example — recruiting atezolizumab trials for esophageal cancer:** ```bash uv run scripts/clinical_trials_api.py search \ --condition "esophageal cancer" \ --intervention "Atezolizumab" \ --status RECRUITING \ --fields "NCTId,BriefTitle,Phase" \ --limit 10 \ --output /tmp/atezolizumab_trials.json ``` ### Retrieve a study by NCT ID Use for: fetching full details of a specific trial when you already have the NCT identifier. ```bash uv run scripts/clinical_trials_api.py get-study \ [--fields ""] \ --output /tmp/study.json ``` Returns a useful default set of fields if `--fields` is omitted: `NCTId,BriefTitle,OverallStatus,Phase,BriefSummary,` `ConditionsModule,ArmsInterventionsModule,EligibilityModule` **Structure of the default response:** ```json { "protocolSection": { "identificationModule": { "nctId": "NCT00000000", "briefTitle": "Study Title" }, "statusModule": { "overallStatus": "RECRUITING" }, "descriptionModule": { "briefSummary": "This study is about..." }, "conditionsModule": { "conditions": [ "Condition Name" ] }, "armsInterventionsModule": { "interventions": [ { "type": "DRUG", "name": "Drug Name" } ] }, "eligibilityModule": { "eligibilityCriteria": "Inclusion:\n- ...", "stdAges": [ "ADULT" ] } } } ``` ### Get eligibility / inclusion criteria Use for: pulling inclusion/exclusion rules, age ranges, and sex requirements for patient-matching tasks. ```bash uv run scripts/clinical_trials_api.py \ get-eligibility \ --output /tmp/eligibility.json ``` Shortcut that returns title and the full eligibility module (inclusion/exclusion criteria, age range, sex). **Example — inclusion criteria for NCT04886804:** ```bash uv run scripts/clinical_trials_api.py \ get-eligibility NCT04886804 \ --output /tmp/eligibility_NCT04886804.json ``` ### Count matching studies Use for: exploring the trial landscape — checking how many trials exist for a condition, phase, or status before fetching full records. ```bash uv run scripts/clinical_trials_api.py count \ --condition "" \ [--status ""] [--phase ""] ... \ --output /tmp/count.json ``` Returns only the total count of clinical trials matching the search criteria without fetching study records. Accepts the same filter flags as `search`. ### Search by location / geography Use for: narrowing trials to a specific country, state, or city. Use `--advanced` with `AREA[LocationCountry]` or `AREA[LocationCity]` to restrict results by geography: ```bash uv run scripts/clinical_trials_api.py search \ --condition "cystic fibrosis" \ --status RECRUITING \ --advanced "AREA[LocationCity]New York" \ --fields "NCTId,BriefTitle" \ --limit 20 \ --output /tmp/nyc_cf_trials.json ``` ### Search by sponsor / organization Use for: identifying a sponsor's or institution's trial portfolio. Use `--sponsor` to find trials run by a specific institution or company: ```bash uv run scripts/clinical_trials_api.py search \ --sponsor "National Cancer Institute" \ --fields "NCTId,BriefTitle,LeadSponsorName" \ --limit 20 \ --output /tmp/nci_trials.json ``` ### Combined multi-criteria search Use for: complex queries that layer multiple filters (condition and drug and phase and geography and sponsor, etc.). All flags combine via AND, so you can layer conditions, interventions, status, phase, geography, and sponsor in a single query: ```bash uv run scripts/clinical_trials_api.py search \ --condition "pancreatic cancer" \ --intervention "immunotherapy" \ --status RECRUITING \ --phase PHASE3 \ --advanced "AREA[LocationCountry]United States" \ --fields "NCTId,BriefTitle,Phase,LeadSponsorName" \ --limit 20 \ --output /tmp/panc_trials.json ``` ### Raw API query (escape hatch) Use for: uncommon endpoints or parameter combinations not covered by the dedicated flags. ```bash uv run scripts/clinical_trials_api.py raw-query \ --endpoint \ --params '' \ --output /tmp/raw_result.json ``` ## Pagination When results exceed `--limit`, the response includes a `nextPageToken`. Pass it with `--page-token` to fetch the next page: ```bash uv run scripts/clinical_trials_api.py search \ --condition "breast cancer" \ --status RECRUITING \ --limit 50 --count-total \ --output /tmp/breast_cancer_p1.json uv run scripts/clinical_trials_api.py search \ --condition "breast cancer" \ --status RECRUITING \ --limit 50 --page-token "CAo=" \ --output /tmp/breast_cancer_p2.json ``` ## Advanced Querying For complex filtering beyond the dedicated flags, use `--advanced` with an Essie expression. **What is an Essie Expression?** Essie is the search engine powering ClinicalTrials.gov. An Essie expression is a structured query that targets specific fields (e.g., country, phase) rather than doing general keyword searches. - **`AREA[Field]Value`**: Targets a specific field. - `AREA[LocationCountry]United States` - `AREA[Phase]PHASE3` - **Boolean operators**: Combine with `AND`, `OR`, `NOT`. - **`RANGE[min, max]`**: For numeric/date fields (e.g. `RANGE[500, MAX]`). See `references/clinical_trials_api.md` for syntax and available fields. It is combined with other flags via AND: ```bash uv run scripts/clinical_trials_api.py search \ --condition "diabetes" \ --advanced "AREA[LocationCountry]United States \ AND AREA[EnrollmentCount]RANGE[500, MAX]" \ --fields "NCTId,BriefTitle,EnrollmentCount" \ --output /tmp/diabetes_us_large.json ``` ## References - **API parameters, enum values, and Essie syntax:** `references/clinical_trials_api.md` - **JSON field paths and `--fields` recipes:** `references/studies_schema.md` --- Source attribution: mkurman Original project: https://github.com/mkurman/zorai/blob/d06ee7597049567dab92db22d41b2764cf89094a/skills/scientific-skills-gdm/clinical_trials_database/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: mkurman Original project: https://github.com/mkurman/zorai/blob/d06ee7597049567dab92db22d41b2764cf89094a/skills/scientific-skills-gdm/clinical_trials_database/SKILL.md Attribution basis: Source repository record Fields of work: Data & Analytics, Healthcare & Life Sciences Roles: Clinical Research, Data Analyst, Health Informatics Specialties: API Tools: Clinicaltrials.Gov Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 04d062233cf14700347ce91385cf0bcc18d6148159770a7bc2b912c095a5456d