Search Clinical Data
POST
/v3/download/clinical_data/
Filters clinical data based on criteria provided in the POST request body. Returns record counts and optionally the detailed data based on the ‘summary_only’ flag.
Authorizations
Request Body required
object
biosample_id
Array<string>
primary_site
Array<string>
program_id
Array<string>
summary_only
If true, only summary data will be returned. If false, detailed data will be returned.
boolean
systemic_therapy_drug_name
Array<string>
treatment_type
Array<string>
Responses
200
OK
object
data
Any of:
object
biomarkers
required
Array<object>
object
ca125_not_available
boolean
cea_not_available
boolean
er_percent_positive_not_available
boolean
er_status
Any of:
string
null
her2_ihc_status
Any of:
string
null
her2_ish_status
Any of:
string
null
hpv_ihc_status
Any of:
string
null
hpv_pcr_status
Any of:
string
null
hpv_strain
Any of:
Array<string>
null
pr_percent_positive_not_available
boolean
pr_status
Any of:
string
null
program_id
required
string
psa_level_not_available
boolean
submitter_donor_id
required
string
test_date
Any of:
null
comorbidities
required
Array<object>
object
age_at_comorbidity_diagnosis_not_available
boolean
comorbidity_treatment_status
Any of:
string
null
laterality_of_prior_malignancy
Any of:
string
null
prior_malignancy
Any of:
string
null
program_id
required
string
submitter_donor_id
required
string
donors
required
Array<object>
object
cause_of_death
Any of:
string
null
date_alive_after_lost_to_followup
Any of:
null
date_of_birth
Any of:
null
date_of_death
Any of:
null
gender
Any of:
string
null
is_deceased
Any of:
string
null
lost_to_followup_reason
Any of:
string
null
program_id
required
string
sex_at_birth
Any of:
string
null
submitter_donor_id
required
string
exposures
required
Array<object>
object
pack_years_smoked_not_available
boolean
program_id
required
string
submitter_donor_id
required
string
tobacco_smoking_status
Any of:
string
null
tobacco_type
Any of:
Array<string>
null
follow_ups
required
Array<object>
object
anatomic_site_progression_or_recurrence
Any of:
Array<string>
null
date_of_followup
Any of:
null
date_of_relapse
Any of:
null
disease_status_at_followup
Any of:
string
null
method_of_progression_status
Any of:
Array<string>
null
program_id
required
string
relapse_type
Any of:
string
null
submitter_donor_id
required
string
submitter_follow_up_id
required
string
primary_diagnoses
required
Array<object>
object
basis_of_diagnosis
Any of:
string
null
clinical_m_category
Any of:
string
null
clinical_n_category
Any of:
string
null
clinical_stage_group
Any of:
string
null
clinical_t_category
Any of:
string
null
clinical_tumour_staging_system
Any of:
string
null
date_of_diagnosis
Any of:
null
laterality
Any of:
string
null
pathological_m_category
Any of:
string
null
pathological_n_category
Any of:
string
null
pathological_stage_group
Any of:
string
null
pathological_t_category
Any of:
string
null
pathological_tumour_staging_system
Any of:
string
null
primary_site
Any of:
string
null
program_id
required
string
submitter_donor_id
required
string
submitter_primary_diagnosis_id
required
string
radiations
required
Array<object>
object
anatomical_site_irradiated
Any of:
string
null
program_id
required
string
radiation_boost
Any of:
string
null
radiation_therapy_dosage_not_available
boolean
radiation_therapy_fractions_not_available
boolean
radiation_therapy_modality
Any of:
string
null
radiation_therapy_type
Any of:
string
null
submitter_donor_id
required
string
submitter_treatment_id
required
string
sample_registrations
required
Array<object>
object
program_id
required
string
sample_type
Any of:
string
null
specimen_tissue_source
Any of:
string
null
specimen_type
Any of:
string
null
submitter_donor_id
required
string
submitter_sample_id
required
string
submitter_specimen_id
required
string
tumour_normal_designation
Any of:
string
null
specimens
required
Array<object>
object
percent_tumour_cells_measurement_method
Any of:
string
null
percent_tumour_cells_range
Any of:
string
null
program_id
required
string
reference_pathology_confirmed_diagnosis
Any of:
string
null
reference_pathology_confirmed_tumour_presence
Any of:
string
null
specimen_laterality
Any of:
string
null
specimen_processing
Any of:
string
null
specimen_storage
Any of:
string
null
submitter_donor_id
required
string
submitter_primary_diagnosis_id
required
string
submitter_specimen_id
required
string
tumour_grade
Any of:
string
null
tumour_grading_system
Any of:
string
null
surgeries
required
Array<object>
object
greatest_dimension_tumour_not_available
boolean
lymphovascular_invasion
Any of:
string
null
margin_types_involved
Any of:
Array<string>
null
margin_types_not_assessed
Any of:
Array<string>
null
margin_types_not_involved
Any of:
Array<string>
null
perineural_invasion
Any of:
string
null
program_id
required
string
residual_tumour_classification
Any of:
string
null
submitter_donor_id
required
string
submitter_treatment_id
required
string
surgery_location
Any of:
string
null
surgery_reference_database
Any of:
string
null
tumour_focality
Any of:
string
null
tumour_length_not_available
boolean
tumour_width_not_available
boolean
systemic_therapies
required
Array<object>
object
actual_cumulative_drug_dose_not_available
boolean
days_per_cycle_not_available
boolean
drug_dose_units
Any of:
string
null
drug_reference_database
Any of:
string
null
number_of_cycles_not_available
boolean
prescribed_cumulative_drug_dose_not_available
boolean
program_id
required
string
submitter_donor_id
required
string
submitter_treatment_id
required
string
treatments
required
Array<object>
object
is_primary_treatment
Any of:
string
null
program_id
required
string
response_to_treatment
Any of:
string
null
response_to_treatment_criteria_method
Any of:
string
null
status_of_treatment
Any of:
string
null
submitter_donor_id
required
string
submitter_primary_diagnosis_id
required
string
submitter_treatment_id
required
string
treatment_end_date
Any of:
null
treatment_intent
Any of:
string
null
treatment_start_date
Any of:
null
treatment_type
Any of:
Array<string>
null
null
summary
required
object
message
required
string
record_counts
required
object
key
additional properties
integer