From 081d93110fe7d2009da1ce68c6a767916f354ab9 Mon Sep 17 00:00:00 2001 From: Paul Schmiedmayer Date: Mon, 6 May 2024 00:36:53 -0700 Subject: [PATCH] Load up to 50 Trials and Display Trials in List View (#19) # Load up to 50 Trials and Display Trials in List View ## :gear: Release Notes - Further improves loading NCI trials, improves OpenAPI specification - Displays the Trials in a List view ![RocketSim_Screenshot_iPhone_15_Pro_6 1_2024-05-06_00 34 11](https://github.com/StanfordBDHG/OwnYourData/assets/28656495/ff0d006d-ff45-4d80-bfc8-6ea13c9e2384) ![RocketSim_Screenshot_iPhone_15_Pro_6 1_2024-05-06_00 34 36](https://github.com/StanfordBDHG/OwnYourData/assets/28656495/1f9374cf-858e-4f09-b0ea-d6cb6c66ea76) ![RocketSim_Screenshot_iPhone_15_Pro_6 1_2024-05-06_00 34 27](https://github.com/StanfordBDHG/OwnYourData/assets/28656495/f7a7c7e2-b565-4529-833f-87eb30328eda) ### Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md). --- NCIClinicalTrialsSearchAPI.json | 6746 +++++++++-------- .../.openapi-generator/FILES | 6 + .../OpenAPIs/Models/AssociatedStudy.swift | 36 + .../Classes/OpenAPIs/Models/Biomarker.swift | 68 + .../Classes/OpenAPIs/Models/Disease.swift | 6 +- .../OpenAPIs/Models/PriorTherapy.swift | 56 + .../Classes/OpenAPIs/Models/TrialDetail.swift | 8 +- NCIClinicalTrialsSearchAPI/README.md | 3 + .../docs/AssociatedStudy.md | 11 + NCIClinicalTrialsSearchAPI/docs/Biomarker.md | 19 + NCIClinicalTrialsSearchAPI/docs/Disease.md | 1 - .../docs/PriorTherapy.md | 16 + .../docs/TrialDetail.md | 6 +- OwnYourData.xcodeproj/project.pbxproj | 4 + .../ClinicalTrials/ClinicalTrialsView.swift | 70 +- .../TrialDetail+Identifiable.swift | 16 + OwnYourData/Resources/Localizable.xcstrings | 3 + 17 files changed, 3757 insertions(+), 3318 deletions(-) create mode 100644 NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/AssociatedStudy.swift create mode 100644 NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/Biomarker.swift create mode 100644 NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/PriorTherapy.swift create mode 100644 NCIClinicalTrialsSearchAPI/docs/AssociatedStudy.md create mode 100644 NCIClinicalTrialsSearchAPI/docs/Biomarker.md create mode 100644 NCIClinicalTrialsSearchAPI/docs/PriorTherapy.md create mode 100644 OwnYourData/ClinicalTrials/TrialDetail+Identifiable.swift diff --git a/NCIClinicalTrialsSearchAPI.json b/NCIClinicalTrialsSearchAPI.json index 788b928..3471032 100644 --- a/NCIClinicalTrialsSearchAPI.json +++ b/NCIClinicalTrialsSearchAPI.json @@ -1,934 +1,1160 @@ { - "openapi":"3.0.0", - "info":{ - "version":"2.1.0", - "title":"NCI Clinical Trials Search API", - "description":"

For information on NCI's efforts to improve how patients and oncologists find information and learn about cancer clinical trials please visit:
https://www.cancer.gov/syndication/api

Fetching Daily Updates

Updates to the API are made daily (the refresh occurs each morning by 7:30 AM ET). The API does not do a diff to track changes, and there is no one field in the underlying database (that the API taps into) which captures when a trial has been modified. The best field to use to see which trials have possibly been changed in the past 24 hours is the record_verification_date field. This field is updated whenever a human auditor verifies a clinical trial record. It is important to note that verification does not necessarily imply that a change was made to the clinical trial record, simply that an auditor took another look at it - but this is inclusive of any instances where the auditor made modifications to the trial.

As an example, to see which clinical trials have been verified by an auditor since 2016-08-25...

Example: trials?record_verification_date_gte=2016-08-25

Authorization

To use API, an API key is required. Request API key

Issues

Please ask questions or report issues to ctrp_support@mail.nih.gov.

", - "termsOfService":"https://www.cancer.gov/syndication/api", - "license":{ - "name":"", - "url":"" + "openapi": "3.0.0", + "info": { + "version": "2.1.0", + "title": "NCI Clinical Trials Search API", + "description": "

For information on NCI's efforts to improve how patients and oncologists find information and learn about cancer clinical trials please visit:
https://www.cancer.gov/syndication/api

Fetching Daily Updates

Updates to the API are made daily (the refresh occurs each morning by 7:30 AM ET). The API does not do a diff to track changes, and there is no one field in the underlying database (that the API taps into) which captures when a trial has been modified. The best field to use to see which trials have possibly been changed in the past 24 hours is the record_verification_date field. This field is updated whenever a human auditor verifies a clinical trial record. It is important to note that verification does not necessarily imply that a change was made to the clinical trial record, simply that an auditor took another look at it - but this is inclusive of any instances where the auditor made modifications to the trial.

As an example, to see which clinical trials have been verified by an auditor since 2016-08-25...

Example: trials?record_verification_date_gte=2016-08-25

Authorization

To use API, an API key is required. Request API key

Issues

Please ask questions or report issues to ctrp_support@mail.nih.gov.

", + "termsOfService": "https://www.cancer.gov/syndication/api", + "license": { + "name": "", + "url": "" } }, - "x-amazon-apigateway-integration-cors-headers":{ - "method.response.header.Access-Control-Allow-Methods":"'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'", - "method.response.header.Access-Control-Allow-Headers":"'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'", - "method.response.header.Access-Control-Allow-Origin":"'*'" + "x-amazon-apigateway-integration-cors-headers": { + "method.response.header.Access-Control-Allow-Methods": "'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'", + "method.response.header.Access-Control-Allow-Headers": "'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'", + "method.response.header.Access-Control-Allow-Origin": "'*'" }, - "tags":[ + "tags": [ { - "name":"Trials", - "description":"" + "name": "Trials", + "description": "" }, { - "name":"Organizations", - "description":"" + "name": "Organizations", + "description": "" }, { - "name":"Interventions", - "description":"" + "name": "Interventions", + "description": "" }, { - "name":"Diseases", - "description":"" + "name": "Diseases", + "description": "" }, { - "name":"Biomarkers", - "description":"" + "name": "Biomarkers", + "description": "" } ], - "components":{ - "securitySchemes":{ - "ApiKeyAuth":{ - "type":"apiKey", - "in":"header", - "name":"X-API-KEY" + "components": { + "securitySchemes": { + "ApiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "X-API-KEY" } }, - "schemas":{ - "integer_1_to_999":{ - "type":"integer", - "minimum":1, - "maximum":999 + "schemas": { + "integer_1_to_999": { + "type": "integer", + "minimum": 1, + "maximum": 999 }, "TrialResponse": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TrialDetail" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TrialDetail" + } } - } - } + } }, "TrialDetail": { - "type": "object", - "properties": { - "other_ids": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Identifier" - } - }, - "amendment_date": { - "type": "string", - "format": "date" - }, - "keywords": { - "type": ["string", "null"] - }, - "dcp_id": { - "type": ["string", "null"] - }, - "interventional_model": { - "type": "string" - }, - "lead_org": { - "type": "string" - }, - "eligibility": { - "$ref": "#/components/schemas/Eligibility" - }, - "sites": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Site" - } - }, - "completion_date_type_code": { - "type": "string" - }, - "detail_description": { - "type": "string" - }, - "official_title": { - "type": "string" - }, - "_phase_sort_order": { - "type": "integer" - }, - "collaborators": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Collaborators" - } - }, - "associated_studies": { - "type": "array", - "items": { - "type": "string" - } - }, - "outcome_measures": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OutcomeMeasure" - } - }, - "phase": { - "type": "string" - }, - "central_contact": { - "$ref": "#/components/schemas/CentralContact" - }, - "primary_purpose": { - "type": "string" - }, - "number_of_arms": { - "type": "integer" - }, - "_study_protocol_type_sort_order": { - "type": "integer" - }, - "nct_id": { - "type": "string" - }, - "biomarkers": { - "type": "array", - "items": { - "type": "string" - } - }, - "classification_code": { - "type": ["string", "null"] - }, - "current_trial_status_date": { - "type": "string", - "format": "date" - }, - "diseases": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Disease" - } - }, - "_primary_purpose_sort_order": { - "type": "integer" - }, - "protocol_id": { - "type": "string" - }, - "active_sites_count": { - "type": "integer" - }, - "lead_org_cancer_center": { - "type": ["string", "null"] - }, - "arms": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Arm" - } - }, - "study_model_code": { - "type": ["string", "null"] - }, - "nci_id": { - "type": "string" - }, - "why_study_stopped": { - "type": ["string", "null"] - }, - "brief_summary": { - "type": "string" - }, - "brief_title": { - "type": "string" - }, - "status_history": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusHistory" + "type": "object", + "properties": { + "other_ids": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Identifier" + } + }, + "amendment_date": { + "type": "string", + "format": "date" + }, + "keywords": { + "type": [ + "string", + "null" + ] + }, + "dcp_id": { + "type": [ + "string", + "null" + ] + }, + "interventional_model": { + "type": "string" + }, + "lead_org": { + "type": "string" + }, + "eligibility": { + "$ref": "#/components/schemas/Eligibility" + }, + "sites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Site" + } + }, + "completion_date_type_code": { + "type": "string" + }, + "detail_description": { + "type": "string" + }, + "official_title": { + "type": "string" + }, + "_phase_sort_order": { + "type": "integer" + }, + "collaborators": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Collaborators" + } + }, + "associated_studies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssociatedStudy" + } + }, + "outcome_measures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OutcomeMeasure" + } + }, + "phase": { + "type": "string" + }, + "central_contact": { + "$ref": "#/components/schemas/CentralContact" + }, + "primary_purpose": { + "type": "string" + }, + "number_of_arms": { + "type": "integer" + }, + "_study_protocol_type_sort_order": { + "type": "integer" + }, + "nct_id": { + "type": "string" + }, + "biomarkers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Biomarker" + } + }, + "classification_code": { + "type": [ + "string", + "null" + ] + }, + "current_trial_status_date": { + "type": "string", + "format": "date" + }, + "diseases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Disease" + } + }, + "_primary_purpose_sort_order": { + "type": "integer" + }, + "protocol_id": { + "type": "string" + }, + "active_sites_count": { + "type": "integer" + }, + "lead_org_cancer_center": { + "type": [ + "string", + "null" + ] + }, + "arms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Arm" + } + }, + "study_model_code": { + "type": [ + "string", + "null" + ] + }, + "nci_id": { + "type": "string" + }, + "why_study_stopped": { + "type": [ + "string", + "null" + ] + }, + "brief_summary": { + "type": "string" + }, + "brief_title": { + "type": "string" + }, + "status_history": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusHistory" + } + }, + "study_population_description": { + "type": [ + "string", + "null" + ] + }, + "sampling_method_code": { + "type": [ + "string", + "null" + ] + }, + "minimum_target_accrual_number": { + "type": "integer" + }, + "prior_therapy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PriorTherapy" + } + }, + "_current_trial_status_sort_order": { + "type": "integer" + }, + "start_date": { + "type": "string", + "format": "date" + }, + "record_verification_date": { + "type": "string", + "format": "date" + }, + "ctep_id": { + "type": "string" + }, + "current_trial_status": { + "type": "string" + }, + "study_model_other_text": { + "type": [ + "string", + "null" + ] + }, + "masking": { + "$ref": "#/components/schemas/Masking" + }, + "acronym": { + "type": [ + "string", + "null" + ] + }, + "nci_programs": { + "type": "array", + "items": { + "type": "string" + } + }, + "nci_funded": { + "type": "string" + }, + "anatomic_sites": { + "type": "array", + "items": { + "type": "string" + } + }, + "ccr_id": { + "type": [ + "string", + "null" + ] + }, + "start_date_type_code": { + "type": "string" + }, + "principal_investigator": { + "type": "string" + }, + "study_source": { + "type": "string" + }, + "completion_date": { + "type": "string", + "format": "date" + }, + "study_subtype_code": { + "type": [ + "string", + "null" + ] + }, + "study_protocol_type": { + "type": "string" } - }, - "study_population_description": { - "type": ["string", "null"] - }, - "sampling_method_code": { - "type": ["string", "null"] - }, - "minimum_target_accrual_number": { - "type": "integer" - }, - "prior_therapy": { - "type": "array", - "items": { - "type": "string" + } + }, + "Identifier": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" } - }, - "_current_trial_status_sort_order": { - "type": "integer" - }, - "start_date": { - "type": "string", - "format": "date" - }, - "record_verification_date": { - "type": "string", - "format": "date" - }, - "ctep_id": { - "type": "string" - }, - "current_trial_status": { - "type": "string" - }, - "study_model_other_text": { - "type": ["string", "null"] - }, - "masking": { - "$ref": "#/components/schemas/Masking" - }, - "acronym": { - "type": ["string", "null"] - }, - "nci_programs": { - "type": "array", - "items": { - "type": "string" + } + }, + "PriorTherapy": { + "type": "object", + "properties": { + "eligibility_criterion": { + "type": "string", + "example": "exclusion" + }, + "inclusion_indicator": { + "type": "string", + "example": "TRIAL" + }, + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Anaplastic Lymphoma Kinase Inhibitor" + ] + }, + "nci_thesaurus_concept_id": { + "type": "string", + "example": "C141136" + }, + "name": { + "type": "string", + "example": "ALK Inhibitor" + }, + "ancestor_ids": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "C1404", + "C163758", + "C1908", + "C1909", + "C1967", + "C274", + "C471" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "C163758", + "C1967" + ] } - }, - "nci_funded": { - "type": "string" - }, - "anatomic_sites": { - "type": "array", - "items": { - "type": "string" + } + }, + "AssociatedStudy": { + "type": "object", + "properties": { + "study_id_type": { + "type": "string" + }, + "study_id": { + "type": "string" } - }, - "ccr_id": { - "type": ["string", "null"] - }, - "start_date_type_code": { - "type": "string" - }, - "principal_investigator": { - "type": "string" - }, - "study_source": { - "type": "string" - }, - "completion_date": { - "type": "string", - "format": "date" - }, - "study_subtype_code": { - "type": ["string", "null"] - }, - "study_protocol_type": { - "type": "string" - } - } + } }, - "Identifier": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - } + "Biomarker": { + "type": "object", + "properties": { + "eligibility_criterion": { + "type": "string", + "example": "inclusion" + }, + "inclusion_indicator": { + "type": "string", + "example": "TREE" + }, + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Chromosomal Rearrangements", + "Rearrangement", + "Rearrangement NOS", + "Structural Chromosomal Abnormality", + "Structural Chromosome Aberration", + "Structural Chromosome Anomalies" + ] + }, + "nci_thesaurus_concept_id": { + "type": "string", + "example": "C36541" + }, + "name": { + "type": "string", + "example": "Chromosomal Rearrangement" + }, + "semantic_types": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Cell or Molecular Dysfunction" + ] + }, + "type": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "branch" + ] + }, + "ancestors": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "C2950", + "C3910" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "C2950" + ] + }, + "assay_purpose": { + "type": "string", + "example": "Eligibility Criterion - Inclusion" + } + } }, "Site": { - "type": "object", - "properties": { - "org_state_or_province": { - "type": "string" - }, - "contact_name": { - "type": "string" - }, - "contact_phone": { - "type": "string" - }, - "recruitment_status_date": { - "type": "string", - "format": "date" - }, - "org_address_line_2": { - "type": ["string", "null"] - }, - "org_va": { - "type": "boolean" - }, - "org_address_line_1": { - "type": "string" - }, - "org_tty": { - "type": ["string", "null"] - }, - "org_family": { - "type": ["string", "null"] - }, - "org_postal_code": { - "type": "string" - }, - "contact_email": { - "type": "string" - }, - "recruitment_status": { - "type": "string" - }, - "org_city": { - "type": "string" - }, - "org_email": { - "type": ["string", "null"] - }, - "org_country": { - "type": "string" - }, - "org_fax": { - "type": "string" - }, - "org_phone": { - "type": "string" - }, - "org_name": { - "type": "string" - }, - "org_coordinates": { - "$ref": "#/components/schemas/Coordinates" - } - } + "type": "object", + "properties": { + "org_state_or_province": { + "type": "string" + }, + "contact_name": { + "type": "string" + }, + "contact_phone": { + "type": "string" + }, + "recruitment_status_date": { + "type": "string", + "format": "date" + }, + "org_address_line_2": { + "type": [ + "string", + "null" + ] + }, + "org_va": { + "type": "boolean" + }, + "org_address_line_1": { + "type": "string" + }, + "org_tty": { + "type": [ + "string", + "null" + ] + }, + "org_family": { + "type": [ + "string", + "null" + ] + }, + "org_postal_code": { + "type": "string" + }, + "contact_email": { + "type": "string" + }, + "recruitment_status": { + "type": "string" + }, + "org_city": { + "type": "string" + }, + "org_email": { + "type": [ + "string", + "null" + ] + }, + "org_country": { + "type": "string" + }, + "org_fax": { + "type": "string" + }, + "org_phone": { + "type": "string" + }, + "org_name": { + "type": "string" + }, + "org_coordinates": { + "$ref": "#/components/schemas/Coordinates" + } + } }, "Coordinates": { - "type": "object", - "properties": { - "lon": { - "type": "number" - }, - "lat": { - "type": "number" - } - } + "type": "object", + "properties": { + "lon": { + "type": "number" + }, + "lat": { + "type": "number" + } + } }, "Collaborators": { "type": "object", "properties": { - "name": { - "type": "string", - "example": "National Cancer Institute" - }, - "functional_role": { - "type": "string", - "example": "FUNDING_SOURCE" - } + "name": { + "type": "string", + "example": "National Cancer Institute" + }, + "functional_role": { + "type": "string", + "example": "FUNDING_SOURCE" + } } }, "Eligibility": { - "type": "object", - "properties": { - "unstructured": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UnstructuredEligibility" + "type": "object", + "properties": { + "unstructured": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UnstructuredEligibility" + } + }, + "structured": { + "$ref": "#/components/schemas/StructuredEligibility" } - }, - "structured": { - "$ref": "#/components/schemas/StructuredEligibility" - } - } + } }, "UnstructuredEligibility": { - "type": "object", - "properties": { - "inclusion_indicator": { - "type": "boolean" - }, - "display_order": { - "type": "integer" - }, - "description": { - "type": "string" - } - } + "type": "object", + "properties": { + "inclusion_indicator": { + "type": "boolean" + }, + "display_order": { + "type": "integer" + }, + "description": { + "type": "string" + } + } }, "StructuredEligibility": { - "type": "object", - "properties": { - "max_age": { - "type": "string" - }, - "max_age_number": { - "type": "integer" - }, - "min_age_unit": { - "type": "string" - }, - "max_age_unit": { - "type": "string" - }, - "max_age_in_years": { - "type": "integer" - }, - "gender": { - "type": "string" - }, - "accepts_healthy_volunteers": { - "type": "boolean" - }, - "min_age": { - "type": "string" - }, - "min_age_number": { - "type": "integer" - }, - "min_age_in_years": { - "type": "integer" - } - } + "type": "object", + "properties": { + "max_age": { + "type": "string" + }, + "max_age_number": { + "type": "integer" + }, + "min_age_unit": { + "type": "string" + }, + "max_age_unit": { + "type": "string" + }, + "max_age_in_years": { + "type": "integer" + }, + "gender": { + "type": "string" + }, + "accepts_healthy_volunteers": { + "type": "boolean" + }, + "min_age": { + "type": "string" + }, + "min_age_number": { + "type": "integer" + }, + "min_age_in_years": { + "type": "integer" + } + } }, "OutcomeMeasure": { - "type": "object", - "properties": { - "timeframe": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "type_code": { - "type": "string" - } - } + "type": "object", + "properties": { + "timeframe": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type_code": { + "type": "string" + } + } }, "CentralContact": { - "type": "object", - "properties": { - "phone": { - "type": ["string", "null"] - }, - "name": { - "type": ["string", "null"] - }, - "type": { - "type": ["string", "null"] - }, - "email": { - "type": ["string", "null"] - } - } + "type": "object", + "properties": { + "phone": { + "type": [ + "string", + "null" + ] + }, + "name": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + } + } }, "Arm": { - "type": "object", - "properties": { - "interventions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Intervention" + "type": "object", + "properties": { + "interventions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Intervention" + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" } - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "type": { - "type": "string" - } - } + } }, "Intervention": { - "type": "object", - "properties": { - "inclusion_indicator": { - "type": "string" - }, - "synonyms": { - "type": "array", - "items": { - "type": "string" - } - }, - "nci_thesaurus_concept_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": ["string", "null"] - }, - "type": { - "type": "string" - }, - "category": { - "type": "string" - }, - "parents": { - "type": "array", - "items": { - "type": "string" + "type": "object", + "properties": { + "inclusion_indicator": { + "type": "string" + }, + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Anomaly" + ] + }, + "nci_thesaurus_concept_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "type": { + "type": "string" + }, + "category": { + "type": "string" + }, + "parents": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "C20103" + ] } - } - } + } }, "Disease": { - "type": "object", - "properties": { - "inclusion_indicator": { - "type": "string" - }, - "is_lead_disease": { - "type": "boolean" - }, - "synonyms": { - "type": "array", - "items": { - "type": "string" - } - }, - "nci_thesaurus_concept_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "array", - "items": { - "type": "string" - } - }, - "parents": { - "type": "array", - "items": { - "type": "string" + "type": "object", + "properties": { + "inclusion_indicator": { + "type": "string" + }, + "is_lead_disease": { + "type": "boolean" + }, + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Anomaly" + ] + }, + "nci_thesaurus_concept_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "parents": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "C20103" + ] } - } - } + } }, "StatusHistory": { - "type": "object", - "properties": { - "status_date": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string" - } - } + "type": "object", + "properties": { + "status_date": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string" + } + } }, "Masking": { - "type": "object", - "properties": { - "role_caregiver": { - "type": ["string", "null"] - }, - "masking": { - "type": ["string", "null"] - }, - "role_investigator": { - "type": ["string", "null"] - }, - "role_outcome_assessor": { - "type": ["string", "null"] - }, - "role_subject": { - "type": ["string", "null"] - }, - "allocation_code": { - "type": "string" - } - } + "type": "object", + "properties": { + "role_caregiver": { + "type": [ + "string", + "null" + ] + }, + "masking": { + "type": [ + "string", + "null" + ] + }, + "role_investigator": { + "type": [ + "string", + "null" + ] + }, + "role_outcome_assessor": { + "type": [ + "string", + "null" + ] + }, + "role_subject": { + "type": [ + "string", + "null" + ] + }, + "allocation_code": { + "type": "string" + } + } } }, - "parameters":{ - "id":{ - "in":"query", - "name":"id", - "description":"Search by ID.", - "required":false, - "schema":{ - "type":"string" + "parameters": { + "id": { + "in": "query", + "name": "id", + "description": "Search by ID.", + "required": false, + "schema": { + "type": "string" } }, - "trial_status":{ - "in":"query", - "name":"trial_status", - "description":"Possible value: OPEN \n(Equivalent to:
current_trial_status=active&current_trial_status=approved
&current_trial_status=enrolling by invitation
&current_trial_status=in review
&current_trial_status=temporarily closed to accrual
&current_trial_status=temporarily closed to accrual and intervention
&sites.recruitment_status=active&sites.recruitment_status=approved
&sites.recruitment_status=enrolling_by_invitation
&sites.recruitment_status=in_review
&sites.recruitment_status=temporarily_closed_to_accrual
&record_verification_date_gte=<date reflecting 2 years ago> )\n

In other words, for a trial to be considered "OPEN", current_trial_status must be one of:

and sites.recruitment_status must be one of:

and record_verification_date must be a date within the past two years

Currently does not work in combination with:\n embed_and_ and outer_or_ prepends.", - "required":false, - "schema":{ - "type":"string" + "trial_status": { + "in": "query", + "name": "trial_status", + "description": "Possible value: OPEN \n(Equivalent to:
current_trial_status=active&current_trial_status=approved
&current_trial_status=enrolling by invitation
&current_trial_status=in review
&current_trial_status=temporarily closed to accrual
&current_trial_status=temporarily closed to accrual and intervention
&sites.recruitment_status=active&sites.recruitment_status=approved
&sites.recruitment_status=enrolling_by_invitation
&sites.recruitment_status=in_review
&sites.recruitment_status=temporarily_closed_to_accrual
&record_verification_date_gte=<date reflecting 2 years ago> )\n

In other words, for a trial to be considered "OPEN", current_trial_status must be one of:

and sites.recruitment_status must be one of:

and record_verification_date must be a date within the past two years

Currently does not work in combination with:\n embed_and_ and outer_or_ prepends.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "OPEN ":{ - "value":"OPEN" + "OPEN ": { + "value": "OPEN" }, - "Invalid value (search will result in 500 response code)":{ - "value":"SOMETHING" + "Invalid value (search will result in 500 response code)": { + "value": "SOMETHING" } } }, - "size_small":{ - "in":"query", - "name":"size", - "description":"Limit the amount of results a supplied amount (default is 10, max is 50). Note that this parameter will be ignored when export parameter is passed.", - "required":false, - "schema":{ - "type":"integer", - "minimum":1, - "maximum":50 + "size_small": { + "in": "query", + "name": "size", + "description": "Limit the amount of results a supplied amount (default is 10, max is 50). Note that this parameter will be ignored when export parameter is passed.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 50 } }, - "size":{ - "in":"query", - "name":"size", - "description":"Not using the size parameter, by default, will give you ALL the results AND, in addition, will give you the 'total' field in the results, with the total count of the results. Once you do use the size parameter however, the number of results will be according to the size specified, AND, in addition, the 'total' field will not exist in your results.", - "required":false, - "schema":{ - "type":"integer", - "minimum":1, - "maximum":100 + "size": { + "in": "query", + "name": "size", + "description": "Not using the size parameter, by default, will give you ALL the results AND, in addition, will give you the 'total' field in the results, with the total count of the results. Once you do use the size parameter however, the number of results will be according to the size specified, AND, in addition, the 'total' field will not exist in your results.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100 } }, - "order":{ - "in":"query", - "name":"order", - "description":"Asc or Desc. Required when using sort.", - "required":false, - "schema":{ - "type":"string" + "order": { + "in": "query", + "name": "order", + "description": "Asc or Desc. Required when using sort.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "ascending order":{ - "value":"asc" + "ascending order": { + "value": "asc" }, - "descending order":{ - "value":"desc" + "descending order": { + "value": "desc" } } }, - "from":{ - "in":"query", - "name":"from", - "description":"Starting from nth position of results lineup. Start the results from a supplied starting point (default is 0).", - "required":false, - "schema":{ - "type":"integer", - "minimum":1 + "from": { + "in": "query", + "name": "from", + "description": "Starting from nth position of results lineup. Start the results from a supplied starting point (default is 0).", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 } }, - "current_trial_status":{ - "in":"query", - "name":"current_trial_status", - "description":"", - "required":false, - "schema":{ - "type":"string" + "current_trial_status": { + "in": "query", + "name": "current_trial_status", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Active":{ - "value":"Active" + "Active": { + "value": "Active" }, - "Administratively Complete":{ - "value":"Administratively Complete" + "Administratively Complete": { + "value": "Administratively Complete" }, - "Approved":{ - "value":"Approved" + "Approved": { + "value": "Approved" }, - "Closed to Accrual":{ - "value":"Closed to Accrual" + "Closed to Accrual": { + "value": "Closed to Accrual" }, - "Closed to Accrual and Intervention":{ - "value":"Closed to Accrual and Intervention" + "Closed to Accrual and Intervention": { + "value": "Closed to Accrual and Intervention" }, - "Complete":{ - "value":"Complete" + "Complete": { + "value": "Complete" }, - "INACTIVE":{ - "value":"INACTIVE" + "INACTIVE": { + "value": "INACTIVE" }, - "Enrolling by Invitation":{ - "value":"Enrolling by Invitation" + "Enrolling by Invitation": { + "value": "Enrolling by Invitation" }, - "Temporarily Closed to Accrual and Intervention":{ - "value":"Temporarily Closed to Accrual and Intervention" + "Temporarily Closed to Accrual and Intervention": { + "value": "Temporarily Closed to Accrual and Intervention" }, - "Temporarily Closed to Accrual":{ - "value":"Temporarily Closed to Accrual" + "Temporarily Closed to Accrual": { + "value": "Temporarily Closed to Accrual" }, - "In Review":{ - "value":"In Review" + "In Review": { + "value": "In Review" }, - "Withdrawn":{ - "value":"Withdrawn" + "Withdrawn": { + "value": "Withdrawn" } } }, - "export":{ - "in":"query", - "name":"export", - "description":"Export all query results into a file. The data will be available to download using a link that will arrive by email.
Supported formats are JSON (export=json) and Excel (export=xls).
Requires email parameter. See also optional filename parameter. Note that size parameter will be ignored during exports.", - "required":false, - "schema":{ - "type":"string" + "export": { + "in": "query", + "name": "export", + "description": "Export all query results into a file. The data will be available to download using a link that will arrive by email.
Supported formats are JSON (export=json) and Excel (export=xls).
Requires email parameter. See also optional filename parameter. Note that size parameter will be ignored during exports.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Export in JSON format":{ - "value":"json" + "Export in JSON format": { + "value": "json" }, - "excel (xls)":{ - "value":"xls" + "excel (xls)": { + "value": "xls" }, - "Invalid value (search will result in 400 response code)":{ - "value":"SOMETHING" + "Invalid value (search will result in 400 response code)": { + "value": "SOMETHING" } } }, - "filename":{ - "in":"query", - "name":"filename", - "description":"To be used with export to indicate the beginning of the file name for exported data.
If omitted, filename will start with \"report\".", - "required":false, - "schema":{ - "type":"string" + "filename": { + "in": "query", + "name": "filename", + "description": "To be used with export to indicate the beginning of the file name for exported data.
If omitted, filename will start with \"report\".", + "required": false, + "schema": { + "type": "string" } }, - "email":{ - "in":"query", - "name":"email", - "description":"Required when using export to indicate the email address for exported data.", - "required":false, - "schema":{ - "type":"string" + "email": { + "in": "query", + "name": "email", + "description": "Required when using export to indicate the email address for exported data.", + "required": false, + "schema": { + "type": "string" } }, - "generic_contact":{ - "in":"query", - "name":"generic_contact", - "description":"", - "required":false, - "schema":{ - "type":"string" + "generic_contact": { + "in": "query", + "name": "generic_contact", + "description": "", + "required": false, + "schema": { + "type": "string" } }, - "sites.generic_contact":{ - "in":"query", - "name":"sites.generic_contact", - "description":"", - "required":false, - "schema":{ - "type":"string" + "sites.generic_contact": { + "in": "query", + "name": "sites.generic_contact", + "description": "", + "required": false, + "schema": { + "type": "string" } }, - "lead_org_cancer_center":{ - "in":"query", - "name":"lead_org_cancer_center", - "description":"Search by Lead Org Cancer Center", - "required":false, - "schema":{ - "type":"string" + "lead_org_cancer_center": { + "in": "query", + "name": "lead_org_cancer_center", + "description": "Search by Lead Org Cancer Center", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Mayo Clinic Cancer Center":{ - "value":"Mayo Clinic Cancer Center" + "Mayo Clinic Cancer Center": { + "value": "Mayo Clinic Cancer Center" }, - "Alvin J. Siteman Cancer Center":{ - "value":"Alvin J. Siteman Cancer Center" + "Alvin J. Siteman Cancer Center": { + "value": "Alvin J. Siteman Cancer Center" }, - "University of Chicago Comprehensive Cancer Center":{ - "value":"University of Chicago Comprehensive Cancer Center" + "University of Chicago Comprehensive Cancer Center": { + "value": "University of Chicago Comprehensive Cancer Center" }, - "MD Anderson Cancer Center":{ - "value":"MD Anderson Cancer Center" + "MD Anderson Cancer Center": { + "value": "MD Anderson Cancer Center" }, - "Roswell Park Cancer Institute":{ - "value":"Roswell Park Cancer Institute" + "Roswell Park Cancer Institute": { + "value": "Roswell Park Cancer Institute" }, - "Stanford Cancer Institute":{ - "value":"Stanford Cancer Institute" + "Stanford Cancer Institute": { + "value": "Stanford Cancer Institute" } } }, - "nci_funded":{ - "in":"query", - "name":"nci_funded", - "description":"Search by NCI funded", - "required":false, - "schema":{ - "type":"string" + "nci_funded": { + "in": "query", + "name": "nci_funded", + "description": "Search by NCI funded", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Indirect":{ - "value":"Indirect" + "Indirect": { + "value": "Indirect" }, - "Direct":{ - "value":"Direct" + "Direct": { + "value": "Direct" }, - "No":{ - "value":"No" + "No": { + "value": "No" } } } }, - "responses":{ - "badReq":{ - "description":"Error Bad Request", - "headers":{ - "Access-Control-Allow-Origin":{ - "allowEmptyValue":true, - "example":"http://127.0.0.1", - "schema":{ - "type":"string" + "responses": { + "badReq": { + "description": "Error Bad Request", + "headers": { + "Access-Control-Allow-Origin": { + "allowEmptyValue": true, + "example": "http://127.0.0.1", + "schema": { + "type": "string" } } }, - "content":{ - "application/json":{ - "schema":{ - "type":"object", - "properties":{ - "code":{ - "description":"HTTP status code 400 - Bad Request", - "type":"integer", - "format":"int64", - "x-go-name":"Code" + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "description": "HTTP status code 400 - Bad Request", + "type": "integer", + "format": "int64", + "x-go-name": "Code" } } } } } }, - "forbiddenReq":{ - "description":"Error Forbidden", - "content":{ - "application/json":{ - "schema":{ - "type":"object", - "properties":{ - "code":{ - "description":"HTTP status code 403 - Forbidden", - "type":"integer", - "format":"int64", - "x-go-name":"Code" + "forbiddenReq": { + "description": "Error Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "description": "HTTP status code 403 - Forbidden", + "type": "integer", + "format": "int64", + "x-go-name": "Code" } } } } } }, - "notFoundReq":{ - "description":"Error Not Found", - "content":{ - "application/json":{ - "schema":{ - "type":"object", - "properties":{ - "code":{ - "description":"HTTP status code 404 - Not Found", - "type":"integer", - "format":"int64", - "x-go-name":"Code" + "notFoundReq": { + "description": "Error Not Found", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "description": "HTTP status code 404 - Not Found", + "type": "integer", + "format": "int64", + "x-go-name": "Code" } } } } } }, - "okResp":{ - "description":"Success response", - "content":{ - "application/json":{ - "schema":{ - "type":"object", - "properties":{ - "code":{ - "description":"HTTP status code 200 - OK", - "type":"integer", - "format":"int64", - "x-go-name":"Code" + "okResp": { + "description": "Success response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "description": "HTTP status code 200 - OK", + "type": "integer", + "format": "int64", + "x-go-name": "Code" } } } @@ -937,2231 +1163,2225 @@ } } }, - "servers":[ + "servers": [ { - "url":"https://clinicaltrialsapi.cancer.gov/api/v2", - "description":"Production Server" + "url": "https://clinicaltrialsapi.cancer.gov/api/v2", + "description": "Production Server" } ], - "paths":{ - "/trials/{id}":{ - "get":{ - "tags":[ + "paths": { + "/trials/{id}": { + "get": { + "tags": [ "Trials" ], - "summary":"Get One Trial", - "security":[ + "summary": "Get One Trial", + "security": [ { - "ApiKeyAuth":[ - - ] + "ApiKeyAuth": [] } ], - "description":"

GET trials<id>



Retrieves the clinical trial with supplied nci_id or nct_id. All fields (including nested ones) are returned.

", - "operationId":"getTrialById", - "parameters":[ - { - "in":"path", - "name":"id", - "description":"NCI ID or NCT ID of Trial.", - "required":true, - "schema":{ - "type":"string" + "description": "

GET trials<id>



Retrieves the clinical trial with supplied nci_id or nct_id. All fields (including nested ones) are returned.

", + "operationId": "getTrialById", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "NCI ID or NCT ID of Trial.", + "required": true, + "schema": { + "type": "string" }, - "examples":{ - "valid nci_id: NCI-2019-02616":{ - "value":"NCI-2019-02616" + "examples": { + "valid nci_id: NCI-2019-02616": { + "value": "NCI-2019-02616" }, - "valid nct_id: NCT03386721":{ - "value":"NCT03386721" + "valid nct_id: NCT03386721": { + "value": "NCT03386721" }, - "non-existent nci_id: NCI-2014-99999 (will result in 404 response code)":{ - "value":"NCI-2014-99999" + "non-existent nci_id: NCI-2014-99999 (will result in 404 response code)": { + "value": "NCI-2014-99999" }, - "non-existent nct_id: NCT99999999 (will result in 404 response code)":{ - "value":"NCT99999999" + "non-existent nct_id: NCT99999999 (will result in 404 response code)": { + "value": "NCT99999999" }, - "nci_id 15-00414":{ - "value":"NCI-2015-00414" + "nci_id 15-00414": { + "value": "NCI-2015-00414" }, - "nci_id 16-00376":{ - "value":"NCI-2016-00376" + "nci_id 16-00376": { + "value": "NCI-2016-00376" }, - "nci_id 16-00469":{ - "value":"NCI-2016-00469" + "nci_id 16-00469": { + "value": "NCI-2016-00469" }, - "nci_id 17-00679":{ - "value":"NCI-2017-00679" + "nci_id 17-00679": { + "value": "NCI-2017-00679" }, - "nci_id 18-02229":{ - "value":"NCI-2018-02229" + "nci_id 18-02229": { + "value": "NCI-2018-02229" }, - "nci_id 16-01319":{ - "value":"NCI-2016-01319" + "nci_id 16-01319": { + "value": "NCI-2016-01319" }, - "nci_id 16-01435":{ - "value":"NCI-2016-01435" + "nci_id 16-01435": { + "value": "NCI-2016-01435" }, - "nci_id 17-00223":{ - "value":"NCI-2017-00223" + "nci_id 17-00223": { + "value": "NCI-2017-00223" }, - "nct_id 03391791":{ - "value":"NCT03391791" + "nct_id 03391791": { + "value": "NCT03391791" }, - "NCT02369029":{ - "value":"NCT02369029" + "NCT02369029": { + "value": "NCT02369029" }, - "NCT02877862":{ - "value":"NCT02877862" + "NCT02877862": { + "value": "NCT02877862" }, - "NCT02565758":{ - "value":"NCT02565758" + "NCT02565758": { + "value": "NCT02565758" }, - "NCT03110159":{ - "value":"NCT03110159" + "NCT03110159": { + "value": "NCT03110159" }, - "NCT02896907":{ - "value":"NCT02896907" + "NCT02896907": { + "value": "NCT02896907" }, - "NCT02816697":{ - "value":"NCT02816697" + "NCT02816697": { + "value": "NCT02816697" }, - "NCT03092856":{ - "value":"NCT03092856" + "NCT03092856": { + "value": "NCT03092856" } } } ], - "responses":{ - "200":{ - "description":"Trial details for the given id.", - "headers":{ - "Access-Control-Allow-Origin":{ - "allowEmptyValue":true, - "example":"http://127.0.0.1", - "schema":{ - "type":"string" + "responses": { + "200": { + "description": "Trial details for the given id.", + "headers": { + "Access-Control-Allow-Origin": { + "allowEmptyValue": true, + "example": "http://127.0.0.1", + "schema": { + "type": "string" } } }, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TrialDetail" - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/TrialDetail" + } + } } }, - "404":{ - "description":"Not found." + "404": { + "description": "Not found." }, - "400":{ - "description":"Bad Request." + "400": { + "description": "Bad Request." }, - "500":{ - "description":"An exception occurred at the backend." + "500": { + "description": "An exception occurred at the backend." }, - "502":{ - "description":"An exception occurred at the backend." + "502": { + "description": "An exception occurred at the backend." } } } }, - "/trials":{ - "get":{ - "tags":[ + "/trials": { + "get": { + "tags": [ "Trials" ], - "summary":"Search Trials by GET", - "security":[ + "summary": "Search Trials by GET", + "security": [ { - "ApiKeyAuth":[ - - ] + "ApiKeyAuth": [] } ], - "description":"

GET trials?<filter_params>


This endpoint filters all clinical trials based upon supplied filter params. Filter params may be any of the fields in the schema and others for more filtering capabilities as described below.

<field_param>: filter results by examining a field by it's default search setting. For example a boolean field will expect true/false, number fields expect numbers and text fields expect text fields. Note that most SHORT text fields are by default set to be searched by exact match except they are case insensive, while LONG text fields like descriptions are by default set to be searched by fulltext as described below. Should one need to search differently, for example by typeahead or exact match including case, the options for doing such are listed below.

<field_param>._fulltext: (note . before _) filter results by examining a field for occurrence of a 'word' equal to the given value or a variation of it.

Example: sites.org_name._fulltext=clinic will find records with org_name: "Sanford Clinic North-Fargo" and "University of Kansas Clinical Research Center" - as the word "clinical" is a variation of the word "clinic".

If you provide a multi-word value, it breaks the given value into words and apply an \"and\" condition regardless of order.

For example: brief_title._fulltext=breast%20cancer will search for records with both "breast" and "cancer" in the brief_title field, in any order.

<field_param>._auto: filter results by examining the beginning of each word for the given value.

Example: lead_org._auto=roches will find records with "University of Rochester NCORP Research Base".

Note: lead_org._fulltext=roches will find "Hoffmann-La Roche" (because roches appears to be plural of roche), but will not find fields containing the word "Rochester", because it's not a variation of "roches".

Multi-word values are not broken into words. The exact given value is applied to the beginning of any word in the field, to create an \"autocomplete\" feature.

<field_param>._raw: filter results by exact, case sensitive match of the field for the given value.


When supplying an array of values for a single filter param, please use the following convention: trials?<field_param>=<field_value_a>&<field_param>=<field_value_b> and note that string field values are not case sensitive (must otherwise must match exactly).

Example: trials?sites.org_state_or_province=CA&sites.org_state_or_province=OR

Prior Therapy Searches

When searching in the trials Endpoint with multiple values for Prior Therapy, the following parameters in the API will treat the values as an OR condition and will return data that satisfies at least one of the condition being searched: inclusion_indicator, name, nci_thesaurus_concept_id, parents, synonyms, type, ancestor_ids

Example

Date and Number Range Searches

For field params which are filtering as ranges (date and long types), please supply _gte or _lte to the end of the field param (depending on if you are filtering on greater than or equal (gte), less than or equal (lte), or both):
trials?<field_param>_gte=<field_value_from>&<field_param>_lte=<field_value_to>

Example: trials?record_verification_date_gte=2016-08-25

Filtering Out Values

Appending _not to a parameter creates a NOT condition. Unlike normally (without the _not), where an OR condition is created, for _not parameters, multiple _not values of the same fields creates an AND condition between them.

Example: trials?current_trial_status_not=Active¤t_trial_status_not=Complete&nci_id_not=NCI-2017-01522

This request will return trials where (the current status is NOT Active AND current status is NOT Complete) AND nci_id is not NCI-2017-01522)

Embedded Searches

Prepending embed_and_ creates a whole new search within a search to give you an embedded AND condition for all the parameters with the prepend. Up to 6 embedded searches are allowed.

Example: trials?sites.org_country=Canada&keyword=Breast Cancer&embed_and_keyword=OSU-14078&embed_and_keyword_field=ccr_id&embed_and_keyword_field=ctep_id&embed_and_keyword_field=dcp_id &embed_and_keyword_field=nci_id&embed_and_keyword_field=nct_id&embed_and_keyword_field=other_ids.value &embed_and_keyword_field=protocol_id&embed_and_embed_and_sites.org_country=Uganda

In this search we have three searches (2 of them embedded) joined with an AND condition due to this embedment:

1. ...there is a match for the keyword search for Breast Cancer using our default configuration for keyword searches, and with a site in Canada.
AND
2. ...there is a match for the keyword search for OSU-14078 using a custom configuration of the keyword fields (rather than using the default)
AND
3. ... there is a site located in Uganda

Parallel Searches

Prepending outer_or_ creates a whole new parallel search with an OR condition between the searches for all the parameters with the prepend. Up to 6 parallel searches are allowed.

Example: trials?lead_org=Breast Cancer Institute&outer_or_diseases.name._fulltext=Breast Cancer&outer_or_outer_or_sites.org_name=Dana Breast Cancer Institute

In this search we have three parallel searches joined with an OR condition:

...the lead organization is Breast Cancer Institute
OR
...the trial has a disease where the disease name is Breast Cancer
OR
...one of the sites has org name \u201cDana Breast Cancer Institute\u201d

Negating Searches

Prepending outer_not_ creates a whole new search for all the parameters with the prepend and then negates the entire query or subquery.

Example: trials?current_trial_status=ACTIVE&primary_purpose=TREATMENT&eligibility.structured.gender=BOTH&diseases.is_lead_disease=true&diseases.nci_thesaurus_concept_id=C4872&embed_and_outer_not_diseases.nci_thesaurus_concept_id=C71732&embed_and_outer_not_diseases.is_lead_disease=true&embed_and_embed_and_outer_not_diseases.nci_thesaurus_concept_id=C53556&embed_and_embed_and_outer_not_diseases.is_lead_disease=true

In this search:

...all the active trials with treatment as the primary purpose accepting both genders where breast cancer (C4872) is a lead disease, And where Triple-Negative Breast Cancer (C71732) is NOT a lead disease, And HER2 Positive Breast Carcinoma (C53556) is NOT a lead disease.

Disease Type Filters

The disease elements in the trials have been tagged by one or more of five different types: maintype, subtype, stage, grade and finding. The API allows users to search by type.

Example: trials?include=none&grade=C9137&grade=C3641&maintype=C4872&maintype=C4878

This request will return trials with (Breast Cancer [C4872] OR Lung Cancer [C4878]) AND (Combined Small Cell Lung Cancer [C9137] OR Stage 0 Breast Cancer [C3641])

Field Aggregations

Aggregations of fields is accomplished by parameter agg_field and supports progressive trials filtering

This functionality is only available at the trials end point. Trials results are given and as usual total and data always belong to the results of the trials search, and within that, Aggregations results are listed in the results under \u201caggregations\u201d field under the trials results. All fields like aggregations.doc_count, refer to the aggregations.

Available Filters for Field Aggregations:

agg_name: If text\u2026. Auto complete for key must match given value. Note that this typeahead functionality is currently not available for the anatomic_sites field.
agg_min_count: doc_count for a given key must be a minimum of a given number amount (this filter will not lower key doc_count)

The \"size\" and \"from\" parameter enhancements for aggregations apply when: aggregations are requested for the trial endpoint, and the parameter\u00a0\"include = none\" is specified. For this request, as before, no trial data is returned and CTS API will return the entire set of the aggregations\u00a0as\u00a0bound by the \"size\" and \"from\" parameters (if included in request).

If the aggregations' request is made for the trials endpoint and the include parameter is not included and/or specified to include data fields (e.g., include=nci_id) then the \"size\" and \"from\" parameters as before apply to the data returned rather than the aggregations.

For Sorting Field Aggregations:

agg_field_sort Default set to 'name'. Currently works only for values name and count.
agg_field_order Default set to 'asc' (alphabetical order) when agg_field_sort is not specified and defaulted to name. Otherwise currently works only for values asc and desc.

Example: /api/v2/trials?agg_field=lead_org&current_trial_status=Active&agg_name=Anderson&include=nci_id&size=1
{\n
      \"total\": 6180,            ← number of trials where the current trial status is Active\n
      \"data\": [{                  ← other data relating to trials from the trails filters\n
           \"nci_id\": \"NCI-2015-01918\" \n
      }],\n
      \"aggregations\": {       ← From 6180 trials we made aggregations and filtered to autocomplete lead_org of “Anderson”\n
           \"doc_count\": 491, ← # of trials where the current trial status is Active that meet the criteria of “Anderson” for aggregations\n
           \"lead_org\": [{        ← actual aggregations for lead org\n
                     \"key\": \"M D Anderson Cancer Center\",    ← key that qualified for the filter\n
                     \"doc_count\": 484    ← actual trials count for lead org with key\n
                },\n
                {\n
                     \"key\": \"University of Texas MD Anderson Cancer Center LAO\",\n
                     \"doc_count\": 7\n
                }\n
          ]\n
     }\n
}

Default Sort Order of Trials

Deprecations

_fulltext: DEPRECATED. Use keyword instead which is configured with the same fields by default.

_fulltext: DEPRECATED. Use ._fulltext where available, as described above.

_trialids: DEPRECATED. Use trial_ids

Below are some examples of filters for trials and configurations of results.

If you are crafting more complicated queries, it might be best to use the POST endpoint of the same name.

", - "operationId":"searchTrialsByGet", - "parameters":[ + "description": "

GET trials?<filter_params>


This endpoint filters all clinical trials based upon supplied filter params. Filter params may be any of the fields in the schema and others for more filtering capabilities as described below.

<field_param>: filter results by examining a field by it's default search setting. For example a boolean field will expect true/false, number fields expect numbers and text fields expect text fields. Note that most SHORT text fields are by default set to be searched by exact match except they are case insensive, while LONG text fields like descriptions are by default set to be searched by fulltext as described below. Should one need to search differently, for example by typeahead or exact match including case, the options for doing such are listed below.

<field_param>._fulltext: (note . before _) filter results by examining a field for occurrence of a 'word' equal to the given value or a variation of it.

Example: sites.org_name._fulltext=clinic will find records with org_name: "Sanford Clinic North-Fargo" and "University of Kansas Clinical Research Center" - as the word "clinical" is a variation of the word "clinic".

If you provide a multi-word value, it breaks the given value into words and apply an \"and\" condition regardless of order.

For example: brief_title._fulltext=breast%20cancer will search for records with both "breast" and "cancer" in the brief_title field, in any order.

<field_param>._auto: filter results by examining the beginning of each word for the given value.

Example: lead_org._auto=roches will find records with "University of Rochester NCORP Research Base".

Note: lead_org._fulltext=roches will find "Hoffmann-La Roche" (because roches appears to be plural of roche), but will not find fields containing the word "Rochester", because it's not a variation of "roches".

Multi-word values are not broken into words. The exact given value is applied to the beginning of any word in the field, to create an \"autocomplete\" feature.

<field_param>._raw: filter results by exact, case sensitive match of the field for the given value.


When supplying an array of values for a single filter param, please use the following convention: trials?<field_param>=<field_value_a>&<field_param>=<field_value_b> and note that string field values are not case sensitive (must otherwise must match exactly).

Example: trials?sites.org_state_or_province=CA&sites.org_state_or_province=OR

Prior Therapy Searches

When searching in the trials Endpoint with multiple values for Prior Therapy, the following parameters in the API will treat the values as an OR condition and will return data that satisfies at least one of the condition being searched: inclusion_indicator, name, nci_thesaurus_concept_id, parents, synonyms, type, ancestor_ids

Example

Date and Number Range Searches

For field params which are filtering as ranges (date and long types), please supply _gte or _lte to the end of the field param (depending on if you are filtering on greater than or equal (gte), less than or equal (lte), or both):
trials?<field_param>_gte=<field_value_from>&<field_param>_lte=<field_value_to>

Example: trials?record_verification_date_gte=2016-08-25

Filtering Out Values

Appending _not to a parameter creates a NOT condition. Unlike normally (without the _not), where an OR condition is created, for _not parameters, multiple _not values of the same fields creates an AND condition between them.

Example: trials?current_trial_status_not=Active¤t_trial_status_not=Complete&nci_id_not=NCI-2017-01522

This request will return trials where (the current status is NOT Active AND current status is NOT Complete) AND nci_id is not NCI-2017-01522)

Embedded Searches

Prepending embed_and_ creates a whole new search within a search to give you an embedded AND condition for all the parameters with the prepend. Up to 6 embedded searches are allowed.

Example: trials?sites.org_country=Canada&keyword=Breast Cancer&embed_and_keyword=OSU-14078&embed_and_keyword_field=ccr_id&embed_and_keyword_field=ctep_id&embed_and_keyword_field=dcp_id &embed_and_keyword_field=nci_id&embed_and_keyword_field=nct_id&embed_and_keyword_field=other_ids.value &embed_and_keyword_field=protocol_id&embed_and_embed_and_sites.org_country=Uganda

In this search we have three searches (2 of them embedded) joined with an AND condition due to this embedment:

1. ...there is a match for the keyword search for Breast Cancer using our default configuration for keyword searches, and with a site in Canada.
AND
2. ...there is a match for the keyword search for OSU-14078 using a custom configuration of the keyword fields (rather than using the default)
AND
3. ... there is a site located in Uganda

Parallel Searches

Prepending outer_or_ creates a whole new parallel search with an OR condition between the searches for all the parameters with the prepend. Up to 6 parallel searches are allowed.

Example: trials?lead_org=Breast Cancer Institute&outer_or_diseases.name._fulltext=Breast Cancer&outer_or_outer_or_sites.org_name=Dana Breast Cancer Institute

In this search we have three parallel searches joined with an OR condition:

...the lead organization is Breast Cancer Institute
OR
...the trial has a disease where the disease name is Breast Cancer
OR
...one of the sites has org name \u201cDana Breast Cancer Institute\u201d

Negating Searches

Prepending outer_not_ creates a whole new search for all the parameters with the prepend and then negates the entire query or subquery.

Example: trials?current_trial_status=ACTIVE&primary_purpose=TREATMENT&eligibility.structured.gender=BOTH&diseases.is_lead_disease=true&diseases.nci_thesaurus_concept_id=C4872&embed_and_outer_not_diseases.nci_thesaurus_concept_id=C71732&embed_and_outer_not_diseases.is_lead_disease=true&embed_and_embed_and_outer_not_diseases.nci_thesaurus_concept_id=C53556&embed_and_embed_and_outer_not_diseases.is_lead_disease=true

In this search:

...all the active trials with treatment as the primary purpose accepting both genders where breast cancer (C4872) is a lead disease, And where Triple-Negative Breast Cancer (C71732) is NOT a lead disease, And HER2 Positive Breast Carcinoma (C53556) is NOT a lead disease.

Disease Type Filters

The disease elements in the trials have been tagged by one or more of five different types: maintype, subtype, stage, grade and finding. The API allows users to search by type.

Example: trials?include=none&grade=C9137&grade=C3641&maintype=C4872&maintype=C4878

This request will return trials with (Breast Cancer [C4872] OR Lung Cancer [C4878]) AND (Combined Small Cell Lung Cancer [C9137] OR Stage 0 Breast Cancer [C3641])

Field Aggregations

Aggregations of fields is accomplished by parameter agg_field and supports progressive trials filtering

This functionality is only available at the trials end point. Trials results are given and as usual total and data always belong to the results of the trials search, and within that, Aggregations results are listed in the results under \u201caggregations\u201d field under the trials results. All fields like aggregations.doc_count, refer to the aggregations.

Available Filters for Field Aggregations:

agg_name: If text\u2026. Auto complete for key must match given value. Note that this typeahead functionality is currently not available for the anatomic_sites field.
agg_min_count: doc_count for a given key must be a minimum of a given number amount (this filter will not lower key doc_count)

The \"size\" and \"from\" parameter enhancements for aggregations apply when: aggregations are requested for the trial endpoint, and the parameter\u00a0\"include = none\" is specified. For this request, as before, no trial data is returned and CTS API will return the entire set of the aggregations\u00a0as\u00a0bound by the \"size\" and \"from\" parameters (if included in request).

If the aggregations' request is made for the trials endpoint and the include parameter is not included and/or specified to include data fields (e.g., include=nci_id) then the \"size\" and \"from\" parameters as before apply to the data returned rather than the aggregations.

For Sorting Field Aggregations:

agg_field_sort Default set to 'name'. Currently works only for values name and count.
agg_field_order Default set to 'asc' (alphabetical order) when agg_field_sort is not specified and defaulted to name. Otherwise currently works only for values asc and desc.

Example: /api/v2/trials?agg_field=lead_org&current_trial_status=Active&agg_name=Anderson&include=nci_id&size=1
{\n
      \"total\": 6180,            ← number of trials where the current trial status is Active\n
      \"data\": [{                  ← other data relating to trials from the trails filters\n
           \"nci_id\": \"NCI-2015-01918\" \n
      }],\n
      \"aggregations\": {       ← From 6180 trials we made aggregations and filtered to autocomplete lead_org of “Anderson”\n
           \"doc_count\": 491, ← # of trials where the current trial status is Active that meet the criteria of “Anderson” for aggregations\n
           \"lead_org\": [{        ← actual aggregations for lead org\n
                     \"key\": \"M D Anderson Cancer Center\",    ← key that qualified for the filter\n
                     \"doc_count\": 484    ← actual trials count for lead org with key\n
                },\n
                {\n
                     \"key\": \"University of Texas MD Anderson Cancer Center LAO\",\n
                     \"doc_count\": 7\n
                }\n
          ]\n
     }\n
}

Default Sort Order of Trials

Deprecations

_fulltext: DEPRECATED. Use keyword instead which is configured with the same fields by default.

_fulltext: DEPRECATED. Use ._fulltext where available, as described above.

_trialids: DEPRECATED. Use trial_ids

Below are some examples of filters for trials and configurations of results.

If you are crafting more complicated queries, it might be best to use the POST endpoint of the same name.

", + "operationId": "searchTrialsByGet", + "parameters": [ { - "$ref":"#/components/parameters/size_small" + "$ref": "#/components/parameters/size_small" }, { - "$ref":"#/components/parameters/from" + "$ref": "#/components/parameters/from" }, { - "in":"query", - "name":"sort", - "description":"The 'Default Sort Order of Trials' described above, can be overwritten by this param which allows a sort by field. Sorting should be available on most fields as long as they are sortable (i.e not available on objects and list/array fields and fields with list/array parent).
\nNote here that by sorting with the following number fields: ... allows the user to sort by number assigned to a value mapped, as described under the 'Default Sort Order of Trials' section, rather than sorting by alphabetical order of the string values which may have limited value to some.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sort", + "description": "The 'Default Sort Order of Trials' described above, can be overwritten by this param which allows a sort by field. Sorting should be available on most fields as long as they are sortable (i.e not available on objects and list/array fields and fields with list/array parent).
\nNote here that by sorting with the following number fields: ... allows the user to sort by number assigned to a value mapped, as described under the 'Default Sort Order of Trials' section, rather than sorting by alphabetical order of the string values which may have limited value to some.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "use default":{ - "value":"" + "examples": { + "use default": { + "value": "" }, - "_study_protocol_type_sort_order":{ - "value":"_study_protocol_type_sort_order" + "_study_protocol_type_sort_order": { + "value": "_study_protocol_type_sort_order" }, - "_primary_purpose_sort_order":{ - "value":"_primary_purpose_sort_order" + "_primary_purpose_sort_order": { + "value": "_primary_purpose_sort_order" }, - "_phase_sort_order":{ - "value":"_phase_sort_order" + "_phase_sort_order": { + "value": "_phase_sort_order" }, - "_current_trial_status_sort_order":{ - "value":"_current_trial_status_sort_order" + "_current_trial_status_sort_order": { + "value": "_current_trial_status_sort_order" }, - "nci_id":{ - "value":"nci_id" + "nci_id": { + "value": "nci_id" }, - "nct_id":{ - "value":"nct_id" + "nct_id": { + "value": "nct_id" }, - "current_trial_status":{ - "value":"current_trial_status" + "current_trial_status": { + "value": "current_trial_status" }, - "study_protocol_type":{ - "value":"study_protocol_type" + "study_protocol_type": { + "value": "study_protocol_type" }, - "brief_title":{ - "value":"brief_title" + "brief_title": { + "value": "brief_title" }, - "official_title":{ - "value":"official_title" + "official_title": { + "value": "official_title" }, - "study_source":{ - "value":"study_source" + "study_source": { + "value": "study_source" }, - "minimum_target_accrual_number":{ - "value":"minimum_target_accrual_number" + "minimum_target_accrual_number": { + "value": "minimum_target_accrual_number" }, - "amendment_date":{ - "value":"amendment_date" + "amendment_date": { + "value": "amendment_date" }, - "current_trial_status_date":{ - "value":"current_trial_status_date" + "current_trial_status_date": { + "value": "current_trial_status_date" }, - "record_verification_date":{ - "value":"record_verification_date" + "record_verification_date": { + "value": "record_verification_date" }, - "eligibility.structured.min_age_in_years":{ - "value":"eligibility.structured.min_age_in_years" + "eligibility.structured.min_age_in_years": { + "value": "eligibility.structured.min_age_in_years" }, - "eligibility.structured.max_age_in_years":{ - "value":"eligibility.structured.max_age_in_years" + "eligibility.structured.max_age_in_years": { + "value": "eligibility.structured.max_age_in_years" }, - "eligibility.structured.min_age_number":{ - "value":"eligibility.structured.min_age_number" + "eligibility.structured.min_age_number": { + "value": "eligibility.structured.min_age_number" }, - "eligibility.structured.max_age_number":{ - "value":"eligibility.structured.max_age_number" + "eligibility.structured.max_age_number": { + "value": "eligibility.structured.max_age_number" } } }, { - "$ref":"#/components/parameters/order" + "$ref": "#/components/parameters/order" }, { - "in":"query", - "name":"missing", - "description":"Filter by empty results (i.e by nulls, missing fields, empty array)", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "missing", + "description": "Filter by empty results (i.e by nulls, missing fields, empty array)", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "sites":{ - "value":"sites" + "sites": { + "value": "sites" }, - "acronym":{ - "value":"acronym" + "acronym": { + "value": "acronym" }, - "brief_title":{ - "value":"brief_title" + "brief_title": { + "value": "brief_title" }, - "current_trial_status":{ - "value":"current_trial_status" + "current_trial_status": { + "value": "current_trial_status" } } }, { - "in":"query", - "name":"exists", - "description":"Filter by opposite of missing, and search for existence of field with value", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "exists", + "description": "Filter by opposite of missing, and search for existence of field with value", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "sites":{ - "value":"sites" + "sites": { + "value": "sites" }, - "acronym":{ - "value":"acronym" + "acronym": { + "value": "acronym" }, - "brief_title":{ - "value":"brief_title" + "brief_title": { + "value": "brief_title" }, - "current_trial_status":{ - "value":"current_trial_status" + "current_trial_status": { + "value": "current_trial_status" } } }, { - "in":"query", - "name":"include", - "description":"Include only the supplied filter param fields in all results (useful if you want to minimize the payload returned). Use multiple times to include multiple fields.
\nValue DEFAULT is a shortcut to include the following fields: nci_id, nct_id, brief_title, sites.org_name, sites.org_postal_code, eligibility.structured, current_trial_status, sites.org_va, sites.org_country, sites.org_state_or_province, sites.org_city, sites.org_coordinates, sites.recruitment_status and diseases.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "include", + "description": "Include only the supplied filter param fields in all results (useful if you want to minimize the payload returned). Use multiple times to include multiple fields.
\nValue DEFAULT is a shortcut to include the following fields: nci_id, nct_id, brief_title, sites.org_name, sites.org_postal_code, eligibility.structured, current_trial_status, sites.org_va, sites.org_country, sites.org_state_or_province, sites.org_city, sites.org_coordinates, sites.recruitment_status and diseases.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "all fields":{ - "value":"" + "examples": { + "all fields": { + "value": "" }, - "no data; just get the count":{ - "value":"none" + "no data; just get the count": { + "value": "none" }, - "default fields":{ - "value":"DEFAULT" + "default fields": { + "value": "DEFAULT" }, - "nci_id only":{ - "value":"nci_id" + "nci_id only": { + "value": "nci_id" }, - "nct_id only":{ - "value":"nct_id" + "nct_id only": { + "value": "nct_id" }, - "phase":{ - "value":"nct_id" + "phase": { + "value": "nct_id" }, - "current_trial_status":{ - "value":"current_trial_status" + "current_trial_status": { + "value": "current_trial_status" }, - "sites.org_name":{ - "value":"sites.org_name" + "sites.org_name": { + "value": "sites.org_name" }, - "sites.contact_name":{ - "value":"sites.contact_name" + "sites.contact_name": { + "value": "sites.contact_name" } } }, { - "in":"query", - "name":"exclude", - "description":"Exclude the supplied filter param fields from all results (useful if you want most of the payload returned with the exception of a few fields). Use multiple times to exclude multiple fields. If using with include param, and values are found in both, fields in these values will be included in the results.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "exclude", + "description": "Exclude the supplied filter param fields from all results (useful if you want most of the payload returned with the exception of a few fields). Use multiple times to exclude multiple fields. If using with include param, and values are found in both, fields in these values will be included in the results.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "all fields (don't exclude any)":{ - "value":"" + "examples": { + "all fields (don't exclude any)": { + "value": "" }, - "sites":{ - "value":"sites" + "sites": { + "value": "sites" }, - "diseases":{ - "value":"diseases" + "diseases": { + "value": "diseases" } } }, { - "$ref":"#/components/parameters/export" + "$ref": "#/components/parameters/export" }, { - "$ref":"#/components/parameters/email" + "$ref": "#/components/parameters/email" }, { - "$ref":"#/components/parameters/filename" + "$ref": "#/components/parameters/filename" }, { - "in":"query", - "name":"_fulltext", - "description":"DEPRECATED. Use keyword together with keyword_field instead.", - "deprecated":true, - "schema":{ - "type":"string" + "in": "query", + "name": "_fulltext", + "description": "DEPRECATED. Use keyword together with keyword_field instead.", + "deprecated": true, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"_fulltext", - "description":"DEPRECATED. Use ._fulltext where available, described above.", - "deprecated":true, - "schema":{ - "type":"string" + "in": "query", + "name": "_fulltext", + "description": "DEPRECATED. Use ._fulltext where available, described above.", + "deprecated": true, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"_trialids", - "description":"DEPRECATED. Use trial_ids instead.", - "deprecated":true, - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "_trialids", + "description": "DEPRECATED. Use trial_ids instead.", + "deprecated": true, + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"trial_ids", - "description":"Filter results by examining trial identifiers (ccr_id, ctep_id, dcp_id, nci_id, nct_id, other_ids.value, protocol_id).\n\nExample: trials?trial_ids=nci-2011&trial_ids=NCT00", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "trial_ids", + "description": "Filter results by examining trial identifiers (ccr_id, ctep_id, dcp_id, nci_id, nct_id, other_ids.value, protocol_id).\n\nExample: trials?trial_ids=nci-2011&trial_ids=NCT00", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "nci-2011":{ - "value":"nci-2011" + "nci-2011": { + "value": "nci-2011" }, - "NCT00":{ - "value":"NCT00" + "NCT00": { + "value": "NCT00" } } }, { - "in":"query", - "name":"keyword", - "description":"Text to be searched in multiple fields. It can be combined with keyword_field.

keyword filter results by examining a variety of text-based fields (By default: *_id, other_ids.value, diseases.name._fulltext, diseases.synonyms._fulltext, brief_title, brief_summary, official_title, detail_description, official_title, brief_title, brief_summary, diseases.name._fulltext, detail_description, sites.org_name._fulltext, collaborators.name._fulltext, principal_investigator._fulltext, sites.contact_name._fulltext, sites.org_city._fulltext, sites.org_state_or_province._fulltext, arms.interventions.name, arms.interventions.synonyms, biomarkers.name, biomarkers.synonyms, prior_therapy.name, prior_therapy.synonyms).

Mutiple keywords (with a maximum of 10 allowed) will give you an OR condition of between values in all configured fields.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "keyword", + "description": "Text to be searched in multiple fields. It can be combined with keyword_field.

keyword filter results by examining a variety of text-based fields (By default: *_id, other_ids.value, diseases.name._fulltext, diseases.synonyms._fulltext, brief_title, brief_summary, official_title, detail_description, official_title, brief_title, brief_summary, diseases.name._fulltext, detail_description, sites.org_name._fulltext, collaborators.name._fulltext, principal_investigator._fulltext, sites.contact_name._fulltext, sites.org_city._fulltext, sites.org_state_or_province._fulltext, arms.interventions.name, arms.interventions.synonyms, biomarkers.name, biomarkers.synonyms, prior_therapy.name, prior_therapy.synonyms).

Mutiple keywords (with a maximum of 10 allowed) will give you an OR condition of between values in all configured fields.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "example search keyword: breast cancer":{ - "value":"breast cancer" + "example search keyword: breast cancer": { + "value": "breast cancer" } } }, { - "in":"query", - "name":"keyword_field", - "description":"Field(s) to be searched for the text provided in keyword. Use multiple times; once for each field to be searched. For example:
keyword_field=brief_title._fulltext&keyword_field=lead_org._auto. Use keyword_field to override the default fields used by keyword. A maximum of 10 fields is currently allowed.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "keyword_field", + "description": "Field(s) to be searched for the text provided in keyword. Use multiple times; once for each field to be searched. For example:
keyword_field=brief_title._fulltext&keyword_field=lead_org._auto. Use keyword_field to override the default fields used by keyword. A maximum of 10 fields is currently allowed.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "brief_title._fulltext":{ - "value":"brief_title._fulltext" + "brief_title._fulltext": { + "value": "brief_title._fulltext" }, - "lead_org._auto":{ - "value":"lead_org._auto" + "lead_org._auto": { + "value": "lead_org._auto" } } }, { - "in":"query", - "name":"agg_field", - "description":"Field to be used for aggregation. ", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "agg_field", + "description": "Field to be used for aggregation. ", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "lead_org":{ - "value":"lead_org" + "lead_org": { + "value": "lead_org" }, - "current_trial_status":{ - "value":"current_trial_status" + "current_trial_status": { + "value": "current_trial_status" } } }, { - "in":"query", - "name":"agg_name", - "description":"Filter aggregation (use with agg_field). Autocomplete of this value must match the value of the field in agg_field.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "agg_name", + "description": "Filter aggregation (use with agg_field). Autocomplete of this value must match the value of the field in agg_field.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Anderson":{ - "value":"Anderson" + "Anderson": { + "value": "Anderson" } } }, { - "in":"query", - "name":"agg_min_count", - "description":"Filter aggregation (use with agg_field). The number of documents (doc_count) for a given key (agg_field) must be a minimum of a given number amount (this filter will not lower key doc_count).", - "required":false, - "schema":{ - "type":"integer", - "minimum":1 + "in": "query", + "name": "agg_min_count", + "description": "Filter aggregation (use with agg_field). The number of documents (doc_count) for a given key (agg_field) must be a minimum of a given number amount (this filter will not lower key doc_count).", + "required": false, + "schema": { + "type": "integer", + "minimum": 1 } }, { - "in":"query", - "name":"sites.org_name._fulltext", - "description":"Filter results by examining words that make up organization name e.g 'Mayo'.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_name._fulltext", + "description": "Filter results by examining words that make up organization name e.g 'Mayo'.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Mayo":{ - "value":"Mayo" + "Mayo": { + "value": "Mayo" }, - "Paducah":{ - "value":"Paducah" + "Paducah": { + "value": "Paducah" }, - "Green Bay Oncology":{ - "value":"Green Bay Oncology" + "Green Bay Oncology": { + "value": "Green Bay Oncology" }, - "Saint Vincent Hospital":{ - "value":"Saint Vincent Hospital" + "Saint Vincent Hospital": { + "value": "Saint Vincent Hospital" } } }, { - "$ref":"#/components/parameters/trial_status" + "$ref": "#/components/parameters/trial_status" }, { - "$ref":"#/components/parameters/nci_funded" + "$ref": "#/components/parameters/nci_funded" }, { - "in":"query", - "name":"nci_id", - "description":"Search by NCI ID.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "nci_id", + "description": "Search by NCI ID.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "valid nci_id: NCI-2019-02616":{ - "value":"NCI-2019-02616" + "valid nci_id: NCI-2019-02616": { + "value": "NCI-2019-02616" }, - "non-existent nci_id: NCI-2014-99999 (will find 0 results)":{ - "value":"NCI-2014-99999" + "non-existent nci_id: NCI-2014-99999 (will find 0 results)": { + "value": "NCI-2014-99999" }, - "nci_id 16-00376":{ - "value":"NCI-2016-00376" + "nci_id 16-00376": { + "value": "NCI-2016-00376" }, - "nci_id 15-00414":{ - "value":"NCI-2015-00414" + "nci_id 15-00414": { + "value": "NCI-2015-00414" } } }, { - "in":"query", - "name":"nct_id", - "description":"Search by NCT ID.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "nct_id", + "description": "Search by NCT ID.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "valid nct_id: NCT03386721":{ - "value":"NCT03386721" + "valid nct_id: NCT03386721": { + "value": "NCT03386721" }, - "non-existent nct_id: NCT99999999 (will find 0 results)":{ - "value":"NCT99999999" + "non-existent nct_id: NCT99999999 (will find 0 results)": { + "value": "NCT99999999" } } }, { - "in":"query", - "name":"protocol_id", - "description":"Search by Protocol ID.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "protocol_id", + "description": "Search by Protocol ID.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "BNT411-01":{ - "value":"BNT411-01" + "BNT411-01": { + "value": "BNT411-01" }, - "NU 19B03":{ - "value":"NU 19B03" + "NU 19B03": { + "value": "NU 19B03" }, - "2018-0104":{ - "value":"2018-0104" + "2018-0104": { + "value": "2018-0104" }, - "AALL1732":{ - "value":"AALL1732" + "AALL1732": { + "value": "AALL1732" }, - "CCT5001":{ - "value":"CCT5001" + "CCT5001": { + "value": "CCT5001" }, - "ENT0065":{ - "value":"ENT0065" + "ENT0065": { + "value": "ENT0065" }, - "14-396":{ - "value":"14-396" + "14-396": { + "value": "14-396" }, - "2015-0835":{ - "value":"2015-0835" + "2015-0835": { + "value": "2015-0835" } } }, { - "in":"query", - "name":"ccr_id", - "description":"Search by CCR ID. (No examples available.)", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "ccr_id", + "description": "Search by CCR ID. (No examples available.)", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"ctep_id", - "description":"Search by CTEP ID", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "ctep_id", + "description": "Search by CTEP ID", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "A011401":{ - "value":"A011401" + "A011401": { + "value": "A011401" }, - "E4512":{ - "value":"E4512" + "E4512": { + "value": "E4512" }, - "EAY131":{ - "value":"EAY131" + "EAY131": { + "value": "EAY131" }, - "A081105":{ - "value":"A081105" + "A081105": { + "value": "A081105" }, - "NRG-BR003":{ - "value":"NRG-BR003" + "NRG-BR003": { + "value": "NRG-BR003" }, - "EA5163":{ - "value":"EA5163" + "EA5163": { + "value": "EA5163" }, - "A011202":{ - "value":"A011202" + "A011202": { + "value": "A011202" }, - "A081801":{ - "value":"A081801" + "A081801": { + "value": "A081801" }, - "A021703":{ - "value":"A021703" + "A021703": { + "value": "A021703" }, - "S1609":{ - "value":"S1609" + "S1609": { + "value": "S1609" }, - "EA1131":{ - "value":"EA1131" + "EA1131": { + "value": "EA1131" }, - "A031501":{ - "value":"A031501" + "A031501": { + "value": "A031501" }, - "EA9161":{ - "value":"EA9161" + "EA9161": { + "value": "EA9161" }, - "NRG-GY009":{ - "value":"NRG-GY009" + "NRG-GY009": { + "value": "NRG-GY009" }, - "S1418":{ - "value":"S1418" + "S1418": { + "value": "S1418" }, - "A041702":{ - "value":"A041702" + "A041702": { + "value": "A041702" }, - "A031704":{ - "value":"A031704" + "A031704": { + "value": "A031704" }, - "S1801":{ - "value":"S1801" + "S1801": { + "value": "S1801" }, - "S1613":{ - "value":"S1613" + "S1613": { + "value": "S1613" }, - "NRG-GI005":{ - "value":"NRG-GI005" + "NRG-GI005": { + "value": "NRG-GI005" }, - "S1815":{ - "value":"S1815" + "S1815": { + "value": "S1815" }, - "EA6134":{ - "value":"EA6134" + "EA6134": { + "value": "EA6134" }, - "EA5181":{ - "value":"EA5181" + "EA5181": { + "value": "EA5181" }, - "A021502":{ - "value":"A021502" + "A021502": { + "value": "A021502" }, - "EA8153":{ - "value":"EA8153" + "EA8153": { + "value": "EA8153" }, - "NRG-GY019":{ - "value":"NRG-GY019" + "NRG-GY019": { + "value": "NRG-GY019" }, - "A051701":{ - "value":"A051701" + "A051701": { + "value": "A051701" }, - "NSABP-B-51":{ - "value":"NSABP-B-51" + "NSABP-B-51": { + "value": "NSABP-B-51" }, - "EA3161":{ - "value":"EA3161" + "EA3161": { + "value": "EA3161" }, - "EA1181":{ - "value":"EA1181" + "EA1181": { + "value": "EA1181" }, - "NRG-BR004":{ - "value":"NRG-BR004" + "NRG-BR004": { + "value": "NRG-BR004" }, - "S1826":{ - "value":"S1826" + "S1826": { + "value": "S1826" }, - "EAA173":{ - "value":"EAA173" + "EAA173": { + "value": "EAA173" }, - "A031702":{ - "value":"A031702" + "A031702": { + "value": "A031702" }, - "S1803":{ - "value":"S1803" + "S1803": { + "value": "S1803" }, - "EA2142":{ - "value":"EA2142" + "EA2142": { + "value": "EA2142" }, - "EA2186":{ - "value":"EA2186" + "EA2186": { + "value": "EA2186" }, - "EA6141":{ - "value":"EA6141" + "EA6141": { + "value": "EA6141" }, - "S1712":{ - "value":"S1712" + "S1712": { + "value": "S1712" }, - "NRG-LU003":{ - "value":"NRG-LU003" + "NRG-LU003": { + "value": "NRG-LU003" }, - "AGCT1531":{ - "value":"AGCT1531" + "AGCT1531": { + "value": "AGCT1531" }, - "EA3132":{ - "value":"EA3132" + "EA3132": { + "value": "EA3132" }, - "EA6174":{ - "value":"EA6174" + "EA6174": { + "value": "EA6174" }, - "EA5191":{ - "value":"EA5191" + "EA5191": { + "value": "EA5191" }, - "S1929":{ - "value":"S1929" + "S1929": { + "value": "S1929" }, - "EA2182":{ - "value":"EA2182" + "EA2182": { + "value": "EA2182" }, - "EA4181":{ - "value":"EA4181" + "EA4181": { + "value": "EA4181" }, - "GOG-0263":{ - "value":"GOG-0263" + "GOG-0263": { + "value": "GOG-0263" }, - "EA2187":{ - "value":"EA2187" + "EA2187": { + "value": "EA2187" }, - "S1608":{ - "value":"S1608" + "S1608": { + "value": "S1608" } } }, { - "in":"query", - "name":"dcp_id", - "description":"Search by DCP ID. (No examples available.)", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "dcp_id", + "description": "Search by DCP ID. (No examples available.)", + "required": false, + "schema": { + "type": "string" } }, { - "$ref":"#/components/parameters/current_trial_status" + "$ref": "#/components/parameters/current_trial_status" }, { - "in":"query", - "name":"phase", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "phase", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "I":{ - "value":"I" + "I": { + "value": "I" }, - "II":{ - "value":"II" + "II": { + "value": "II" }, - "II_III":{ - "value":"II_III" + "II_III": { + "value": "II_III" }, - "III":{ - "value":"III" + "III": { + "value": "III" } } }, { - "in":"query", - "name":"study_protocol_type", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "study_protocol_type", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Interventional":{ - "value":"Interventional" + "Interventional": { + "value": "Interventional" } } }, { - "in":"query", - "name":"nci_programs", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "nci_programs", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "NCORP (NCI Community Oncology Research Program)":{ - "value":"NCORP" + "NCORP (NCI Community Oncology Research Program)": { + "value": "NCORP" }, - "NCTN (National Clinical Trials Network)":{ - "value":"NCTN" + "NCTN (National Clinical Trials Network)": { + "value": "NCTN" }, - "ETCTN (Experimental Therapeutics Clinical Trials Network)":{ - "value":"ETCTN" + "ETCTN (Experimental Therapeutics Clinical Trials Network)": { + "value": "ETCTN" } } }, { - "in":"query", - "name":"brief_title", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "brief_title", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Weight Loss Interventions":{ - "value":"Weight Loss Interventions" + "Weight Loss Interventions": { + "value": "Weight Loss Interventions" }, - "Breast Cancer Recurrence":{ - "value":"Breast Cancer Recurrence" + "Breast Cancer Recurrence": { + "value": "Breast Cancer Recurrence" }, - "Advanced Refractory Solid Tumors":{ - "value":"Advanced Refractory Solid Tumors" + "Advanced Refractory Solid Tumors": { + "value": "Advanced Refractory Solid Tumors" }, - "Rare Tumors":{ - "value":"Rare Tumors" + "Rare Tumors": { + "value": "Rare Tumors" }, - "Chronic Lymphocytic Leukemia":{ - "value":"Chronic Lymphocytic Leukemia" + "Chronic Lymphocytic Leukemia": { + "value": "Chronic Lymphocytic Leukemia" }, - "Irinotecan Hydrochloride":{ - "value":"Irinotecan Hydrochloride" + "Irinotecan Hydrochloride": { + "value": "Irinotecan Hydrochloride" } } }, { - "in":"query", - "name":"brief_summary", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "brief_summary", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Weight Loss Interventions":{ - "value":"Weight Loss Interventions" + "Weight Loss Interventions": { + "value": "Weight Loss Interventions" }, - "Breast Cancer Recurrence":{ - "value":"Breast Cancer Recurrence" + "Breast Cancer Recurrence": { + "value": "Breast Cancer Recurrence" }, - "Advanced Refractory Solid Tumors":{ - "value":"Advanced Refractory Solid Tumors" + "Advanced Refractory Solid Tumors": { + "value": "Advanced Refractory Solid Tumors" }, - "Rare Tumors":{ - "value":"Rare Tumors" + "Rare Tumors": { + "value": "Rare Tumors" }, - "Chronic Lymphocytic Leukemia":{ - "value":"Chronic Lymphocytic Leukemia" + "Chronic Lymphocytic Leukemia": { + "value": "Chronic Lymphocytic Leukemia" }, - "Irinotecan Hydrochloride":{ - "value":"Irinotecan Hydrochloride" + "Irinotecan Hydrochloride": { + "value": "Irinotecan Hydrochloride" } } }, { - "in":"query", - "name":"official_title", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "official_title", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Weight Loss Interventions":{ - "value":"Weight Loss Interventions" + "Weight Loss Interventions": { + "value": "Weight Loss Interventions" }, - "Breast Cancer Recurrence":{ - "value":"Breast Cancer Recurrence" + "Breast Cancer Recurrence": { + "value": "Breast Cancer Recurrence" }, - "Advanced Refractory Solid Tumors":{ - "value":"Advanced Refractory Solid Tumors" + "Advanced Refractory Solid Tumors": { + "value": "Advanced Refractory Solid Tumors" }, - "Rare Tumors":{ - "value":"Rare Tumors" + "Rare Tumors": { + "value": "Rare Tumors" }, - "Chronic Lymphocytic Leukemia":{ - "value":"Chronic Lymphocytic Leukemia" + "Chronic Lymphocytic Leukemia": { + "value": "Chronic Lymphocytic Leukemia" }, - "Irinotecan Hydrochloride":{ - "value":"Irinotecan Hydrochloride" + "Irinotecan Hydrochloride": { + "value": "Irinotecan Hydrochloride" } } }, { - "in":"query", - "name":"primary_purpose", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "primary_purpose", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "TREATMENT":{ - "value":"TREATMENT" + "TREATMENT": { + "value": "TREATMENT" } } }, { - "in":"query", - "name":"accepts_healthy_volunteers_indicator", - "description":"DEPRECATED. Use eligibility.structured.accepts_healthy_volunteers instead.", - "deprecated":true, - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "accepts_healthy_volunteers_indicator", + "description": "DEPRECATED. Use eligibility.structured.accepts_healthy_volunteers instead.", + "deprecated": true, + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"eligibility.structured.accepts_healthy_volunteers", - "description":"", - "required":false, - "schema":{ - "type":"boolean" + "in": "query", + "name": "eligibility.structured.accepts_healthy_volunteers", + "description": "", + "required": false, + "schema": { + "type": "boolean" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "true":{ - "value":"true" + "true": { + "value": "true" }, - "false":{ - "value":"false" + "false": { + "value": "false" } } }, { - "in":"query", - "name":"acronym", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "acronym", + "description": "", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"amendment_date", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "amendment_date", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "2019-07-18T00:00:00":{ - "value":"2019-07-18T00:00:00" + "2019-07-18T00:00:00": { + "value": "2019-07-18T00:00:00" }, - "2020-11-10T00:00:00":{ - "value":"2020-11-10T00:00:00" + "2020-11-10T00:00:00": { + "value": "2020-11-10T00:00:00" }, - "2020-11-18":{ - "value":"2020-11-18" + "2020-11-18": { + "value": "2020-11-18" }, - "2020-10-22":{ - "value":"2020-10-22" + "2020-10-22": { + "value": "2020-10-22" }, - "2019-08-15":{ - "value":"2019-08-15" + "2019-08-15": { + "value": "2019-08-15" }, - "2014-09-15":{ - "value":"2014-09-15" + "2014-09-15": { + "value": "2014-09-15" } } }, { - "in":"query", - "name":"anatomic_sites", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "anatomic_sites", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Non-Hodgkin's Lymphoma":{ - "value":"Non-Hodgkin's Lymphoma" + "Non-Hodgkin's Lymphoma": { + "value": "Non-Hodgkin's Lymphoma" }, - "Stomach":{ - "value":"Stomach" + "Stomach": { + "value": "Stomach" }, - "Esophagus":{ - "value":"Esophagus" + "Esophagus": { + "value": "Esophagus" }, - "Brain and Nervous System":{ - "value":"Brain and Nervous System" + "Brain and Nervous System": { + "value": "Brain and Nervous System" }, - "Lung":{ - "value":"Lung" + "Lung": { + "value": "Lung" }, - "Pancreas":{ - "value":"Pancreas" + "Pancreas": { + "value": "Pancreas" }, - "Kidney":{ - "value":"Kidney" + "Kidney": { + "value": "Kidney" }, - "Multiple":{ - "value":"Multiple" + "Multiple": { + "value": "Multiple" } } }, { - "in":"query", - "name":"arms.description", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "arms.description", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Patients undergo radiation therapy once daily":{ - "value":"undergo radiation therapy once daily" + "Patients undergo radiation therapy once daily": { + "value": "undergo radiation therapy once daily" }, - "Patients undergo observation":{ - "value":"Patients undergo observation" + "Patients undergo observation": { + "value": "Patients undergo observation" }, - "Patients receive standard of care carboplatin":{ - "value":"Patients receive standard of care carboplatin" + "Patients receive standard of care carboplatin": { + "value": "Patients receive standard of care carboplatin" }, - "Patients undergo 3D-CRT":{ - "value":"Patients undergo 3D-CRT" + "Patients undergo 3D-CRT": { + "value": "Patients undergo 3D-CRT" }, - "Patients receive chemoradiotherapy":{ - "value":"Patients receive chemoradiotherapy" + "Patients receive chemoradiotherapy": { + "value": "Patients receive chemoradiotherapy" } } }, { - "in":"query", - "name":"arms.name", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "arms.name", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Arm I":{ - "value":"Arm I" + "Arm I": { + "value": "Arm I" }, - "Arm A":{ - "value":"Arm A" + "Arm A": { + "value": "Arm A" }, - "Low Risk Group":{ - "value":"Low Risk Group" + "Low Risk Group": { + "value": "Low Risk Group" }, - "High Risk Group":{ - "value":"High Risk Group" + "High Risk Group": { + "value": "High Risk Group" }, - "radiation therapy":{ - "value":"radiation therapy" + "radiation therapy": { + "value": "radiation therapy" } } }, { - "in":"query", - "name":"arms.type", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "arms.type", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "EXPERIMENTAL":{ - "value":"EXPERIMENTAL" + "EXPERIMENTAL": { + "value": "EXPERIMENTAL" }, - "PLACEBO_COMPARATOR":{ - "value":"PLACEBO_COMPARATOR" + "PLACEBO_COMPARATOR": { + "value": "PLACEBO_COMPARATOR" }, - "ACTIVE_COMPARATOR":{ - "value":"ACTIVE_COMPARATOR" + "ACTIVE_COMPARATOR": { + "value": "ACTIVE_COMPARATOR" } } }, { - "in":"query", - "name":"arms.interventions.nci_thesaurus_concept_id", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "arms.interventions.nci_thesaurus_concept_id", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "C81934":{ - "value":"C81934" + "C81934": { + "value": "C81934" }, - "C349":{ - "value":"C349" + "C349": { + "value": "C349" }, - "C491":{ - "value":"C491" + "C491": { + "value": "C491" }, - "C408":{ - "value":"C408" + "C408": { + "value": "C408" }, - "C633":{ - "value":"C633" + "C633": { + "value": "C633" } } }, { - "in":"query", - "name":"arms.interventions.description", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "arms.interventions.description", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Patients undergo radiation therapy once daily":{ - "value":"undergo radiation therapy once daily" + "Patients undergo radiation therapy once daily": { + "value": "undergo radiation therapy once daily" }, - "Patients undergo observation":{ - "value":"Patients undergo observation" + "Patients undergo observation": { + "value": "Patients undergo observation" }, - "Patients receive standard of care carboplatin":{ - "value":"Patients receive standard of care carboplatin" + "Patients receive standard of care carboplatin": { + "value": "Patients receive standard of care carboplatin" }, - "Patients undergo 3D-CRT":{ - "value":"Patients undergo 3D-CRT" + "Patients undergo 3D-CRT": { + "value": "Patients undergo 3D-CRT" }, - "Patients receive chemoradiotherapy":{ - "value":"Patients receive chemoradiotherapy" + "Patients receive chemoradiotherapy": { + "value": "Patients receive chemoradiotherapy" } } }, { - "in":"query", - "name":"arms.interventions.name", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "arms.interventions.name", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Ibrutinib":{ - "value":"Ibrutinib" + "Ibrutinib": { + "value": "Ibrutinib" }, - "Carmustine":{ - "value":"Carmustine" + "Carmustine": { + "value": "Carmustine" }, - "Etoposide":{ - "value":"Etoposide" + "Etoposide": { + "value": "Etoposide" }, - "Cytarabine":{ - "value":"Cytarabine" + "Cytarabine": { + "value": "Cytarabine" }, - "Melphalan":{ - "value":"Melphalan" + "Melphalan": { + "value": "Melphalan" }, - "Pharmacogenomic Study":{ - "value":"Pharmacogenomic Study" + "Pharmacogenomic Study": { + "value": "Pharmacogenomic Study" } } }, { - "in":"query", - "name":"arms.interventions.type", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "arms.interventions.type", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Drug":{ - "value":"Drug" + "Drug": { + "value": "Drug" }, - "Procedure / Surgery":{ - "value":"Procedure / Surgery" + "Procedure / Surgery": { + "value": "Procedure / Surgery" }, - "Other":{ - "value":"Other" + "Other": { + "value": "Other" } } }, { - "in":"query", - "name":"arms.interventions.synonyms", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "arms.interventions.synonyms", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Imbruvica":{ - "value":"Imbruvica" + "Imbruvica": { + "value": "Imbruvica" }, - "Lastet":{ - "value":"Lastet" + "Lastet": { + "value": "Lastet" }, - "Melphalanum":{ - "value":"Melphalanum" + "Melphalanum": { + "value": "Melphalanum" }, - "Anti-Tumor Agents":{ - "value":"Anti-Tumor Agents" + "Anti-Tumor Agents": { + "value": "Anti-Tumor Agents" }, - "Anti-Cancer Agents":{ - "value":"Anti-Cancer Agents" + "Anti-Cancer Agents": { + "value": "Anti-Cancer Agents" }, - "Enzyme Antagonist":{ - "value":"Enzyme Antagonist" + "Enzyme Antagonist": { + "value": "Enzyme Antagonist" }, - "Immunosuppressive Agents":{ - "value":"Immunosuppressive Agents" + "Immunosuppressive Agents": { + "value": "Immunosuppressive Agents" } } }, { - "in":"query", - "name":"associated_studies.study_id", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "associated_studies.study_id", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "NCI-2015-00668":{ - "value":"NCI-2015-00668" + "NCI-2015-00668": { + "value": "NCI-2015-00668" }, - "NCI-2014-02057":{ - "value":"NCI-2014-02057" + "NCI-2014-02057": { + "value": "NCI-2014-02057" }, - "NCI-2017-01251":{ - "value":"NCI-2017-01251" + "NCI-2017-01251": { + "value": "NCI-2017-01251" } } }, { - "in":"query", - "name":"associated_studies.study_id_type", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "associated_studies.study_id_type", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "NCI":{ - "value":"NCI" + "NCI": { + "value": "NCI" } } }, { - "in":"query", - "name":"eligibility.structured.gender", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "eligibility.structured.gender", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "BOTH":{ - "value":"BOTH" + "BOTH": { + "value": "BOTH" }, - "FEMALE":{ - "value":"FEMALE" + "FEMALE": { + "value": "FEMALE" }, - "MALE":{ - "value":"MALE" + "MALE": { + "value": "MALE" } } }, { - "in":"query", - "name":"eligibility.structured.min_age_in_years_lte", - "description":"", - "required":false, - "schema":{ - "$ref":"#/components/schemas/integer_1_to_999" + "in": "query", + "name": "eligibility.structured.min_age_in_years_lte", + "description": "", + "required": false, + "schema": { + "$ref": "#/components/schemas/integer_1_to_999" } }, { - "in":"query", - "name":"eligibility.structured.min_age_in_years_gte", - "description":"", - "required":false, - "schema":{ - "$ref":"#/components/schemas/integer_1_to_999" + "in": "query", + "name": "eligibility.structured.min_age_in_years_gte", + "description": "", + "required": false, + "schema": { + "$ref": "#/components/schemas/integer_1_to_999" } }, { - "in":"query", - "name":"eligibility.structured.max_age_in_years_lte", - "description":"", - "required":false, - "schema":{ - "$ref":"#/components/schemas/integer_1_to_999" + "in": "query", + "name": "eligibility.structured.max_age_in_years_lte", + "description": "", + "required": false, + "schema": { + "$ref": "#/components/schemas/integer_1_to_999" } }, { - "in":"query", - "name":"eligibility.structured.max_age_in_years_gte", - "description":"", - "required":false, - "schema":{ - "$ref":"#/components/schemas/integer_1_to_999" + "in": "query", + "name": "eligibility.structured.max_age_in_years_gte", + "description": "", + "required": false, + "schema": { + "$ref": "#/components/schemas/integer_1_to_999" } }, { - "in":"query", - "name":"eligibility.structured.min_age_unit", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "eligibility.structured.min_age_unit", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Years":{ - "value":"Years" + "Years": { + "value": "Years" }, - "Months":{ - "value":"Months" + "Months": { + "value": "Months" } } }, { - "in":"query", - "name":"eligibility.structured.min_age_number_lte", - "description":"", - "required":false, - "schema":{ - "$ref":"#/components/schemas/integer_1_to_999" + "in": "query", + "name": "eligibility.structured.min_age_number_lte", + "description": "", + "required": false, + "schema": { + "$ref": "#/components/schemas/integer_1_to_999" } }, { - "in":"query", - "name":"eligibility.structured.min_age_number_gte", - "description":"", - "required":false, - "schema":{ - "$ref":"#/components/schemas/integer_1_to_999" + "in": "query", + "name": "eligibility.structured.min_age_number_gte", + "description": "", + "required": false, + "schema": { + "$ref": "#/components/schemas/integer_1_to_999" } }, { - "in":"query", - "name":"eligibility.structured.max_age_unit", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "eligibility.structured.max_age_unit", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Years":{ - "value":"Years" + "Years": { + "value": "Years" }, - "Months":{ - "value":"Months" + "Months": { + "value": "Months" } } }, { - "in":"query", - "name":"eligibility.structured.max_age_number_lte", - "description":"", - "required":false, - "schema":{ - "$ref":"#/components/schemas/integer_1_to_999" + "in": "query", + "name": "eligibility.structured.max_age_number_lte", + "description": "", + "required": false, + "schema": { + "$ref": "#/components/schemas/integer_1_to_999" } }, { - "in":"query", - "name":"eligibility.structured.max_age_number_gte", - "description":"", - "required":false, - "schema":{ - "$ref":"#/components/schemas/integer_1_to_999" + "in": "query", + "name": "eligibility.structured.max_age_number_gte", + "description": "", + "required": false, + "schema": { + "$ref": "#/components/schemas/integer_1_to_999" } }, { - "in":"query", - "name":"current_trial_status_date_lte", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "current_trial_status_date_lte", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "2020-11-18":{ - "value":"2020-11-18" + "2020-11-18": { + "value": "2020-11-18" }, - "2020-10-22":{ - "value":"2020-10-22" + "2020-10-22": { + "value": "2020-10-22" }, - "2019-08-15":{ - "value":"2019-08-15" + "2019-08-15": { + "value": "2019-08-15" }, - "2014-09-15":{ - "value":"2014-09-15" + "2014-09-15": { + "value": "2014-09-15" } } }, { - "in":"query", - "name":"current_trial_status_date_gte", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "current_trial_status_date_gte", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "2020-11-18":{ - "value":"2020-11-18" + "2020-11-18": { + "value": "2020-11-18" }, - "2020-10-22":{ - "value":"2020-10-22" + "2020-10-22": { + "value": "2020-10-22" }, - "2019-08-15":{ - "value":"2019-08-15" + "2019-08-15": { + "value": "2019-08-15" }, - "2014-09-15":{ - "value":"2014-09-15" + "2014-09-15": { + "value": "2014-09-15" } } }, { - "in":"query", - "name":"record_verification_date_lte", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "record_verification_date_lte", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "2020-11-18":{ - "value":"2020-11-18" + "2020-11-18": { + "value": "2020-11-18" }, - "2020-10-22":{ - "value":"2020-10-22" + "2020-10-22": { + "value": "2020-10-22" }, - "2019-08-15":{ - "value":"2019-08-15" + "2019-08-15": { + "value": "2019-08-15" }, - "2014-09-15":{ - "value":"2014-09-15" + "2014-09-15": { + "value": "2014-09-15" } } }, { - "in":"query", - "name":"record_verification_date_gte", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "record_verification_date_gte", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "2020-11-18":{ - "value":"2020-11-18" + "2020-11-18": { + "value": "2020-11-18" }, - "2020-10-22":{ - "value":"2020-10-22" + "2020-10-22": { + "value": "2020-10-22" }, - "2019-08-15":{ - "value":"2019-08-15" + "2019-08-15": { + "value": "2019-08-15" }, - "2014-09-15":{ - "value":"2014-09-15" + "2014-09-15": { + "value": "2014-09-15" } } }, { - "in":"query", - "name":"sites.org_coordinates_lat", - "description":"Organization's Latitude - for example: 43.7029. Geolocation Search only works to find sites in the United States.", - "required":false, - "schema":{ - "type":"number", - "minimum":-999, - "maximum":999 + "in": "query", + "name": "sites.org_coordinates_lat", + "description": "Organization's Latitude - for example: 43.7029. Geolocation Search only works to find sites in the United States.", + "required": false, + "schema": { + "type": "number", + "minimum": -999, + "maximum": 999 }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "43.7029":{ - "value":"43.7029" + "43.7029": { + "value": "43.7029" } } }, { - "in":"query", - "name":"sites.org_coordinates_lon", - "description":"Organization's Longitude - for example: -72.2895. Geolocation Search only works to find sites in the United States.", - "required":false, - "schema":{ - "type":"number", - "minimum":-999, - "maximum":999 + "in": "query", + "name": "sites.org_coordinates_lon", + "description": "Organization's Longitude - for example: -72.2895. Geolocation Search only works to find sites in the United States.", + "required": false, + "schema": { + "type": "number", + "minimum": -999, + "maximum": 999 }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "-72.2895":{ - "value":"-72.2895" + "-72.2895": { + "value": "-72.2895" } } }, { - "in":"query", - "name":"sites.org_coordinates_dist", - "description":"The radius around the provided zip code. Accepts these units of measurements [NM, nmi, nauticalmiles, mi, miles, yd, yards, ft, feet, in, inch, km, kilometers, cm, centimeters, mm, milimeters, m, meters]. If not provided defaults to 25mi.

Use of invalid postal codes, or non-US postal codes will return a 400 error.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_coordinates_dist", + "description": "The radius around the provided zip code. Accepts these units of measurements [NM, nmi, nauticalmiles, mi, miles, yd, yards, ft, feet, in, inch, km, kilometers, cm, centimeters, mm, milimeters, m, meters]. If not provided defaults to 25mi.

Use of invalid postal codes, or non-US postal codes will return a 400 error.", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"sites.contact_email", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.contact_email", + "description": "", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"sites.contact_name", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.contact_name", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Anthony John Jaslowski":{ - "value":"Anthony John Jaslowski" + "Anthony John Jaslowski": { + "value": "Anthony John Jaslowski" }, - "Dwight L. Fitch":{ - "value":"Dwight L. Fitch" + "Dwight L. Fitch": { + "value": "Dwight L. Fitch" }, - "Site Public Contact":{ - "value":"Site Public Contact" + "Site Public Contact": { + "value": "Site Public Contact" } } }, { - "in":"query", - "name":"sites.contact_name._auto", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.contact_name._auto", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Anthony John Jaslowski":{ - "value":"Anthony John Jaslowski" + "Anthony John Jaslowski": { + "value": "Anthony John Jaslowski" }, - "Dwight L. Fitch":{ - "value":"Dwight L. Fitch" + "Dwight L. Fitch": { + "value": "Dwight L. Fitch" }, - "Site Public Contact":{ - "value":"Site Public Contact" + "Site Public Contact": { + "value": "Site Public Contact" } } }, { - "in":"query", - "name":"sites.contact_name._raw", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.contact_name._raw", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Anthony John Jaslowski":{ - "value":"Anthony John Jaslowski" + "Anthony John Jaslowski": { + "value": "Anthony John Jaslowski" }, - "Dwight L. Fitch":{ - "value":"Dwight L. Fitch" + "Dwight L. Fitch": { + "value": "Dwight L. Fitch" }, - "Site Public Contact":{ - "value":"Site Public Contact" + "Site Public Contact": { + "value": "Site Public Contact" } } }, { - "in":"query", - "name":"sites.contact_phone", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.contact_phone", + "description": "", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"sites.org_address_line_1", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_address_line_1", + "description": "", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"sites.org_address_line_2", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_address_line_2", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Suite 100":{ - "value":"Suite 100" + "Suite 100": { + "value": "Suite 100" }, - "MIND Building Suite 110":{ - "value":"MIND Building Suite 110" + "MIND Building Suite 110": { + "value": "MIND Building Suite 110" }, - "MidOalkland Medical Center Suite 106":{ - "value":"MidOalkland Medical Center Suite 106" + "MidOalkland Medical Center Suite 106": { + "value": "MidOalkland Medical Center Suite 106" } } }, { - "in":"query", - "name":"sites.org_city", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_city", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Antwerpen":{ - "value":"Antwerpen" + "Antwerpen": { + "value": "Antwerpen" }, - "Aurora":{ - "value":"Aurora" + "Aurora": { + "value": "Aurora" }, - "Bern":{ - "value":"Bern" + "Bern": { + "value": "Bern" }, - "Montreal":{ - "value":"Montreal" + "Montreal": { + "value": "Montreal" }, - "Vienna":{ - "value":"Vienna" + "Vienna": { + "value": "Vienna" }, - "Villejuif":{ - "value":"Villejuif" + "Villejuif": { + "value": "Villejuif" }, - "Winnipeg":{ - "value":"Winnipeg" + "Winnipeg": { + "value": "Winnipeg" } } }, { - "in":"query", - "name":"sites.org_postal_code", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_postal_code", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Washington DC":{ - "value":"20470" + "Washington DC": { + "value": "20470" }, - "Bethesda Maryland":{ - "value":"20890" + "Bethesda Maryland": { + "value": "20890" }, - "Groningen Netherlands":{ - "value":"9700 GZ" + "Groningen Netherlands": { + "value": "9700 GZ" }, - "Montreal Canada":{ - "value":"H2L 4M1" + "Montreal Canada": { + "value": "H2L 4M1" }, - "Rockville Maryland":{ - "value":"20850-2062" + "Rockville Maryland": { + "value": "20850-2062" }, - "Aurora Colorado":{ - "value":"80012" + "Aurora Colorado": { + "value": "80012" } } }, { - "in":"query", - "name":"sites.org_state_or_province", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_state_or_province", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "AL - Alabama":{ - "value":"AL" + "AL - Alabama": { + "value": "AL" }, - "CA - California":{ - "value":"CA" + "CA - California": { + "value": "CA" }, - "CO - Colorado":{ - "value":"CO" + "CO - Colorado": { + "value": "CO" }, - "DC - District of Columbia":{ - "value":"DC" + "DC - District of Columbia": { + "value": "DC" }, - "FL - Florida":{ - "value":"FL" + "FL - Florida": { + "value": "FL" }, - "MD - Maryland":{ - "value":"MD" + "MD - Maryland": { + "value": "MD" }, - "NY - New York":{ - "value":"NY" + "NY - New York": { + "value": "NY" }, - "WI - Wisconsin":{ - "value":"WI" + "WI - Wisconsin": { + "value": "WI" }, - "Ontario":{ - "value":"Ontario" + "Ontario": { + "value": "Ontario" } } }, { - "in":"query", - "name":"sites.org_country", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_country", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Canada":{ - "value":"Canada" + "Canada": { + "value": "Canada" }, - "Italy":{ - "value":"Italy" + "Italy": { + "value": "Italy" }, - "Netherlands":{ - "value":"Netherlands" + "Netherlands": { + "value": "Netherlands" }, - "Switzerland":{ - "value":"Switzerland" + "Switzerland": { + "value": "Switzerland" }, - "United States":{ - "value":"United States" + "United States": { + "value": "United States" } } }, { - "in":"query", - "name":"sites.org_country._raw", - "description":"Country name (case sensitive)", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_country._raw", + "description": "Country name (case sensitive)", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Canada":{ - "value":"Canada" + "Canada": { + "value": "Canada" }, - "Italy":{ - "value":"Italy" + "Italy": { + "value": "Italy" }, - "Netherlands":{ - "value":"Netherlands" + "Netherlands": { + "value": "Netherlands" }, - "Switzerland":{ - "value":"Switzerland" + "Switzerland": { + "value": "Switzerland" }, - "United States":{ - "value":"United States" + "United States": { + "value": "United States" } } }, { - "in":"query", - "name":"sites.org_email", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_email", + "description": "", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"sites.org_family", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_family", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Mayo Clinic Cancer Center":{ - "value":"Mayo Clinic Cancer Center" + "Mayo Clinic Cancer Center": { + "value": "Mayo Clinic Cancer Center" }, - "Alvin J. Siteman Cancer Center":{ - "value":"Alvin J. Siteman Cancer Center" + "Alvin J. Siteman Cancer Center": { + "value": "Alvin J. Siteman Cancer Center" }, - "University of Chicago Comprehensive Cancer Center":{ - "value":"University of Chicago Comprehensive Cancer Center" + "University of Chicago Comprehensive Cancer Center": { + "value": "University of Chicago Comprehensive Cancer Center" }, - "MD Anderson Cancer Center":{ - "value":"MD Anderson Cancer Center" + "MD Anderson Cancer Center": { + "value": "MD Anderson Cancer Center" }, - "Roswell Park Cancer Institute":{ - "value":"Roswell Park Cancer Institute" + "Roswell Park Cancer Institute": { + "value": "Roswell Park Cancer Institute" }, - "Stanford Cancer Institute":{ - "value":"Stanford Cancer Institute" + "Stanford Cancer Institute": { + "value": "Stanford Cancer Institute" } } }, { - "in":"query", - "name":"sites.org_fax", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_fax", + "description": "", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"sites.org_name", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_name", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Alegemeen Ziekenhuis Middelheim, Antwerpen Belgium":{ - "value":"Alegemeen Ziekenhuis Middelheim" + "Alegemeen Ziekenhuis Middelheim, Antwerpen Belgium": { + "value": "Alegemeen Ziekenhuis Middelheim" }, - "Cancer Trials Support Unit, Rockville Maryland":{ - "value":"Cancer Trials Support Unit" + "Cancer Trials Support Unit, Rockville Maryland": { + "value": "Cancer Trials Support Unit" }, - "CancerCare Manitoba, Winnipeg Canada":{ - "value":"CancerCare Manitoba" + "CancerCare Manitoba, Winnipeg Canada": { + "value": "CancerCare Manitoba" }, - "Henry Ford Hospital, Detroit MI":{ - "value":"Henry Ford Hospital" + "Henry Ford Hospital, Detroit MI": { + "value": "Henry Ford Hospital" }, - "Centre Leon Berard, Lyon France":{ - "value":"Centre Leon Berard" + "Centre Leon Berard, Lyon France": { + "value": "Centre Leon Berard" } } }, { - "in":"query", - "name":"sites.org_name._auto", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_name._auto", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Alegemeen Ziekenhuis Middelheim, Antwerpen Belgium":{ - "value":"Alegemeen Ziekenhuis Middelheim" + "Alegemeen Ziekenhuis Middelheim, Antwerpen Belgium": { + "value": "Alegemeen Ziekenhuis Middelheim" }, - "Cancer Trials Support Unit, Rockville Maryland":{ - "value":"Cancer Trials Support Unit" + "Cancer Trials Support Unit, Rockville Maryland": { + "value": "Cancer Trials Support Unit" }, - "CancerCare Manitoba, Winnipeg Canada":{ - "value":"CancerCare Manitoba" + "CancerCare Manitoba, Winnipeg Canada": { + "value": "CancerCare Manitoba" }, - "Henry Ford Hospital, Detroit MI":{ - "value":"Henry Ford Hospital" + "Henry Ford Hospital, Detroit MI": { + "value": "Henry Ford Hospital" }, - "Centre Leon Berard, Lyon France":{ - "value":"Centre Leon Berard" + "Centre Leon Berard, Lyon France": { + "value": "Centre Leon Berard" } } }, { - "in":"query", - "name":"sites.org_name._raw", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_name._raw", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Alegemeen Ziekenhuis Middelheim, Antwerpen Belgium":{ - "value":"Alegemeen Ziekenhuis Middelheim" + "Alegemeen Ziekenhuis Middelheim, Antwerpen Belgium": { + "value": "Alegemeen Ziekenhuis Middelheim" }, - "Cancer Trials Support Unit, Rockville Maryland":{ - "value":"Cancer Trials Support Unit" + "Cancer Trials Support Unit, Rockville Maryland": { + "value": "Cancer Trials Support Unit" }, - "CancerCare Manitoba, Winnipeg Canada":{ - "value":"CancerCare Manitoba" + "CancerCare Manitoba, Winnipeg Canada": { + "value": "CancerCare Manitoba" }, - "Henry Ford Hospital, Detroit MI":{ - "value":"Henry Ford Hospital" + "Henry Ford Hospital, Detroit MI": { + "value": "Henry Ford Hospital" }, - "Centre Leon Berard, Lyon France":{ - "value":"Centre Leon Berard" + "Centre Leon Berard, Lyon France": { + "value": "Centre Leon Berard" } } }, { - "in":"query", - "name":"sites.org_phone", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.org_phone", + "description": "", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"sites.recruitment_status", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.recruitment_status", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "ACTIVE":{ - "value":"ACTIVE" + "ACTIVE": { + "value": "ACTIVE" }, - "INACTIVE":{ - "value":"INACTIVE" + "INACTIVE": { + "value": "INACTIVE" }, - "CLOSED_TO_ACCRUAL":{ - "value":"CLOSED_TO_ACCRUAL" + "CLOSED_TO_ACCRUAL": { + "value": "CLOSED_TO_ACCRUAL" }, - "TEMPORARILY_CLOSED_TO_ACCRUAL":{ - "value":"TEMPORARILY_CLOSED_TO_ACCRUAL" + "TEMPORARILY_CLOSED_TO_ACCRUAL": { + "value": "TEMPORARILY_CLOSED_TO_ACCRUAL" } } }, { - "in":"query", - "name":"sites.recruitment_status_date", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.recruitment_status_date", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "2020-11-18":{ - "value":"2020-11-18" + "2020-11-18": { + "value": "2020-11-18" }, - "2020-10-22":{ - "value":"2020-10-22" + "2020-10-22": { + "value": "2020-10-22" }, - "2019-08-15":{ - "value":"2019-08-15" + "2019-08-15": { + "value": "2019-08-15" }, - "2014-09-15":{ - "value":"2014-09-15" + "2014-09-15": { + "value": "2014-09-15" } } }, { - "in":"query", - "name":"sites.recruitment_status_date_lte", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.recruitment_status_date_lte", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "2020-11-18":{ - "value":"2020-11-18" + "2020-11-18": { + "value": "2020-11-18" }, - "2020-10-22":{ - "value":"2020-10-22" + "2020-10-22": { + "value": "2020-10-22" }, - "2019-08-15":{ - "value":"2019-08-15" + "2019-08-15": { + "value": "2019-08-15" }, - "2014-09-15":{ - "value":"2014-09-15" + "2014-09-15": { + "value": "2014-09-15" } } }, { - "in":"query", - "name":"sites.recruitment_status_date_gte", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sites.recruitment_status_date_gte", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "2020-11-18":{ - "value":"2020-11-18" + "2020-11-18": { + "value": "2020-11-18" }, - "2020-10-22":{ - "value":"2020-10-22" + "2020-10-22": { + "value": "2020-10-22" }, - "2019-08-15":{ - "value":"2019-08-15" + "2019-08-15": { + "value": "2019-08-15" }, - "2014-09-15":{ - "value":"2014-09-15" + "2014-09-15": { + "value": "2014-09-15" } } }, { - "$ref":"#/components/parameters/lead_org_cancer_center" + "$ref": "#/components/parameters/lead_org_cancer_center" } ], - "responses":{ - "200":{ - "description":"The list of results matching given search criteria.", + "responses": { + "200": { + "description": "The list of results matching given search criteria.", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TrialResponse" - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/TrialResponse" + } + } } }, - "400":{ - "description":"Bad Request." + "400": { + "description": "Bad Request." }, - "500":{ - "description":"An exception occurred at the backend." + "500": { + "description": "An exception occurred at the backend." }, - "502":{ - "description":"An exception occurred at the backend." + "502": { + "description": "An exception occurred at the backend." } } }, - "post":{ - "tags":[ + "post": { + "tags": [ "Trials" ], - "summary":"Search Trials by POST", - "security":[ + "summary": "Search Trials by POST", + "security": [ { - "ApiKeyAuth":[ - - ] + "ApiKeyAuth": [] } ], - "description":"

POST trials

Same as the GET endpoint, but allows you to craft a JSON body as the request.

Example:

curl -XPOST 'https://clinicaltrialsapi.cancer.gov/v2/trials' -H 'Content-Type: application/json' -d '{
\"sites.org_state_or_province\": [\"CA\", \"OR\"],
\"record_verification_date_gte\": \"2016-06-01\",
\"include\": [\"nci_id\"]
}'", - "operationId":"searchTrialsByPost", - "requestBody":{ - "description":"Query in JSON format", - "required":true, - "content":{ - "application/json":{ - "schema":{ - "type":"object" - }, - "examples":{ - "":{ - "value":"" + "description": "

POST trials

Same as the GET endpoint, but allows you to craft a JSON body as the request.

Example:

curl -XPOST 'https://clinicaltrialsapi.cancer.gov/v2/trials' -H 'Content-Type: application/json' -d '{
\"sites.org_state_or_province\": [\"CA\", \"OR\"],
\"record_verification_date_gte\": \"2016-06-01\",
\"include\": [\"nci_id\"]
}'", + "operationId": "searchTrialsByPost", + "requestBody": { + "description": "Query in JSON format", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "": { + "value": "" }, - "Organizations in CO or OR since 2016-06-01, show only nci_id and nct_id":{ - "value":{ - "sites.org_state_or_province":[ + "Organizations in CO or OR since 2016-06-01, show only nci_id and nct_id": { + "value": { + "sites.org_state_or_province": [ "CA", "OR" ], - "record_verification_date_gte":"2016-06-01", - "include":[ + "record_verification_date_gte": "2016-06-01", + "include": [ "nci_id", "nct_id" ] } }, - "equivalent of \"_trial_ids=OSU-14078\" from v1":{ - "value":{ - "keyword":"OSU-14078", - "keyword_field":[ + "equivalent of \"_trial_ids=OSU-14078\" from v1": { + "value": { + "keyword": "OSU-14078", + "keyword_field": [ "ccr_id", "ctep_id", "dcp_id", @@ -3170,7 +3390,7 @@ "other_ids.value", "protocol_id" ], - "include":[ + "include": [ "ccr_id", "ctep_id", "dcp_id", @@ -3181,14 +3401,14 @@ ] } }, - "Search for \"breast cancer\" in brief title or in lead_org":{ - "value":{ - "keyword":"breast cancer", - "keyword_field":[ + "Search for \"breast cancer\" in brief title or in lead_org": { + "value": { + "keyword": "breast cancer", + "keyword_field": [ "brief_title._fulltext", "lead_org._auto" ], - "include":[ + "include": [ "nci_id", "nct_id", "brief_title", @@ -3196,22 +3416,22 @@ ] } }, - "Export all trial information as json file":{ - "value":{ - "export":"true", - "export_type":"json", - "filename":"all_trials", - "email":"user@your-email.com" + "Export all trial information as json file": { + "value": { + "export": "true", + "export_type": "json", + "filename": "all_trials", + "email": "user@your-email.com" } }, - "Export nci_id, brief title, and lead organization information for all trials related to breast cancer as excel file":{ - "value":{ - "export":"true", - "export_type":"excel", - "filename":"breast_cancer_trials", - "email":"user@your-email.com", - "keyword":"breast cancer", - "include":[ + "Export nci_id, brief title, and lead organization information for all trials related to breast cancer as excel file": { + "value": { + "export": "true", + "export_type": "excel", + "filename": "breast_cancer_trials", + "email": "user@your-email.com", + "keyword": "breast cancer", + "include": [ "nci_id", "brief_title", "lead_org" @@ -3222,1564 +3442,1556 @@ } } }, - "responses":{ - "200":{ - "description":"The list of results matching given search criteria.", + "responses": { + "200": { + "description": "The list of results matching given search criteria.", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TrialResponse" - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/TrialResponse" + } + } } }, - "400":{ - "description":"Bad Request." + "400": { + "description": "Bad Request." }, - "500":{ - "description":"Exception occurred at the backend (except EntityNotFoundException)." + "500": { + "description": "Exception occurred at the backend (except EntityNotFoundException)." }, - "502":{ - "description":"An exception occurred at the backend." + "502": { + "description": "An exception occurred at the backend." } } } }, - "/interventions":{ - "get":{ - "tags":[ + "/interventions": { + "get": { + "tags": [ "Interventions" ], - "summary":"Search Interventions by GET", - "security":[ + "summary": "Search Interventions by GET", + "security": [ { - "ApiKeyAuth":[ - - ] + "ApiKeyAuth": [] } ], - "description":"

GET interventions?<filter_params>

The interventions endpoint is intended for typeaheads and other use cases where it is necessary to search for available interventions which can later be used to filter clinical trial results. Interventions are matched partially by supplying a string to the name field and may be filtered by other fields through parameters described below. Results are sorted by a combination of in alphabetical order by default i.e sort is set to name and order is set to asc.

Example interventions?category=agent%20category&name=Therapeutic

Progressive Filtering functionality: All trial fields parameters described at the /trials endpoint are usable here to filter the trials from which you want to aggregate. For example, if you request /interventions?maintype=C4872 this will give you all interventions that are in trials where Breast Cancer(C4872) is among the diseases in each trial. Note that maintype is a trials endpoint parameter related to diseases.nci_thesaurus_concept_id.

When searching in the interventions Endpoint with multiple values for the following parameters (codes, category, type), API will treat values as an OR condition and will return data that contains one or the other that is being searched.

Examples

  • codes=C78203&codes=C141136, API will return codes = C78203 OR codes = C141136
  • category=agent&category=agent%20category&&category=other, API will return category = agent OR category = agent category OR category = other
  • type=drug&type=genetic, API will return type = drug OR type = genetic

codes and code parameters will be used interchangeably within CTS API V2

", - "operationId":"searchInterventionsByGet", - "parameters":[ - { - "in":"query", - "name":"name", - "description":"Note that name checks for values assigned to name as well as values assigned to synonyms.", - "required":false, - "schema":{ - "type":"string" + "description": "

GET interventions?<filter_params>

The interventions endpoint is intended for typeaheads and other use cases where it is necessary to search for available interventions which can later be used to filter clinical trial results. Interventions are matched partially by supplying a string to the name field and may be filtered by other fields through parameters described below. Results are sorted by a combination of in alphabetical order by default i.e sort is set to name and order is set to asc.

Example interventions?category=agent%20category&name=Therapeutic

Progressive Filtering functionality: All trial fields parameters described at the /trials endpoint are usable here to filter the trials from which you want to aggregate. For example, if you request /interventions?maintype=C4872 this will give you all interventions that are in trials where Breast Cancer(C4872) is among the diseases in each trial. Note that maintype is a trials endpoint parameter related to diseases.nci_thesaurus_concept_id.

When searching in the interventions Endpoint with multiple values for the following parameters (codes, category, type), API will treat values as an OR condition and will return data that contains one or the other that is being searched.

Examples

  • codes=C78203&codes=C141136, API will return codes = C78203 OR codes = C141136
  • category=agent&category=agent%20category&&category=other, API will return category = agent OR category = agent category OR category = other
  • type=drug&type=genetic, API will return type = drug OR type = genetic

codes and code parameters will be used interchangeably within CTS API V2

", + "operationId": "searchInterventionsByGet", + "parameters": [ + { + "in": "query", + "name": "name", + "description": "Note that name checks for values assigned to name as well as values assigned to synonyms.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "D-Glucose-1,2-13C2":{ - "value":"D-Glucose-1,2-13C2" + "D-Glucose-1,2-13C2": { + "value": "D-Glucose-1,2-13C2" }, - "Carcinoma":{ - "value":"Carcinoma" + "Carcinoma": { + "value": "Carcinoma" }, - "Acute Lymphoblastic Leukemia in Remission":{ - "value":"Acute Lymphoblastic Leukemia in Remission" + "Acute Lymphoblastic Leukemia in Remission": { + "value": "Acute Lymphoblastic Leukemia in Remission" }, - "Cutaneous Mastocytosis":{ - "value":"Cutaneous Mastocytosis" + "Cutaneous Mastocytosis": { + "value": "Cutaneous Mastocytosis" }, - "Cutaneous Angiosarcoma":{ - "value":"Cutaneous Angiosarcoma" + "Cutaneous Angiosarcoma": { + "value": "Cutaneous Angiosarcoma" }, - "1,2-Carbon C 13-labeled Glucose":{ - "value":"1,2-Carbon C 13-labeled Glucose" + "1,2-Carbon C 13-labeled Glucose": { + "value": "1,2-Carbon C 13-labeled Glucose" }, - "Monoclonal Antibody":{ - "value":"Monoclonal Antibody" + "Monoclonal Antibody": { + "value": "Monoclonal Antibody" }, - "Antineoplastic Antibody":{ - "value":"Antineoplastic Antibody" + "Antineoplastic Antibody": { + "value": "Antineoplastic Antibody" }, - "Baltaleucel":{ - "value":"Baltaleucel" + "Baltaleucel": { + "value": "Baltaleucel" }, - "Basiliximab":{ - "value":"Basiliximab" + "Basiliximab": { + "value": "Basiliximab" }, - "Cancer Vaccine":{ - "value":"Cancer Vaccine" + "Cancer Vaccine": { + "value": "Cancer Vaccine" }, - "Chemoradiotherapy":{ - "value":"Chemoradiotherapy" + "Chemoradiotherapy": { + "value": "Chemoradiotherapy" }, - "Computer-Assisted":{ - "value":"Computer-Assisted" + "Computer-Assisted": { + "value": "Computer-Assisted" }, - "Computer-Assisted Smoking Cessation Intervention":{ - "value":"Computer-Assisted Smoking Cessation Intervention" + "Computer-Assisted Smoking Cessation Intervention": { + "value": "Computer-Assisted Smoking Cessation Intervention" }, - "Diary":{ - "value":"Diary" + "Diary": { + "value": "Diary" }, - "EGFR":{ - "value":"EGFR" + "EGFR": { + "value": "EGFR" }, - "EGFR-targeting Agent":{ - "value":"EGFR-targeting Agent" + "EGFR-targeting Agent": { + "value": "EGFR-targeting Agent" }, - "Flaxseed":{ - "value":"Flaxseed" + "Flaxseed": { + "value": "Flaxseed" }, - "Gemcitabine":{ - "value":"Gemcitabine" + "Gemcitabine": { + "value": "Gemcitabine" }, - "Intubation":{ - "value":"Intubation" + "Intubation": { + "value": "Intubation" }, - "Music Therapy":{ - "value":"Music Therapy" + "Music Therapy": { + "value": "Music Therapy" }, - "PDGFR":{ - "value":"PDGFR" + "PDGFR": { + "value": "PDGFR" }, - "Polyvalent":{ - "value":"Polyvalent" + "Polyvalent": { + "value": "Polyvalent" }, - "Psychosocial":{ - "value":"Psychosocial" + "Psychosocial": { + "value": "Psychosocial" }, - "Scale":{ - "value":"Scale" + "Scale": { + "value": "Scale" }, - "Smoking":{ - "value":"Smoking" + "Smoking": { + "value": "Smoking" }, - "Study":{ - "value":"Study" + "Study": { + "value": "Study" }, - "Thalidomide":{ - "value":"Thalidomide" + "Thalidomide": { + "value": "Thalidomide" }, - "Vaccin":{ - "value":"Vaccin" + "Vaccin": { + "value": "Vaccin" }, - "Zalifrelimab":{ - "value":"Zalifrelimab" + "Zalifrelimab": { + "value": "Zalifrelimab" } } }, { - "in":"query", - "name":"category", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "category", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "none":{ - "value":"none" + "none": { + "value": "none" }, - "agent":{ - "value":"agent" + "agent": { + "value": "agent" }, - "agent category":{ - "value":"agent category" + "agent category": { + "value": "agent category" }, - "other":{ - "value":"other" + "other": { + "value": "other" } } }, { - "in":"query", - "name":"type", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "type", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "behavioral":{ - "value":"behavioral" + "behavioral": { + "value": "behavioral" }, - "biological":{ - "value":"biological" + "biological": { + "value": "biological" }, - "biological/vaccine":{ - "value":"biological/vaccine" + "biological/vaccine": { + "value": "biological/vaccine" }, - "drug":{ - "value":"drug" + "drug": { + "value": "drug" }, - "genetic":{ - "value":"genetic" + "genetic": { + "value": "genetic" }, - "procedure":{ - "value":"procedure" + "procedure": { + "value": "procedure" }, - "procedure/surgery":{ - "value":"procedure/surgery" + "procedure/surgery": { + "value": "procedure/surgery" }, - "radiation":{ - "value":"radiation" + "radiation": { + "value": "radiation" }, - "surgery":{ - "value":"surgery" + "surgery": { + "value": "surgery" }, - "vaccine":{ - "value":"vaccine" + "vaccine": { + "value": "vaccine" }, - "other":{ - "value":"other" + "other": { + "value": "other" } } }, { - "in":"query", - "name":"codes", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "codes", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "C82414":{ - "value":"C82414" + "C82414": { + "value": "C82414" }, - "C171257":{ - "value":"C171257" + "C171257": { + "value": "C171257" }, - "C129967":{ - "value":"C129967" + "C129967": { + "value": "C129967" }, - "C17934":{ - "value":"C17934" + "C17934": { + "value": "C17934" }, - "C124648":{ - "value":"C124648" + "C124648": { + "value": "C124648" }, - "C94726":{ - "value":"C94726" + "C94726": { + "value": "C94726" }, - "C274":{ - "value":"C274" + "C274": { + "value": "C274" }, - "C130058":{ - "value":"C130058" + "C130058": { + "value": "C130058" }, - "C62533":{ - "value":"C62533" + "C62533": { + "value": "C62533" }, - "C3588":{ - "value":"C3588" + "C3588": { + "value": "C3588" }, - "C3211":{ - "value":"C3211" + "C3211": { + "value": "C3211" }, - "C3208":{ - "value":"C3208" + "C3208": { + "value": "C3208" }, - "C131085":{ - "value":"C131085" + "C131085": { + "value": "C131085" }, - "C27134":{ - "value":"C27134" + "C27134": { + "value": "C27134" }, - "C27859":{ - "value":"C27859" + "C27859": { + "value": "C27859" } } }, { - "in":"query", - "name":"include", - "description":"Include only this field(s) in trials and exclude others. Use multiple times to include multiple fields. (Useful if you want to minimize the payload returned)", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "include", + "description": "Include only this field(s) in trials and exclude others. Use multiple times to include multiple fields. (Useful if you want to minimize the payload returned)", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "all fields":{ - "value":"" + "examples": { + "all fields": { + "value": "" }, - "no data; just get the count":{ - "value":"none" + "no data; just get the count": { + "value": "none" }, - "name":{ - "value":"name" + "name": { + "value": "name" }, - "category":{ - "value":"category" + "category": { + "value": "category" }, - "codes":{ - "value":"codes" + "codes": { + "value": "codes" }, - "type":{ - "value":"type" + "type": { + "value": "type" }, - "synonyms":{ - "value":"synonyms" + "synonyms": { + "value": "synonyms" }, - "count":{ - "value":"count" + "count": { + "value": "count" } } }, { - "in":"query", - "name":"sort", - "description":"Default set to 'name'. Currently works only for name and count.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sort", + "description": "Default set to 'name'. Currently works only for name and count.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "use default":{ - "value":"" + "examples": { + "use default": { + "value": "" }, - "name":{ - "value":"name" + "name": { + "value": "name" }, - "count":{ - "value":"count" + "count": { + "value": "count" }, - "category (Not available. Will result in 400 response code)":{ - "value":"category" + "category (Not available. Will result in 400 response code)": { + "value": "category" }, - "code (Not available. Will result in 400 response code)":{ - "value":"code" + "code (Not available. Will result in 400 response code)": { + "value": "code" }, - "type (Not available. Will result in 400 response code)":{ - "value":"type" + "type (Not available. Will result in 400 response code)": { + "value": "type" }, - "parent_ids (Not available. Will result in 400 response code)":{ - "value":"parent_ids" + "parent_ids (Not available. Will result in 400 response code)": { + "value": "parent_ids" } } }, { - "$ref":"#/components/parameters/order" + "$ref": "#/components/parameters/order" }, { - "$ref":"#/components/parameters/size" + "$ref": "#/components/parameters/size" } ], - "responses":{ - "200":{ - "description":"The list matching given search criteria." + "responses": { + "200": { + "description": "The list matching given search criteria." }, - "400":{ - "description":"Bad Request." + "400": { + "description": "Bad Request." }, - "500":{ - "description":"An exception occurred at the backend." + "500": { + "description": "An exception occurred at the backend." }, - "502":{ - "description":"An exception occurred at the backend." + "502": { + "description": "An exception occurred at the backend." } } } }, - "/diseases":{ - "get":{ - "tags":[ + "/diseases": { + "get": { + "tags": [ "Diseases" ], - "summary":"Search Diseases by GET", - "security":[ + "summary": "Search Diseases by GET", + "security": [ { - "ApiKeyAuth":[ - - ] + "ApiKeyAuth": [] } ], - "description":"

GET diseases?<filter_params>

The diseases endpoint is intended for typeaheads and other use cases where it is necessary to search for available diseases which can later be used to filter clinical trial results. Diseases are matched partially by supplying a string to the name field and may be filtered by other fields through parameters described below. Results are sorted by a combination of in alphabetical order by default i.e sort is set to name and order is set to asc.

Example: diseases?type_not=subtype&type=maintype&name=He

Progressive Filtering functionality: All trial fields parameters described at the /trials endpoint are usable here to filter the trials from which you want to aggregate. For example, if you request /diseases?maintype=C4872 this will give you all diseases that are in trials where Breast Cancer(C4872) is among the diseases in each trial. Note that maintype is a trials endpoint parameter related to diseases.nci_thesaurus_concept_id.

When searching in the Diseases Endpoint with multiple values for the following parameters (codes, ancestor_ids, parent_ids, type), API will treat values as an OR condition and will return data that satisfies at least one of the condition being searched.

Examples
  • codes=C8285&codes=C8286, API will return codes = C8285 OR codes = C8286.
  • ancestor_ids=C4878&ancestor_ids=C4912, API will return ancestor_id = C4878 OR ancestor_ids = C4912.
  • parent_ids=C9039&parent_ids=C3099, API will return parent_ids = C9039 OR parent_ids = C3099.
  • type=maintype&type=subtype, API will return type = maintype OR type = subtype

codes and code parameters will be used interchangeably within CTS API V2

", - "operationId":"searchDiseasesByGet", - "parameters":[ - { - "in":"query", - "name":"name", - "description":"Note that name checks for values assigned to name as well as values assigned to synonyms.", - "required":false, - "schema":{ - "type":"string" + "description": "

GET diseases?<filter_params>

The diseases endpoint is intended for typeaheads and other use cases where it is necessary to search for available diseases which can later be used to filter clinical trial results. Diseases are matched partially by supplying a string to the name field and may be filtered by other fields through parameters described below. Results are sorted by a combination of in alphabetical order by default i.e sort is set to name and order is set to asc.

Example: diseases?type_not=subtype&type=maintype&name=He

Progressive Filtering functionality: All trial fields parameters described at the /trials endpoint are usable here to filter the trials from which you want to aggregate. For example, if you request /diseases?maintype=C4872 this will give you all diseases that are in trials where Breast Cancer(C4872) is among the diseases in each trial. Note that maintype is a trials endpoint parameter related to diseases.nci_thesaurus_concept_id.

When searching in the Diseases Endpoint with multiple values for the following parameters (codes, ancestor_ids, parent_ids, type), API will treat values as an OR condition and will return data that satisfies at least one of the condition being searched.

Examples
  • codes=C8285&codes=C8286, API will return codes = C8285 OR codes = C8286.
  • ancestor_ids=C4878&ancestor_ids=C4912, API will return ancestor_id = C4878 OR ancestor_ids = C4912.
  • parent_ids=C9039&parent_ids=C3099, API will return parent_ids = C9039 OR parent_ids = C3099.
  • type=maintype&type=subtype, API will return type = maintype OR type = subtype

codes and code parameters will be used interchangeably within CTS API V2

", + "operationId": "searchDiseasesByGet", + "parameters": [ + { + "in": "query", + "name": "name", + "description": "Note that name checks for values assigned to name as well as values assigned to synonyms.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Myeloid Leukemia":{ - "value":"Myeloid Leukemia" + "Myeloid Leukemia": { + "value": "Myeloid Leukemia" }, - "Carcinoma":{ - "value":"Carcinoma" + "Carcinoma": { + "value": "Carcinoma" }, - "Acute Lymphoblastic Leukemia in Remission":{ - "value":"Acute Lymphoblastic Leukemia in Remission" + "Acute Lymphoblastic Leukemia in Remission": { + "value": "Acute Lymphoblastic Leukemia in Remission" }, - "Cutaneous Mastocytosis":{ - "value":"Cutaneous Mastocytosis" + "Cutaneous Mastocytosis": { + "value": "Cutaneous Mastocytosis" }, - "Cutaneous Angiosarcoma":{ - "value":"Cutaneous Angiosarcoma" + "Cutaneous Angiosarcoma": { + "value": "Cutaneous Angiosarcoma" } } }, { - "in":"query", - "name":"type", - "description":"Type of Disease - Note that multiple values for type creates an 'OR' condition for the result set. Results will meet one of the type values requested. Use 'type' and 'type_not' together to further filter results.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "type", + "description": "Type of Disease - Note that multiple values for type creates an 'OR' condition for the result set. Results will meet one of the type values requested. Use 'type' and 'type_not' together to further filter results.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "finding":{ - "value":"finding" + "finding": { + "value": "finding" }, - "maintype":{ - "value":"maintype" + "maintype": { + "value": "maintype" }, - "subtype":{ - "value":"subtype" + "subtype": { + "value": "subtype" }, - "stage":{ - "value":"stage" + "stage": { + "value": "stage" }, - "grade":{ - "value":"grade" + "grade": { + "value": "grade" } } }, { - "in":"query", - "name":"type_not", - "description":"This will do the opposite of 'type' above and exclude rather than include. Note that multiple values for type creates an 'AND' condition for the result set. Results will meet all menu_not values requested. Use 'type' and 'type_not' together to further filter results.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "type_not", + "description": "This will do the opposite of 'type' above and exclude rather than include. Note that multiple values for type creates an 'AND' condition for the result set. Results will meet all menu_not values requested. Use 'type' and 'type_not' together to further filter results.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "finding":{ - "value":"finding" + "finding": { + "value": "finding" }, - "maintype":{ - "value":"maintype" + "maintype": { + "value": "maintype" }, - "subtype":{ - "value":"subtype" + "subtype": { + "value": "subtype" }, - "stage":{ - "value":"stage" + "stage": { + "value": "stage" }, - "grade":{ - "value":"grade" + "grade": { + "value": "grade" } } }, { - "in":"query", - "name":"parent_ids", - "description":"Setting the parent_id value will get you a direct child along a disease path.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "parent_ids", + "description": "Setting the parent_id value will get you a direct child along a disease path.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "C3211":{ - "value":"C3211" + "C3211": { + "value": "C3211" }, - "C3208":{ - "value":"C3208" + "C3208": { + "value": "C3208" }, - "C3172":{ - "value":"C3208" + "C3172": { + "value": "C3208" }, - "C27134":{ - "value":"C27134" + "C27134": { + "value": "C27134" }, - "C27859":{ - "value":"C27859" + "C27859": { + "value": "C27859" } } }, { - "in":"query", - "name":"ancestor_ids", - "description":"Setting an ancestor_ids value will get you any of the children along a disease path.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "ancestor_ids", + "description": "Setting an ancestor_ids value will get you any of the children along a disease path.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "C3211":{ - "value":"C3211" + "C3211": { + "value": "C3211" }, - "C3208":{ - "value":"C3208" + "C3208": { + "value": "C3208" }, - "C3172":{ - "value":"C3172" + "C3172": { + "value": "C3172" }, - "C27134":{ - "value":"C27134" + "C27134": { + "value": "C27134" }, - "C27859":{ - "value":"C27859" + "C27859": { + "value": "C27859" } } }, { - "in":"query", - "name":"codes", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "codes", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "C5192":{ - "value":"C5192" + "C5192": { + "value": "C5192" }, - "C3588":{ - "value":"C3588" + "C3588": { + "value": "C3588" }, - "C3211":{ - "value":"C3211" + "C3211": { + "value": "C3211" }, - "C3208":{ - "value":"C3208" + "C3208": { + "value": "C3208" }, - "C131085":{ - "value":"C131085" + "C131085": { + "value": "C131085" }, - "C27134":{ - "value":"C27134" + "C27134": { + "value": "C27134" }, - "C27859":{ - "value":"C27859" + "C27859": { + "value": "C27859" } } }, { - "in":"query", - "name":"include", - "description":"Include only this field(s) in trials and exclude others. Use multiple times to include multiple fields. (Useful if you want to minimize the payload returned)", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "include", + "description": "Include only this field(s) in trials and exclude others. Use multiple times to include multiple fields. (Useful if you want to minimize the payload returned)", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "all fields":{ - "value":"" + "examples": { + "all fields": { + "value": "" }, - "no data; just get the count":{ - "value":"none" + "no data; just get the count": { + "value": "none" }, - "name":{ - "value":"name" + "name": { + "value": "name" }, - "code":{ - "value":"code" + "code": { + "value": "code" }, - "codes":{ - "value":"codes" + "codes": { + "value": "codes" }, - "type":{ - "value":"type" + "type": { + "value": "type" }, - "parent_ids":{ - "value":"parent_ids" + "parent_ids": { + "value": "parent_ids" }, - "ancestor_ids":{ - "value":"ancestor_ids" + "ancestor_ids": { + "value": "ancestor_ids" }, - "synonym":{ - "value":"synonym" + "synonym": { + "value": "synonym" }, - "synonyms":{ - "value":"synonyms" + "synonyms": { + "value": "synonyms" }, - "count":{ - "value":"count" + "count": { + "value": "count" } } }, { - "in":"query", - "name":"sort", - "description":"Default set to 'name'. Currently works only for name and count.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sort", + "description": "Default set to 'name'. Currently works only for name and count.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "use default":{ - "value":"" + "examples": { + "use default": { + "value": "" }, - "name":{ - "value":"name" + "name": { + "value": "name" }, - "count":{ - "value":"count" + "count": { + "value": "count" }, - "code (Not available. Will result in 400 response code)":{ - "value":"code" + "code (Not available. Will result in 400 response code)": { + "value": "code" }, - "type (Not available. Will result in 400 response code)":{ - "value":"type" + "type (Not available. Will result in 400 response code)": { + "value": "type" }, - "parent_ids (Not available. Will result in 400 response code)":{ - "value":"parent_ids" + "parent_ids (Not available. Will result in 400 response code)": { + "value": "parent_ids" } } }, { - "$ref":"#/components/parameters/order" + "$ref": "#/components/parameters/order" }, { - "$ref":"#/components/parameters/size" + "$ref": "#/components/parameters/size" } ], - "responses":{ - "200":{ - "description":"The list matching given search criteria." + "responses": { + "200": { + "description": "The list matching given search criteria." }, - "400":{ - "description":"Bad Request." + "400": { + "description": "Bad Request." }, - "500":{ - "description":"An exception occurred at the backend." + "500": { + "description": "An exception occurred at the backend." }, - "502":{ - "description":"An exception occurred at the backend." + "502": { + "description": "An exception occurred at the backend." } } } }, - "/organizations":{ - "get":{ - "tags":[ + "/organizations": { + "get": { + "tags": [ "Organizations" ], - "summary":"Search Organizations by GET", - "security":[ + "summary": "Search Organizations by GET", + "security": [ { - "ApiKeyAuth":[ - - ] + "ApiKeyAuth": [] } ], - "description":"

GET organizations?<filter_params>

The organizations endpoint is intended for typeaheads and other use cases where it is necessary to search for available organizations which can later be used to filter clinical trial results. Organizations are matched partially by supplying a string to the name field and may be filtered by other fields through parameters described below. Results are sorted by a combination of in alphabetical order by default i.e sort is set to name and order is set to asc.

Example: organizations?org_city=Las Vegas&org_country=United States&name=University

Progressive Filtering functionality: All trial fields parameters described at the /trials endpoint are usable here to filter the trials from which you want to aggregate. For example, if you request /organizations?maintype=C4872 this will give you all organizations that are in trials where Breast Cancer(C4872) is among the diseases in each trial. Note that maintype is a trials endpoint parameter related to diseases.nci_thesaurus_concept_id.

", - "operationId":"searchOrganizationsByGet", - "parameters":[ - { - "in":"query", - "name":"name", - "description":"", - "required":false, - "schema":{ - "type":"string" + "description": "

GET organizations?<filter_params>

The organizations endpoint is intended for typeaheads and other use cases where it is necessary to search for available organizations which can later be used to filter clinical trial results. Organizations are matched partially by supplying a string to the name field and may be filtered by other fields through parameters described below. Results are sorted by a combination of in alphabetical order by default i.e sort is set to name and order is set to asc.

Example: organizations?org_city=Las Vegas&org_country=United States&name=University

Progressive Filtering functionality: All trial fields parameters described at the /trials endpoint are usable here to filter the trials from which you want to aggregate. For example, if you request /organizations?maintype=C4872 this will give you all organizations that are in trials where Breast Cancer(C4872) is among the diseases in each trial. Note that maintype is a trials endpoint parameter related to diseases.nci_thesaurus_concept_id.

", + "operationId": "searchOrganizationsByGet", + "parameters": [ + { + "in": "query", + "name": "name", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Alegemeen Ziekenhuis Middelheim, Antwerpen Belgium":{ - "value":"Alegemeen Ziekenhuis Middelheim" + "Alegemeen Ziekenhuis Middelheim, Antwerpen Belgium": { + "value": "Alegemeen Ziekenhuis Middelheim" }, - "Cancer Trials Support Unit, Rockville Maryland":{ - "value":"Cancer Trials Support Unit" + "Cancer Trials Support Unit, Rockville Maryland": { + "value": "Cancer Trials Support Unit" }, - "CancerCare Manitoba, Winnipeg Canada":{ - "value":"CancerCare Manitoba" + "CancerCare Manitoba, Winnipeg Canada": { + "value": "CancerCare Manitoba" }, - "Henry Ford Hospital, Detroit MI":{ - "value":"Henry Ford Hospital" + "Henry Ford Hospital, Detroit MI": { + "value": "Henry Ford Hospital" }, - "Centre Leon Berard, Lyon France":{ - "value":"Centre Leon Berard" + "Centre Leon Berard, Lyon France": { + "value": "Centre Leon Berard" } } }, { - "in":"query", - "name":"contact_name", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "contact_name", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Anthony John Jaslowski":{ - "value":"Anthony John Jaslowski" + "Anthony John Jaslowski": { + "value": "Anthony John Jaslowski" }, - "Dwight L. Fitch":{ - "value":"Dwight L. Fitch" + "Dwight L. Fitch": { + "value": "Dwight L. Fitch" }, - "Site Public Contact":{ - "value":"Site Public Contact" + "Site Public Contact": { + "value": "Site Public Contact" } } }, { - "in":"query", - "name":"contact_email", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "contact_email", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "info@westernstatesncorp.org":{ - "value":"info@westernstatesncorp.org" + "info@westernstatesncorp.org": { + "value": "info@westernstatesncorp.org" }, - "clinical.trials@daytonncorp.org":{ - "value":"clinical.trials@daytonncorp.org" + "clinical.trials@daytonncorp.org": { + "value": "clinical.trials@daytonncorp.org" } } }, { - "in":"query", - "name":"contact_phone", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "contact_phone", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "800-398-3996":{ - "value":"800-398-3996" + "800-398-3996": { + "value": "800-398-3996" }, - "626-564-3455":{ - "value":"626-564-3455" + "626-564-3455": { + "value": "626-564-3455" }, - "800-611-1811":{ - "value":"800-611-1811" + "800-611-1811": { + "value": "800-611-1811" } } }, { - "in":"query", - "name":"org_address_line_1", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_address_line_1", + "description": "", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"org_address_line_2", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_address_line_2", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Suite 100":{ - "value":"Suite 100" + "Suite 100": { + "value": "Suite 100" }, - "MIND Building Suite 110":{ - "value":"MIND Building Suite 110" + "MIND Building Suite 110": { + "value": "MIND Building Suite 110" }, - "MidOalkland Medical Center Suite 106":{ - "value":"MidOalkland Medical Center Suite 106" + "MidOalkland Medical Center Suite 106": { + "value": "MidOalkland Medical Center Suite 106" } } }, { - "in":"query", - "name":"org_city", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_city", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Antwerpen":{ - "value":"Antwerpen" + "Antwerpen": { + "value": "Antwerpen" }, - "Aurora":{ - "value":"Aurora" + "Aurora": { + "value": "Aurora" }, - "Bern":{ - "value":"Bern" + "Bern": { + "value": "Bern" }, - "Montreal":{ - "value":"Montreal" + "Montreal": { + "value": "Montreal" }, - "Vienna":{ - "value":"Vienna" + "Vienna": { + "value": "Vienna" }, - "Villejuif":{ - "value":"Villejuif" + "Villejuif": { + "value": "Villejuif" }, - "Winnipeg":{ - "value":"Winnipeg" + "Winnipeg": { + "value": "Winnipeg" } } }, { - "in":"query", - "name":"org_country", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_country", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Canada":{ - "value":"Canada" + "Canada": { + "value": "Canada" }, - "Italy":{ - "value":"Italy" + "Italy": { + "value": "Italy" }, - "Netherlands":{ - "value":"Netherlands" + "Netherlands": { + "value": "Netherlands" }, - "Switzerland":{ - "value":"Switzerland" + "Switzerland": { + "value": "Switzerland" }, - "United States":{ - "value":"United States" + "United States": { + "value": "United States" } } }, { - "in":"query", - "name":"org_email", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_email", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "info@westernstatesncorp.org":{ - "value":"info@westernstatesncorp.org" + "info@westernstatesncorp.org": { + "value": "info@westernstatesncorp.org" }, - "clinical.trials@daytonncorp.org":{ - "value":"clinical.trials@daytonncorp.org" + "clinical.trials@daytonncorp.org": { + "value": "clinical.trials@daytonncorp.org" } } }, { - "in":"query", - "name":"org_phone", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_phone", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "800-398-3996":{ - "value":"800-398-3996" + "800-398-3996": { + "value": "800-398-3996" }, - "626-564-3455":{ - "value":"626-564-3455" + "626-564-3455": { + "value": "626-564-3455" }, - "800-611-1811":{ - "value":"800-611-1811" + "800-611-1811": { + "value": "800-611-1811" } } }, { - "in":"query", - "name":"org_fax", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_fax", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "317-831-9292":{ - "value":"317-831-9292" + "317-831-9292": { + "value": "317-831-9292" } } }, { - "in":"query", - "name":"org_tty", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_tty", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "800-735-2258":{ - "value":"800-735-2258" + "800-735-2258": { + "value": "800-735-2258" } } }, { - "in":"query", - "name":"org_state_or_province", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_state_or_province", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "AL - Alabama":{ - "value":"AL" + "AL - Alabama": { + "value": "AL" }, - "CA - California":{ - "value":"CA" + "CA - California": { + "value": "CA" }, - "CO - Colorado":{ - "value":"CO" + "CO - Colorado": { + "value": "CO" }, - "DC - District of Columbia":{ - "value":"DC" + "DC - District of Columbia": { + "value": "DC" }, - "FL - Florida":{ - "value":"FL" + "FL - Florida": { + "value": "FL" }, - "MD - Maryland":{ - "value":"MD" + "MD - Maryland": { + "value": "MD" }, - "NY - New York":{ - "value":"NY" + "NY - New York": { + "value": "NY" }, - "WI - Wisconsin":{ - "value":"WI" + "WI - Wisconsin": { + "value": "WI" }, - "Ontario":{ - "value":"Ontario" + "Ontario": { + "value": "Ontario" } } }, { - "in":"query", - "name":"org_va", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_va", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "true":{ - "value":"true" + "true": { + "value": "true" }, - "false":{ - "value":"false" + "false": { + "value": "false" } } }, { - "in":"query", - "name":"org_postal_code", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_postal_code", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Washington DC":{ - "value":"20470" + "Washington DC": { + "value": "20470" }, - "Bethesda Maryland":{ - "value":"20890" + "Bethesda Maryland": { + "value": "20890" }, - "Groningen Netherlands":{ - "value":"9700 GZ" + "Groningen Netherlands": { + "value": "9700 GZ" }, - "Montreal Canada":{ - "value":"H2L 4M1" + "Montreal Canada": { + "value": "H2L 4M1" }, - "Rockville Maryland":{ - "value":"20850-2062" + "Rockville Maryland": { + "value": "20850-2062" }, - "Aurora Colorado":{ - "value":"80012" + "Aurora Colorado": { + "value": "80012" } } }, { - "in":"query", - "name":"org_family", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_family", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Mayo Clinic Cancer Center":{ - "value":"Mayo Clinic Cancer Center" + "Mayo Clinic Cancer Center": { + "value": "Mayo Clinic Cancer Center" }, - "Alvin J. Siteman Cancer Center":{ - "value":"Alvin J. Siteman Cancer Center" + "Alvin J. Siteman Cancer Center": { + "value": "Alvin J. Siteman Cancer Center" }, - "University of Chicago Comprehensive Cancer Center":{ - "value":"University of Chicago Comprehensive Cancer Center" + "University of Chicago Comprehensive Cancer Center": { + "value": "University of Chicago Comprehensive Cancer Center" }, - "MD Anderson Cancer Center":{ - "value":"MD Anderson Cancer Center" + "MD Anderson Cancer Center": { + "value": "MD Anderson Cancer Center" }, - "Roswell Park Cancer Institute":{ - "value":"Roswell Park Cancer Institute" + "Roswell Park Cancer Institute": { + "value": "Roswell Park Cancer Institute" }, - "Stanford Cancer Institute":{ - "value":"Stanford Cancer Institute" + "Stanford Cancer Institute": { + "value": "Stanford Cancer Institute" } } }, { - "in":"query", - "name":"org_coordinates_lat", - "description":"Organization's Latitude - for example: 43.7029", - "required":false, - "schema":{ - "type":"number", - "minimum":-999, - "maximum":999 + "in": "query", + "name": "org_coordinates_lat", + "description": "Organization's Latitude - for example: 43.7029", + "required": false, + "schema": { + "type": "number", + "minimum": -999, + "maximum": 999 }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Kaiser Permanente-Glenlake Medical Center":{ - "value":"33.9325" + "Kaiser Permanente-Glenlake Medical Center": { + "value": "33.9325" }, - "Riverside Methodist Hospital":{ - "value":"40.0525" + "Riverside Methodist Hospital": { + "value": "40.0525" }, - "Baptist MD Anderson Cancer Center":{ - "value":"30.291" + "Baptist MD Anderson Cancer Center": { + "value": "30.291" } } }, { - "in":"query", - "name":"org_coordinates_lon", - "description":"Organization's Longitude - for example: -72.2895", - "required":false, - "schema":{ - "type":"number", - "minimum":-999, - "maximum":999 + "in": "query", + "name": "org_coordinates_lon", + "description": "Organization's Longitude - for example: -72.2895", + "required": false, + "schema": { + "type": "number", + "minimum": -999, + "maximum": 999 }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Kaiser Permanente-Glenlake Medical Center":{ - "value":"-84.3852" + "Kaiser Permanente-Glenlake Medical Center": { + "value": "-84.3852" }, - "Riverside Methodist Hospital":{ - "value":"-83.02" + "Riverside Methodist Hospital": { + "value": "-83.02" }, - "Baptist MD Anderson Cancer Center":{ - "value":"-81.6318" + "Baptist MD Anderson Cancer Center": { + "value": "-81.6318" } } }, { - "in":"query", - "name":"org_coordinates_dist", - "description":"The radius around a given geolocation. The geolocation can be provided by using both org_coordinates_lon and org_coordinates_lat, as described above, OR by specifying the zip code org_postal_code, at which point the geolocation will be calculated for you. We only support miles or kilometers for distance: for example org_coordinates_dist=25mi or org_coordinates_dist=25km. Geolocation Search only works to find sites in the United States. If not provided with geolocation parameters, currently defaults to 0.67mi to provide 'at location' results.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "org_coordinates_dist", + "description": "The radius around a given geolocation. The geolocation can be provided by using both org_coordinates_lon and org_coordinates_lat, as described above, OR by specifying the zip code org_postal_code, at which point the geolocation will be calculated for you. We only support miles or kilometers for distance: for example org_coordinates_dist=25mi or org_coordinates_dist=25km. Geolocation Search only works to find sites in the United States. If not provided with geolocation parameters, currently defaults to 0.67mi to provide 'at location' results.", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"include", - "description":"Include only this field(s) in trials and exclude others. Use multiple times to include multiple fields. (Useful if you want to minimize the payload returned)", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "include", + "description": "Include only this field(s) in trials and exclude others. Use multiple times to include multiple fields. (Useful if you want to minimize the payload returned)", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "all fields":{ - "value":"" + "examples": { + "all fields": { + "value": "" }, - "no data; just get the count":{ - "value":"none" + "no data; just get the count": { + "value": "none" }, - "name":{ - "value":"name" + "name": { + "value": "name" }, - "contact_name":{ - "value":"contact_name" + "contact_name": { + "value": "contact_name" }, - "contact_email":{ - "value":"contact_email" + "contact_email": { + "value": "contact_email" }, - "contact_phone":{ - "value":"contact_phone" + "contact_phone": { + "value": "contact_phone" }, - "org_address_line_1":{ - "value":"org_address_line_1" + "org_address_line_1": { + "value": "org_address_line_1" }, - "org_address_line_2":{ - "value":"org_address_line_2" + "org_address_line_2": { + "value": "org_address_line_2" }, - "org_city":{ - "value":"org_city" + "org_city": { + "value": "org_city" }, - "org_country":{ - "value":"org_country" + "org_country": { + "value": "org_country" }, - "org_email":{ - "value":"org_email" + "org_email": { + "value": "org_email" }, - "recruitment_status":{ - "value":"recruitment_status" + "recruitment_status": { + "value": "recruitment_status" }, - "recruitment_status_date":{ - "value":"recruitment_status_date" + "recruitment_status_date": { + "value": "recruitment_status_date" }, - "org_phone":{ - "value":"org_phone" + "org_phone": { + "value": "org_phone" }, - "org_fax":{ - "value":"org_fax" + "org_fax": { + "value": "org_fax" }, - "org_tty":{ - "value":"org_tty" + "org_tty": { + "value": "org_tty" }, - "org_state_or_province":{ - "value":"org_state_or_province" + "org_state_or_province": { + "value": "org_state_or_province" }, - "org_va":{ - "value":"org_va" + "org_va": { + "value": "org_va" }, - "org_postal_code":{ - "value":"org_postal_code" + "org_postal_code": { + "value": "org_postal_code" }, - "org_family":{ - "value":"org_family" + "org_family": { + "value": "org_family" }, - "org_coordinates":{ - "value":"org_coordinates" + "org_coordinates": { + "value": "org_coordinates" } } }, { - "in":"query", - "name":"sort", - "description":"Default set to 'name'. Currently works only for name.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sort", + "description": "Default set to 'name'. Currently works only for name.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "use default":{ - "value":"" + "examples": { + "use default": { + "value": "" }, - "name":{ - "value":"name" + "name": { + "value": "name" }, - "count":{ - "value":"count" + "count": { + "value": "count" }, - "contact_name (Not available. Will result in 400 response code)":{ - "value":"contact_name" + "contact_name (Not available. Will result in 400 response code)": { + "value": "contact_name" }, - "contact_email (Not available. Will result in 400 response code)":{ - "value":"contact_email" + "contact_email (Not available. Will result in 400 response code)": { + "value": "contact_email" }, - "org_country (Not available. Will result in 400 response code)":{ - "value":"org_country" + "org_country (Not available. Will result in 400 response code)": { + "value": "org_country" }, - "org_state_or_province (Not available. Will result in 400 response code)":{ - "value":"org_state_or_province" + "org_state_or_province (Not available. Will result in 400 response code)": { + "value": "org_state_or_province" } } }, { - "$ref":"#/components/parameters/order" + "$ref": "#/components/parameters/order" }, { - "$ref":"#/components/parameters/size" + "$ref": "#/components/parameters/size" } ], - "responses":{ - "200":{ - "description":"The list matching given search criteria." + "responses": { + "200": { + "description": "The list matching given search criteria." }, - "400":{ - "description":"Bad Request." + "400": { + "description": "Bad Request." }, - "500":{ - "description":"An exception occurred at the backend." + "500": { + "description": "An exception occurred at the backend." }, - "502":{ - "description":"An exception occurred at the backend." + "502": { + "description": "An exception occurred at the backend." } } } }, - "/biomarkers":{ - "get":{ - "tags":[ + "/biomarkers": { + "get": { + "tags": [ "Biomarkers" ], - "summary":"Search Biomarkers by GET", - "security":[ + "summary": "Search Biomarkers by GET", + "security": [ { - "ApiKeyAuth":[ - - ] + "ApiKeyAuth": [] } ], - "description":"

GET biomarkers?<filter_params>

The biomarkers endpoint is intended for typeaheads and other use cases where it is necessary to search for available biomarkers which can later be used to filter clinical trial results. Biomarkers are matched partially by supplying a string to the name field and may be filtered by other fields through parameters described below. Results are sorted by a combination of in alphabetical order by default i.e sort is set to name and order is set to asc.

Example: biomarkers?eligibility_criterion=inclusion&name=estrogen

Progressive Filtering functionality: All trial fields parameters described at the /trials endpoint are usable here to filter the trials from which you want to aggregate. For example, if you request /biomarkers?maintype=C4872 this will give you all biomarkers that are in trials where Breast Cancer(C4872) is among the diseases in each trial. Note that maintype is a trials endpoint parameter related to diseases.nci_thesaurus_concept_id.

", - "operationId":"searchBiomarkersByGet", - "parameters":[ - { - "in":"query", - "name":"name", - "description":"Note that name checks for values assigned to name as well as values assigned to synonyms.", - "required":false, - "schema":{ - "type":"string" + "description": "

GET biomarkers?<filter_params>

The biomarkers endpoint is intended for typeaheads and other use cases where it is necessary to search for available biomarkers which can later be used to filter clinical trial results. Biomarkers are matched partially by supplying a string to the name field and may be filtered by other fields through parameters described below. Results are sorted by a combination of in alphabetical order by default i.e sort is set to name and order is set to asc.

Example: biomarkers?eligibility_criterion=inclusion&name=estrogen

Progressive Filtering functionality: All trial fields parameters described at the /trials endpoint are usable here to filter the trials from which you want to aggregate. For example, if you request /biomarkers?maintype=C4872 this will give you all biomarkers that are in trials where Breast Cancer(C4872) is among the diseases in each trial. Note that maintype is a trials endpoint parameter related to diseases.nci_thesaurus_concept_id.

", + "operationId": "searchBiomarkersByGet", + "parameters": [ + { + "in": "query", + "name": "name", + "description": "Note that name checks for values assigned to name as well as values assigned to synonyms.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "ALK Positive":{ - "value":"ALK Positive" + "ALK Positive": { + "value": "ALK Positive" }, - "Chromosome":{ - "value":"Chromosome" + "Chromosome": { + "value": "Chromosome" }, - "DNA Structure":{ - "value":"DNA Structure" + "DNA Structure": { + "value": "DNA Structure" }, - "Kinases":{ - "value":"Kinases" + "Kinases": { + "value": "Kinases" }, - "Finding":{ - "value":"Finding" + "Finding": { + "value": "Finding" } } }, { - "in":"query", - "name":"eligibility_criterion", - "description":"Eligibility criterion - inclusion or exclusion.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "eligibility_criterion", + "description": "Eligibility criterion - inclusion or exclusion.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "inclusion":{ - "value":"inclusion" + "inclusion": { + "value": "inclusion" }, - "exclusion":{ - "value":"exclusion" + "exclusion": { + "value": "exclusion" } } }, { - "in":"query", - "name":"type", - "description":"Type of Biomarker - Note that multiple values for type creates an 'OR' condition for the result set. Results will meet one of the type values requested. Use 'type' and 'type_not' together to further filter results.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "type", + "description": "Type of Biomarker - Note that multiple values for type creates an 'OR' condition for the result set. Results will meet one of the type values requested. Use 'type' and 'type_not' together to further filter results.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "reference_gene":{ - "value":"reference_gene" + "reference_gene": { + "value": "reference_gene" }, - "branch":{ - "value":"branch" + "branch": { + "value": "branch" } } }, { - "in":"query", - "name":"type_not", - "description":"This will do the opposite of 'type' above and exclude rather than include. Note that multiple values for type creates an 'AND' condition for the result set. Results will meet all menu_not values requested. Use 'type' and 'type_not' together to further filter results.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "type_not", + "description": "This will do the opposite of 'type' above and exclude rather than include. Note that multiple values for type creates an 'AND' condition for the result set. Results will meet all menu_not values requested. Use 'type' and 'type_not' together to further filter results.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "reference_gene":{ - "value":"reference_gene" + "reference_gene": { + "value": "reference_gene" }, - "branch":{ - "value":"branch" + "branch": { + "value": "branch" } } }, { - "in":"query", - "name":"parent_ids", - "description":"Setting the parent_id value will get you a direct child along a biomarker path.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "parent_ids", + "description": "Setting the parent_id value will get you a direct child along a biomarker path.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "C98357":{ - "value":"C98357" + "C98357": { + "value": "C98357" }, - "C25871":{ - "value":"C25871" + "C25871": { + "value": "C25871" }, - "C98303":{ - "value":"C98303" + "C98303": { + "value": "C98303" }, - "C131912":{ - "value":"C131912" + "C131912": { + "value": "C131912" } } }, { - "in":"query", - "name":"ancestor_ids", - "description":"Setting an ancestor_ids value will get you any of the children along a biomarker path.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "ancestor_ids", + "description": "Setting an ancestor_ids value will get you any of the children along a biomarker path.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "C98357":{ - "value":"C98357" + "C98357": { + "value": "C98357" }, - "C25871":{ - "value":"C25871" + "C25871": { + "value": "C25871" }, - "C98303":{ - "value":"C98303" + "C98303": { + "value": "C98303" }, - "C131912":{ - "value":"C131912" + "C131912": { + "value": "C131912" } } }, { - "in":"query", - "name":"codes", - "description":"", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "codes", + "description": "", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "C3367":{ - "value":"C3367" + "C3367": { + "value": "C3367" }, - "C7057":{ - "value":"C7057" + "C7057": { + "value": "C7057" }, - "C25871":{ - "value":"C25871" + "C25871": { + "value": "C25871" }, - "C98303":{ - "value":"C98303" + "C98303": { + "value": "C98303" }, - "C131912":{ - "value":"C131912" + "C131912": { + "value": "C131912" } } }, { - "in":"query", - "name":"assay_purpose", - "description":"Why the biomarker is being measured", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "assay_purpose", + "description": "Why the biomarker is being measured", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "":{ - "value":"" + "examples": { + "": { + "value": "" }, - "Eligibility Criterion - Exclusion":{ - "value":"Eligibility Criterion - Exclusion" + "Eligibility Criterion - Exclusion": { + "value": "Eligibility Criterion - Exclusion" }, - "Eligibility Criterion - Inclusion":{ - "value":"Eligibility Criterion - Inclusion" + "Eligibility Criterion - Inclusion": { + "value": "Eligibility Criterion - Inclusion" } } }, { - "in":"query", - "name":"semantic_types", - "description":"Broad subject categories that provide a consistent categorization of all concepts represented", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "semantic_types", + "description": "Broad subject categories that provide a consistent categorization of all concepts represented", + "required": false, + "schema": { + "type": "string" } }, { - "in":"query", - "name":"include", - "description":"Include only this field(s) in trials and exclude others. Use multiple times to include multiple fields. (Useful if you want to minimize the payload returned)", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "include", + "description": "Include only this field(s) in trials and exclude others. Use multiple times to include multiple fields. (Useful if you want to minimize the payload returned)", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "all fields":{ - "value":"" + "examples": { + "all fields": { + "value": "" }, - "no data; just get the count":{ - "value":"none" + "no data; just get the count": { + "value": "none" }, - "name":{ - "value":"name" + "name": { + "value": "name" }, - "eligibility_criterion":{ - "value":"eligibility_criterion" + "eligibility_criterion": { + "value": "eligibility_criterion" }, - "codes":{ - "value":"codes" + "codes": { + "value": "codes" }, - "type":{ - "value":"type" + "type": { + "value": "type" }, - "parent_ids":{ - "value":"parent_ids" + "parent_ids": { + "value": "parent_ids" }, - "ancestor_ids":{ - "value":"ancestor_ids" + "ancestor_ids": { + "value": "ancestor_ids" }, - "synonyms":{ - "value":"synonyms" + "synonyms": { + "value": "synonyms" }, - "count":{ - "value":"count" + "count": { + "value": "count" } } }, { - "in":"query", - "name":"sort", - "description":"Default set to 'name'. Currently works only for name and count.", - "required":false, - "schema":{ - "type":"string" + "in": "query", + "name": "sort", + "description": "Default set to 'name'. Currently works only for name and count.", + "required": false, + "schema": { + "type": "string" }, - "examples":{ - "use default":{ - "value":"" + "examples": { + "use default": { + "value": "" }, - "name":{ - "value":"name" + "name": { + "value": "name" }, - "count":{ - "value":"count" + "count": { + "value": "count" }, - "code (Not available. Will result in 400 response code)":{ - "value":"code" + "code (Not available. Will result in 400 response code)": { + "value": "code" }, - "type (Not available. Will result in 400 response code)":{ - "value":"type" + "type (Not available. Will result in 400 response code)": { + "value": "type" }, - "parent_ids (Not available. Will result in 400 response code)":{ - "value":"parent_ids" + "parent_ids (Not available. Will result in 400 response code)": { + "value": "parent_ids" } } }, { - "$ref":"#/components/parameters/order" + "$ref": "#/components/parameters/order" }, { - "$ref":"#/components/parameters/size" + "$ref": "#/components/parameters/size" } ], - "responses":{ - "200":{ - "description":"The list matching given search criteria." + "responses": { + "200": { + "description": "The list matching given search criteria." }, - "400":{ - "description":"Bad Request." + "400": { + "description": "Bad Request." }, - "500":{ - "description":"An exception occurred at the backend." + "500": { + "description": "An exception occurred at the backend." }, - "502":{ - "description":"An exception occurred at the backend." + "502": { + "description": "An exception occurred at the backend." } } } diff --git a/NCIClinicalTrialsSearchAPI/.openapi-generator/FILES b/NCIClinicalTrialsSearchAPI/.openapi-generator/FILES index 9a05b42..39c50dc 100644 --- a/NCIClinicalTrialsSearchAPI/.openapi-generator/FILES +++ b/NCIClinicalTrialsSearchAPI/.openapi-generator/FILES @@ -16,6 +16,8 @@ OpenAPIClient/Classes/OpenAPIs/JSONDataEncoding.swift OpenAPIClient/Classes/OpenAPIs/JSONEncodingHelper.swift OpenAPIClient/Classes/OpenAPIs/Models.swift OpenAPIClient/Classes/OpenAPIs/Models/Arm.swift +OpenAPIClient/Classes/OpenAPIs/Models/AssociatedStudy.swift +OpenAPIClient/Classes/OpenAPIs/Models/Biomarker.swift OpenAPIClient/Classes/OpenAPIs/Models/CentralContact.swift OpenAPIClient/Classes/OpenAPIs/Models/Collaborators.swift OpenAPIClient/Classes/OpenAPIs/Models/Coordinates.swift @@ -25,6 +27,7 @@ OpenAPIClient/Classes/OpenAPIs/Models/Identifier.swift OpenAPIClient/Classes/OpenAPIs/Models/Intervention.swift OpenAPIClient/Classes/OpenAPIs/Models/Masking.swift OpenAPIClient/Classes/OpenAPIs/Models/OutcomeMeasure.swift +OpenAPIClient/Classes/OpenAPIs/Models/PriorTherapy.swift OpenAPIClient/Classes/OpenAPIs/Models/Site.swift OpenAPIClient/Classes/OpenAPIs/Models/StatusHistory.swift OpenAPIClient/Classes/OpenAPIs/Models/StructuredEligibility.swift @@ -38,6 +41,8 @@ OpenAPIClient/Classes/OpenAPIs/Validation.swift Package.swift README.md docs/Arm.md +docs/AssociatedStudy.md +docs/Biomarker.md docs/BiomarkersAPI.md docs/CentralContact.md docs/Collaborators.md @@ -51,6 +56,7 @@ docs/InterventionsAPI.md docs/Masking.md docs/OrganizationsAPI.md docs/OutcomeMeasure.md +docs/PriorTherapy.md docs/Site.md docs/StatusHistory.md docs/StructuredEligibility.md diff --git a/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/AssociatedStudy.swift b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/AssociatedStudy.swift new file mode 100644 index 0000000..32962aa --- /dev/null +++ b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/AssociatedStudy.swift @@ -0,0 +1,36 @@ +// +// AssociatedStudy.swift +// +// Generated by openapi-generator +// https://openapi-generator.tech +// + +import Foundation +#if canImport(AnyCodable) +import AnyCodable +#endif + +public struct AssociatedStudy: Codable, JSONEncodable, Hashable { + + public var studyIdType: String? + public var studyId: String? + + public init(studyIdType: String? = nil, studyId: String? = nil) { + self.studyIdType = studyIdType + self.studyId = studyId + } + + public enum CodingKeys: String, CodingKey, CaseIterable { + case studyIdType = "study_id_type" + case studyId = "study_id" + } + + // Encodable protocol methods + + public func encode(to encoder: Encoder) throws { + var container = encoder.container(keyedBy: CodingKeys.self) + try container.encodeIfPresent(studyIdType, forKey: .studyIdType) + try container.encodeIfPresent(studyId, forKey: .studyId) + } +} + diff --git a/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/Biomarker.swift b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/Biomarker.swift new file mode 100644 index 0000000..60db6b6 --- /dev/null +++ b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/Biomarker.swift @@ -0,0 +1,68 @@ +// +// Biomarker.swift +// +// Generated by openapi-generator +// https://openapi-generator.tech +// + +import Foundation +#if canImport(AnyCodable) +import AnyCodable +#endif + +public struct Biomarker: Codable, JSONEncodable, Hashable { + + public var eligibilityCriterion: String? + public var inclusionIndicator: String? + public var synonyms: [String]? + public var nciThesaurusConceptId: String? + public var name: String? + public var semanticTypes: [String]? + public var type: [String]? + public var ancestors: [String]? + public var parents: [String]? + public var assayPurpose: String? + + public init(eligibilityCriterion: String? = nil, inclusionIndicator: String? = nil, synonyms: [String]? = nil, nciThesaurusConceptId: String? = nil, name: String? = nil, semanticTypes: [String]? = nil, type: [String]? = nil, ancestors: [String]? = nil, parents: [String]? = nil, assayPurpose: String? = nil) { + self.eligibilityCriterion = eligibilityCriterion + self.inclusionIndicator = inclusionIndicator + self.synonyms = synonyms + self.nciThesaurusConceptId = nciThesaurusConceptId + self.name = name + self.semanticTypes = semanticTypes + self.type = type + self.ancestors = ancestors + self.parents = parents + self.assayPurpose = assayPurpose + } + + public enum CodingKeys: String, CodingKey, CaseIterable { + case eligibilityCriterion = "eligibility_criterion" + case inclusionIndicator = "inclusion_indicator" + case synonyms + case nciThesaurusConceptId = "nci_thesaurus_concept_id" + case name + case semanticTypes = "semantic_types" + case type + case ancestors + case parents + case assayPurpose = "assay_purpose" + } + + // Encodable protocol methods + + public func encode(to encoder: Encoder) throws { + var container = encoder.container(keyedBy: CodingKeys.self) + try container.encodeIfPresent(eligibilityCriterion, forKey: .eligibilityCriterion) + try container.encodeIfPresent(inclusionIndicator, forKey: .inclusionIndicator) + try container.encodeIfPresent(synonyms, forKey: .synonyms) + try container.encodeIfPresent(nciThesaurusConceptId, forKey: .nciThesaurusConceptId) + try container.encodeIfPresent(name, forKey: .name) + try container.encodeIfPresent(semanticTypes, forKey: .semanticTypes) + try container.encodeIfPresent(type, forKey: .type) + try container.encodeIfPresent(ancestors, forKey: .ancestors) + try container.encodeIfPresent(parents, forKey: .parents) + try container.encodeIfPresent(assayPurpose, forKey: .assayPurpose) + } +} + diff --git a/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/Disease.swift b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/Disease.swift index 2fd0d89..a35b5fa 100644 --- a/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/Disease.swift +++ b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/Disease.swift @@ -17,16 +17,14 @@ public struct Disease: Codable, JSONEncodable, Hashable { public var synonyms: [String]? public var nciThesaurusConceptId: String? public var name: String? - public var type: [String]? public var parents: [String]? - public init(inclusionIndicator: String? = nil, isLeadDisease: Bool? = nil, synonyms: [String]? = nil, nciThesaurusConceptId: String? = nil, name: String? = nil, type: [String]? = nil, parents: [String]? = nil) { + public init(inclusionIndicator: String? = nil, isLeadDisease: Bool? = nil, synonyms: [String]? = nil, nciThesaurusConceptId: String? = nil, name: String? = nil, parents: [String]? = nil) { self.inclusionIndicator = inclusionIndicator self.isLeadDisease = isLeadDisease self.synonyms = synonyms self.nciThesaurusConceptId = nciThesaurusConceptId self.name = name - self.type = type self.parents = parents } @@ -36,7 +34,6 @@ public struct Disease: Codable, JSONEncodable, Hashable { case synonyms case nciThesaurusConceptId = "nci_thesaurus_concept_id" case name - case type case parents } @@ -49,7 +46,6 @@ public struct Disease: Codable, JSONEncodable, Hashable { try container.encodeIfPresent(synonyms, forKey: .synonyms) try container.encodeIfPresent(nciThesaurusConceptId, forKey: .nciThesaurusConceptId) try container.encodeIfPresent(name, forKey: .name) - try container.encodeIfPresent(type, forKey: .type) try container.encodeIfPresent(parents, forKey: .parents) } } diff --git a/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/PriorTherapy.swift b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/PriorTherapy.swift new file mode 100644 index 0000000..5b00bd9 --- /dev/null +++ b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/PriorTherapy.swift @@ -0,0 +1,56 @@ +// +// PriorTherapy.swift +// +// Generated by openapi-generator +// https://openapi-generator.tech +// + +import Foundation +#if canImport(AnyCodable) +import AnyCodable +#endif + +public struct PriorTherapy: Codable, JSONEncodable, Hashable { + + public var eligibilityCriterion: String? + public var inclusionIndicator: String? + public var synonyms: [String]? + public var nciThesaurusConceptId: String? + public var name: String? + public var ancestorIds: [String]? + public var parents: [String]? + + public init(eligibilityCriterion: String? = nil, inclusionIndicator: String? = nil, synonyms: [String]? = nil, nciThesaurusConceptId: String? = nil, name: String? = nil, ancestorIds: [String]? = nil, parents: [String]? = nil) { + self.eligibilityCriterion = eligibilityCriterion + self.inclusionIndicator = inclusionIndicator + self.synonyms = synonyms + self.nciThesaurusConceptId = nciThesaurusConceptId + self.name = name + self.ancestorIds = ancestorIds + self.parents = parents + } + + public enum CodingKeys: String, CodingKey, CaseIterable { + case eligibilityCriterion = "eligibility_criterion" + case inclusionIndicator = "inclusion_indicator" + case synonyms + case nciThesaurusConceptId = "nci_thesaurus_concept_id" + case name + case ancestorIds = "ancestor_ids" + case parents + } + + // Encodable protocol methods + + public func encode(to encoder: Encoder) throws { + var container = encoder.container(keyedBy: CodingKeys.self) + try container.encodeIfPresent(eligibilityCriterion, forKey: .eligibilityCriterion) + try container.encodeIfPresent(inclusionIndicator, forKey: .inclusionIndicator) + try container.encodeIfPresent(synonyms, forKey: .synonyms) + try container.encodeIfPresent(nciThesaurusConceptId, forKey: .nciThesaurusConceptId) + try container.encodeIfPresent(name, forKey: .name) + try container.encodeIfPresent(ancestorIds, forKey: .ancestorIds) + try container.encodeIfPresent(parents, forKey: .parents) + } +} + diff --git a/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/TrialDetail.swift b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/TrialDetail.swift index 6f0b399..f475348 100644 --- a/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/TrialDetail.swift +++ b/NCIClinicalTrialsSearchAPI/OpenAPIClient/Classes/OpenAPIs/Models/TrialDetail.swift @@ -25,7 +25,7 @@ public struct TrialDetail: Codable, JSONEncodable, Hashable { public var officialTitle: String? public var phaseSortOrder: Int? public var collaborators: [Collaborators]? - public var associatedStudies: [String]? + public var associatedStudies: [AssociatedStudy]? public var outcomeMeasures: [OutcomeMeasure]? public var phase: String? public var centralContact: CentralContact? @@ -33,7 +33,7 @@ public struct TrialDetail: Codable, JSONEncodable, Hashable { public var numberOfArms: Int? public var studyProtocolTypeSortOrder: Int? public var nctId: String? - public var biomarkers: [String]? + public var biomarkers: [Biomarker]? public var classificationCode: AnyCodable? public var currentTrialStatusDate: Date? public var diseases: [Disease]? @@ -51,7 +51,7 @@ public struct TrialDetail: Codable, JSONEncodable, Hashable { public var studyPopulationDescription: AnyCodable? public var samplingMethodCode: AnyCodable? public var minimumTargetAccrualNumber: Int? - public var priorTherapy: [String]? + public var priorTherapy: [PriorTherapy]? public var currentTrialStatusSortOrder: Int? public var startDate: Date? public var recordVerificationDate: Date? @@ -71,7 +71,7 @@ public struct TrialDetail: Codable, JSONEncodable, Hashable { public var studySubtypeCode: AnyCodable? public var studyProtocolType: String? - public init(otherIds: [Identifier]? = nil, amendmentDate: Date? = nil, keywords: AnyCodable? = nil, dcpId: AnyCodable? = nil, interventionalModel: String? = nil, leadOrg: String? = nil, eligibility: Eligibility? = nil, sites: [Site]? = nil, completionDateTypeCode: String? = nil, detailDescription: String? = nil, officialTitle: String? = nil, phaseSortOrder: Int? = nil, collaborators: [Collaborators]? = nil, associatedStudies: [String]? = nil, outcomeMeasures: [OutcomeMeasure]? = nil, phase: String? = nil, centralContact: CentralContact? = nil, primaryPurpose: String? = nil, numberOfArms: Int? = nil, studyProtocolTypeSortOrder: Int? = nil, nctId: String? = nil, biomarkers: [String]? = nil, classificationCode: AnyCodable? = nil, currentTrialStatusDate: Date? = nil, diseases: [Disease]? = nil, primaryPurposeSortOrder: Int? = nil, protocolId: String? = nil, activeSitesCount: Int? = nil, leadOrgCancerCenter: AnyCodable? = nil, arms: [Arm]? = nil, studyModelCode: AnyCodable? = nil, nciId: String? = nil, whyStudyStopped: AnyCodable? = nil, briefSummary: String? = nil, briefTitle: String? = nil, statusHistory: [StatusHistory]? = nil, studyPopulationDescription: AnyCodable? = nil, samplingMethodCode: AnyCodable? = nil, minimumTargetAccrualNumber: Int? = nil, priorTherapy: [String]? = nil, currentTrialStatusSortOrder: Int? = nil, startDate: Date? = nil, recordVerificationDate: Date? = nil, ctepId: String? = nil, currentTrialStatus: String? = nil, studyModelOtherText: AnyCodable? = nil, masking: Masking? = nil, acronym: AnyCodable? = nil, nciPrograms: [String]? = nil, nciFunded: String? = nil, anatomicSites: [String]? = nil, ccrId: AnyCodable? = nil, startDateTypeCode: String? = nil, principalInvestigator: String? = nil, studySource: String? = nil, completionDate: Date? = nil, studySubtypeCode: AnyCodable? = nil, studyProtocolType: String? = nil) { + public init(otherIds: [Identifier]? = nil, amendmentDate: Date? = nil, keywords: AnyCodable? = nil, dcpId: AnyCodable? = nil, interventionalModel: String? = nil, leadOrg: String? = nil, eligibility: Eligibility? = nil, sites: [Site]? = nil, completionDateTypeCode: String? = nil, detailDescription: String? = nil, officialTitle: String? = nil, phaseSortOrder: Int? = nil, collaborators: [Collaborators]? = nil, associatedStudies: [AssociatedStudy]? = nil, outcomeMeasures: [OutcomeMeasure]? = nil, phase: String? = nil, centralContact: CentralContact? = nil, primaryPurpose: String? = nil, numberOfArms: Int? = nil, studyProtocolTypeSortOrder: Int? = nil, nctId: String? = nil, biomarkers: [Biomarker]? = nil, classificationCode: AnyCodable? = nil, currentTrialStatusDate: Date? = nil, diseases: [Disease]? = nil, primaryPurposeSortOrder: Int? = nil, protocolId: String? = nil, activeSitesCount: Int? = nil, leadOrgCancerCenter: AnyCodable? = nil, arms: [Arm]? = nil, studyModelCode: AnyCodable? = nil, nciId: String? = nil, whyStudyStopped: AnyCodable? = nil, briefSummary: String? = nil, briefTitle: String? = nil, statusHistory: [StatusHistory]? = nil, studyPopulationDescription: AnyCodable? = nil, samplingMethodCode: AnyCodable? = nil, minimumTargetAccrualNumber: Int? = nil, priorTherapy: [PriorTherapy]? = nil, currentTrialStatusSortOrder: Int? = nil, startDate: Date? = nil, recordVerificationDate: Date? = nil, ctepId: String? = nil, currentTrialStatus: String? = nil, studyModelOtherText: AnyCodable? = nil, masking: Masking? = nil, acronym: AnyCodable? = nil, nciPrograms: [String]? = nil, nciFunded: String? = nil, anatomicSites: [String]? = nil, ccrId: AnyCodable? = nil, startDateTypeCode: String? = nil, principalInvestigator: String? = nil, studySource: String? = nil, completionDate: Date? = nil, studySubtypeCode: AnyCodable? = nil, studyProtocolType: String? = nil) { self.otherIds = otherIds self.amendmentDate = amendmentDate self.keywords = keywords diff --git a/NCIClinicalTrialsSearchAPI/README.md b/NCIClinicalTrialsSearchAPI/README.md index f40e50c..b54f9c1 100644 --- a/NCIClinicalTrialsSearchAPI/README.md +++ b/NCIClinicalTrialsSearchAPI/README.md @@ -37,6 +37,8 @@ Class | Method | HTTP request | Description ## Documentation For Models - [Arm](docs/Arm.md) + - [AssociatedStudy](docs/AssociatedStudy.md) + - [Biomarker](docs/Biomarker.md) - [CentralContact](docs/CentralContact.md) - [Collaborators](docs/Collaborators.md) - [Coordinates](docs/Coordinates.md) @@ -46,6 +48,7 @@ Class | Method | HTTP request | Description - [Intervention](docs/Intervention.md) - [Masking](docs/Masking.md) - [OutcomeMeasure](docs/OutcomeMeasure.md) + - [PriorTherapy](docs/PriorTherapy.md) - [Site](docs/Site.md) - [StatusHistory](docs/StatusHistory.md) - [StructuredEligibility](docs/StructuredEligibility.md) diff --git a/NCIClinicalTrialsSearchAPI/docs/AssociatedStudy.md b/NCIClinicalTrialsSearchAPI/docs/AssociatedStudy.md new file mode 100644 index 0000000..bba542a --- /dev/null +++ b/NCIClinicalTrialsSearchAPI/docs/AssociatedStudy.md @@ -0,0 +1,11 @@ +# AssociatedStudy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**studyIdType** | **String** | | [optional] +**studyId** | **String** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/NCIClinicalTrialsSearchAPI/docs/Biomarker.md b/NCIClinicalTrialsSearchAPI/docs/Biomarker.md new file mode 100644 index 0000000..a5adb7c --- /dev/null +++ b/NCIClinicalTrialsSearchAPI/docs/Biomarker.md @@ -0,0 +1,19 @@ +# Biomarker + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eligibilityCriterion** | **String** | | [optional] +**inclusionIndicator** | **String** | | [optional] +**synonyms** | **[String]** | | [optional] +**nciThesaurusConceptId** | **String** | | [optional] +**name** | **String** | | [optional] +**semanticTypes** | **[String]** | | [optional] +**type** | **[String]** | | [optional] +**ancestors** | **[String]** | | [optional] +**parents** | **[String]** | | [optional] +**assayPurpose** | **String** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/NCIClinicalTrialsSearchAPI/docs/Disease.md b/NCIClinicalTrialsSearchAPI/docs/Disease.md index 1f0f2f6..1c55bb8 100644 --- a/NCIClinicalTrialsSearchAPI/docs/Disease.md +++ b/NCIClinicalTrialsSearchAPI/docs/Disease.md @@ -8,7 +8,6 @@ Name | Type | Description | Notes **synonyms** | **[String]** | | [optional] **nciThesaurusConceptId** | **String** | | [optional] **name** | **String** | | [optional] -**type** | **[String]** | | [optional] **parents** | **[String]** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/NCIClinicalTrialsSearchAPI/docs/PriorTherapy.md b/NCIClinicalTrialsSearchAPI/docs/PriorTherapy.md new file mode 100644 index 0000000..360977d --- /dev/null +++ b/NCIClinicalTrialsSearchAPI/docs/PriorTherapy.md @@ -0,0 +1,16 @@ +# PriorTherapy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eligibilityCriterion** | **String** | | [optional] +**inclusionIndicator** | **String** | | [optional] +**synonyms** | **[String]** | | [optional] +**nciThesaurusConceptId** | **String** | | [optional] +**name** | **String** | | [optional] +**ancestorIds** | **[String]** | | [optional] +**parents** | **[String]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/NCIClinicalTrialsSearchAPI/docs/TrialDetail.md b/NCIClinicalTrialsSearchAPI/docs/TrialDetail.md index 31bab52..22f83a0 100644 --- a/NCIClinicalTrialsSearchAPI/docs/TrialDetail.md +++ b/NCIClinicalTrialsSearchAPI/docs/TrialDetail.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **officialTitle** | **String** | | [optional] **phaseSortOrder** | **Int** | | [optional] **collaborators** | [Collaborators] | | [optional] -**associatedStudies** | **[String]** | | [optional] +**associatedStudies** | [AssociatedStudy] | | [optional] **outcomeMeasures** | [OutcomeMeasure] | | [optional] **phase** | **String** | | [optional] **centralContact** | [**CentralContact**](CentralContact.md) | | [optional] @@ -24,7 +24,7 @@ Name | Type | Description | Notes **numberOfArms** | **Int** | | [optional] **studyProtocolTypeSortOrder** | **Int** | | [optional] **nctId** | **String** | | [optional] -**biomarkers** | **[String]** | | [optional] +**biomarkers** | [Biomarker] | | [optional] **classificationCode** | **AnyCodable** | | [optional] **currentTrialStatusDate** | **Date** | | [optional] **diseases** | [Disease] | | [optional] @@ -42,7 +42,7 @@ Name | Type | Description | Notes **studyPopulationDescription** | **AnyCodable** | | [optional] **samplingMethodCode** | **AnyCodable** | | [optional] **minimumTargetAccrualNumber** | **Int** | | [optional] -**priorTherapy** | **[String]** | | [optional] +**priorTherapy** | [PriorTherapy] | | [optional] **currentTrialStatusSortOrder** | **Int** | | [optional] **startDate** | **Date** | | [optional] **recordVerificationDate** | **Date** | | [optional] diff --git a/OwnYourData.xcodeproj/project.pbxproj b/OwnYourData.xcodeproj/project.pbxproj index 5940a15..2fb8206 100644 --- a/OwnYourData.xcodeproj/project.pbxproj +++ b/OwnYourData.xcodeproj/project.pbxproj @@ -9,6 +9,7 @@ /* Begin PBXBuildFile section */ 2F31CE882B91D6E9002B0B29 /* OpenAPIClient in Frameworks */ = {isa = PBXBuildFile; productRef = 2F31CE872B91D6E9002B0B29 /* OpenAPIClient */; }; 2F38F3A02BE805090002E7D5 /* NICTrialsAPIDateFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2F38F39F2BE805090002E7D5 /* NICTrialsAPIDateFormatter.swift */; }; + 2F38F3A52BE8BC890002E7D5 /* TrialDetail+Identifiable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2F38F3A42BE8BC890002E7D5 /* TrialDetail+Identifiable.swift */; }; 2F42E9BB2B91B6EE00D88DB7 /* SpeziLLM in Frameworks */ = {isa = PBXBuildFile; productRef = 2F42E9BA2B91B6EE00D88DB7 /* SpeziLLM */; }; 2F42E9BD2B91B6EE00D88DB7 /* SpeziLLMOpenAI in Frameworks */ = {isa = PBXBuildFile; productRef = 2F42E9BC2B91B6EE00D88DB7 /* SpeziLLMOpenAI */; }; 2F42E9C02B91B70F00D88DB7 /* SpeziFHIR in Frameworks */ = {isa = PBXBuildFile; productRef = 2F42E9BF2B91B70F00D88DB7 /* SpeziFHIR */; }; @@ -113,6 +114,7 @@ 2F38F3982BE5A9E10002E7D5 /* NCIClinicalTrialsSearchAPI */ = {isa = PBXFileReference; lastKnownFileType = wrapper; path = NCIClinicalTrialsSearchAPI; sourceTree = ""; }; 2F38F39C2BE5AB9F0002E7D5 /* NCIClinicalTrialsSearchAPI.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = NCIClinicalTrialsSearchAPI.json; sourceTree = ""; }; 2F38F39F2BE805090002E7D5 /* NICTrialsAPIDateFormatter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NICTrialsAPIDateFormatter.swift; sourceTree = ""; }; + 2F38F3A42BE8BC890002E7D5 /* TrialDetail+Identifiable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "TrialDetail+Identifiable.swift"; sourceTree = ""; }; 2F42E9CD2B91BAB900D88DB7 /* OwnYourDataSection.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = OwnYourDataSection.swift; sourceTree = ""; }; 2F42E9CE2B91BAB900D88DB7 /* LogoView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LogoView.swift; sourceTree = ""; }; 2F42E9CF2B91BAB900D88DB7 /* OwnYourDataButton.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = OwnYourDataButton.swift; sourceTree = ""; }; @@ -258,6 +260,7 @@ 2F42E9E62B91BB8300D88DB7 /* ClinicalTrialsView.swift */, 2F42E9E52B91BB8300D88DB7 /* WebView.swift */, 2F38F39F2BE805090002E7D5 /* NICTrialsAPIDateFormatter.swift */, + 2F38F3A42BE8BC890002E7D5 /* TrialDetail+Identifiable.swift */, ); path = ClinicalTrials; sourceTree = ""; @@ -673,6 +676,7 @@ 2F4E23832989D51F0013F3D9 /* OwnYourDataTestingSetup.swift in Sources */, 2F42E9DC2B91BB2500D88DB7 /* DocumentManager.swift in Sources */, 2F42E9E02B91BB2500D88DB7 /* PDFListDetailView.swift in Sources */, + 2F38F3A52BE8BC890002E7D5 /* TrialDetail+Identifiable.swift in Sources */, 2F42E9FA2B91BDD300D88DB7 /* InstructionsView.swift in Sources */, 56F6F2A02AB441930022FE5A /* ContributionsList.swift in Sources */, 2F42E9D22B91BAB900D88DB7 /* OwnYourDataButton.swift in Sources */, diff --git a/OwnYourData/ClinicalTrials/ClinicalTrialsView.swift b/OwnYourData/ClinicalTrials/ClinicalTrialsView.swift index a359a19..30ac874 100644 --- a/OwnYourData/ClinicalTrials/ClinicalTrialsView.swift +++ b/OwnYourData/ClinicalTrials/ClinicalTrialsView.swift @@ -17,55 +17,49 @@ struct ClinicalTrialsView: View { var body: some View { - if let url = URL(string: "https://www.cancer.gov/about-cancer/treatment/clinical-trials/search") { - WebView(url: url) + NavigationStack { + List { + if trials.isEmpty { + ProgressView() + } else { + ForEach(trials) { trial in + VStack(alignment: .leading) { + Text(trial.briefTitle ?? "No Title") + .bold() + Text(trial.id ?? "No NCI ID") + .bold() + .foregroundStyle(.secondary) + Divider() + Text(trial.detailDescription ?? "-") + .font(.caption) + } + } + } + } + .navigationTitle("NCI Trials") .task { - await testNCIAPI() + trials.append(contentsOf: (try? await loadTrials().data) ?? []) } .viewStateAlert(state: $viewState) } } - private func testNCIAPI() async { - do { - let testTrialIds = [ - "NCI-2019-02616", - "NCT03386721", - "NCI-2015-00414", - "NCI-2016-00376", - "NCI-2016-00469", - "NCI-2017-00679", - "NCI-2018-02229", - "NCI-2016-01319", - "NCI-2016-01435", - "NCI-2017-00223", - "NCT03391791", - "NCT02369029", - "NCT02877862", - "NCT02565758", - "NCT03110159", - "NCT02896907", - "NCT02816697", - "NCT03092856" - ] - viewState = .processing - for testTrialId in testTrialIds { - trials.append(try await loadTrial(withId: testTrialId)) - try await Task.sleep(for: .seconds(2)) - } - viewState = .idle - } catch { - viewState = .error(AnyLocalizedError(error: error)) - } - } - - private func loadTrial(withId trialId: String) async throws -> TrialDetail { + private func loadTrials() async throws -> TrialResponse { OpenAPIClientAPI.customHeaders = ["X-API-KEY": ""] CodableHelper.dateFormatter = NICTrialsAPIDateFormatter() return try await withCheckedThrowingContinuation { continuation in - TrialsAPI.getTrialById(id: trialId) { data, error in + TrialsAPI.searchTrialsByGet( + size: 50, + keyword: "breast", + trialStatus: "OPEN", + phase: "III", + primaryPurpose: "TREATMENT", + sitesOrgCoordinatesLat: 37.7749, + sitesOrgCoordinatesLon: -122.4194, + sitesOrgCoordinatesDist: "100mi" + ) { data, error in guard let data else { if let error { continuation.resume(throwing: error) diff --git a/OwnYourData/ClinicalTrials/TrialDetail+Identifiable.swift b/OwnYourData/ClinicalTrials/TrialDetail+Identifiable.swift new file mode 100644 index 0000000..a61ba6f --- /dev/null +++ b/OwnYourData/ClinicalTrials/TrialDetail+Identifiable.swift @@ -0,0 +1,16 @@ +// +// This source file is part of the OwnYourData based on the Stanford Spezi Template Application project +// +// SPDX-FileCopyrightText: 2023 Stanford University +// +// SPDX-License-Identifier: MIT +// + +import OpenAPIClient + + +extension TrialDetail: Identifiable { + public var id: String? { + self.nciId + } +} diff --git a/OwnYourData/Resources/Localizable.xcstrings b/OwnYourData/Resources/Localizable.xcstrings index ae8a4f8..fe9e74e 100644 --- a/OwnYourData/Resources/Localizable.xcstrings +++ b/OwnYourData/Resources/Localizable.xcstrings @@ -102,6 +102,9 @@ }, "Navigate to the Browse tab." : { + }, + "NCI Trials" : { + }, "Next" : {