Skip to content
Docs

Search Clinical Data

POST
/v3/download/clinical_data/
curl --request POST \
  --url https://your-candig-domain/katsu/v3/download/clinical_data/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "biosample_id": [ "example" ], "primary_site": [ "example" ], "program_id": [ "example" ], "summary_only": false, "systemic_therapy_drug_name": [ "example" ], "treatment_type": [ "example" ] }'

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

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
DownloadFilterSchema
object
biosample_id
Biosample Id
Array<string>
primary_site
Primary Site
Array<string>
program_id
Program Id
Array<string>
summary_only
Summary Only

If true, only summary data will be returned. If false, detailed data will be returned.

boolean
systemic_therapy_drug_name
Systemic Therapy Drug Name
Array<string>
treatment_type
Treatment Type
Array<string>

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
DownloadResponseSchema
object
data
Any of:
AllModelsSchema
object
biomarkers
required
Biomarkers
Array<object>
BiomarkerModelSchema
object
ca125
Any of:
integer
ca125_not_available
Ca125 Not Available
boolean
cea
Any of:
integer
cea_not_available
Cea Not Available
boolean
er_percent_positive
Any of:
number
er_percent_positive_not_available
Er Percent Positive Not Available
boolean
er_status
Any of:
ErPrHpvStatusEnum
string
Allowed values: Cannot be determined Negative Not applicable Positive Not available
her2_ihc_status
Any of:
Her2StatusEnum
string
Allowed values: Cannot be determined Equivocal Positive Negative Not applicable Not available
her2_ish_status
Any of:
Her2StatusEnum
string
Allowed values: Cannot be determined Equivocal Positive Negative Not applicable Not available
hpv_ihc_status
Any of:
ErPrHpvStatusEnum
string
Allowed values: Cannot be determined Negative Not applicable Positive Not available
hpv_pcr_status
Any of:
ErPrHpvStatusEnum
string
Allowed values: Cannot be determined Negative Not applicable Positive Not available
hpv_strain
Any of:
Array<string>
Allowed values: HPV16 HPV18 HPV31 HPV33 HPV35 HPV39 HPV45 HPV51 HPV52 HPV56 HPV58 HPV59 HPV66 HPV68 HPV73
pr_percent_positive
Any of:
number
pr_percent_positive_not_available
Pr Percent Positive Not Available
boolean
pr_status
Any of:
ErPrHpvStatusEnum
string
Allowed values: Cannot be determined Negative Not applicable Positive Not available
program_id
required
Program Id
string
psa_level
Any of:
integer
psa_level_not_available
Psa Level Not Available
boolean
submitter_donor_id
required
Submitter Donor Id
string
submitter_follow_up_id
Any of:
string
<= 64 characters
submitter_primary_diagnosis_id
Any of:
string
<= 64 characters
submitter_specimen_id
Any of:
string
<= 64 characters
submitter_treatment_id
Any of:
string
<= 64 characters
test_date
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
comorbidities
required
Comorbidities
Array<object>
ComorbidityModelSchema
object
age_at_comorbidity_diagnosis
Any of:
integer
age_at_comorbidity_diagnosis_not_available
Age At Comorbidity Diagnosis Not Available
boolean
comorbidity_treatment
Any of:
string
<= 255 characters
comorbidity_treatment_status
Any of:
uBooleanEnum
string
Allowed values: Yes No Not available
comorbidity_type_code
Any of:
string
<= 64 characters /^[A-Z][0-9]{2}(.[0-9]{1,3}[A-Z]{0,1})?$|^Not available$/
laterality_of_prior_malignancy
Any of:
MalignancyLateralityEnum
string
Allowed values: Bilateral Left Midline Not applicable Right Unilateral, Side not specified Not available
prior_malignancy
Any of:
uBooleanEnum
string
Allowed values: Yes No Not available
program_id
required
Program Id
string
submitter_donor_id
required
Submitter Donor Id
string
donors
required
Donors
Array<object>
DonorModelSchema
object
cause_of_death
Any of:
CauseOfDeathEnum
string
Allowed values: Died of cancer Died of other reasons Not available
date_alive_after_lost_to_followup
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
date_of_birth
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
date_of_death
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
date_resolution
Any of:
string
<= 32 characters
gender
Any of:
GenderEnum
string
Allowed values: Man Woman Non-binary Other Prefer not to disclose Not available
is_deceased
Any of:
uBooleanEnum
string
Allowed values: Yes No Not available
lost_to_followup_after_clinical_event_identifier
Any of:
string
<= 255 characters
lost_to_followup_reason
Any of:
LostToFollowupReasonEnum
string
Allowed values: Completed study Discharged to palliative care Lost contact Not available Withdrew from study Discharged from follow-up
program_id
required
Program Id
string
sex_at_birth
Any of:
SexAtBirthEnum
string
Allowed values: Male Female Other Not available
submitter_donor_id
required
Submitter Donor Id
string
<= 64 characters /^[A-Za-z0-9\-\._]{1,64}$/
exposures
required
Exposures
Array<object>
ExposureModelSchema
object
pack_years_smoked
Any of:
number
pack_years_smoked_not_available
Pack Years Smoked Not Available
boolean
program_id
required
Program Id
string
submitter_donor_id
required
Submitter Donor Id
string
tobacco_smoking_status
Any of:
SmokingStatusEnum
string
Allowed values: Current reformed smoker for <= 15 years Current reformed smoker for > 15 years Current reformed smoker, duration not specified Current smoker Lifelong non-smoker (<100 cigarettes smoked in lifetime) Not applicable Not available
tobacco_type
Any of:
Array<string>
Allowed values: Chewing Tobacco Cigar Cigarettes Electronic cigarettes Not applicable Pipe Roll-ups Snuff Not available Waterpipe
follow_ups
required
Follow Ups
Array<object>
FollowUpModelSchema
object
anatomic_site_progression_or_recurrence
Any of:
Array<string>
date_of_followup
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
date_of_relapse
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
disease_status_at_followup
Any of:
DiseaseStatusFollowupEnum
string
Allowed values: Complete remission Distant progression Loco-regional progression No evidence of disease Partial remission Progression not otherwise specified Relapse or recurrence Stable Not available
method_of_progression_status
Any of:
Array<string>
Allowed values: Imaging (procedure) Histopathology test (procedure) Assessment of symptom control (procedure) Physical examination procedure (procedure) Tumor marker measurement (procedure) Laboratory data interpretation (procedure)
program_id
required
Program Id
string
relapse_type
Any of:
RelapseTypeEnum
string
Allowed values: Distant recurrence/metastasis Local recurrence Local recurrence and distant metastasis Progression Biochemical progression Not available
submitter_donor_id
required
Submitter Donor Id
string
submitter_follow_up_id
required
Submitter Follow Up Id
string
<= 64 characters /^[A-Za-z0-9\-\._]{1,64}$/
submitter_primary_diagnosis_id
Any of:
string
submitter_treatment_id
Any of:
string
primary_diagnoses
required
Primary Diagnoses
Array<object>
PrimaryDiagnosisModelSchema
object
basis_of_diagnosis
Any of:
BasisOfDiagnosisEnum
string
Allowed values: Clinical investigation Clinical Cytology Death certificate only Histology of a metastasis Histology of a primary tumour Specific tumour markers Not available
cancer_type_code
Any of:
string
<= 64 characters
clinical_m_category
Any of:
MCategoryEnum
string
Allowed values: M0 M0(i+) M1 M1a M1a(0) M1a(1) M1b M1b(0) M1b(1) M1c M1c(0) M1c(1) M1d M1d(0) M1d(1) M1e MX Not applicable
clinical_n_category
Any of:
NCategoryEnum
string
Allowed values: N0 N0a N0a (biopsy) N0b N0b (no biopsy) N0(i+) N0(i-) N0(mol+) N0(mol-) N1 N1a N1a(sn) N1b N1c N1mi N2 N2a N2b N2c N2mi N3 N3a N3b N3c N4 NX
clinical_stage_group
Any of:
StageGroupEnum
string
Allowed values: Stage 0 Stage 0a Stage 0is Stage 1 Stage 1A Stage 1B Stage A Stage B Stage C Stage I Stage IA Stage IA1 Stage IA2 Stage IA3 Stage IAB Stage IAE Stage IAES Stage IAS Stage IB Stage IB1 Stage IB2 Stage IBE Stage IBES Stage IBS Stage IC Stage IE Stage IEA Stage IEB Stage IES Stage II Stage II bulky Stage IIA Stage IIA1 Stage IIA2 Stage IIAE Stage IIAES Stage IIAS Stage IIB Stage IIBE Stage IIBES Stage IIBS Stage IIC Stage IIE Stage IIEA Stage IIEB Stage IIES Stage III Stage IIIA Stage IIIA1 Stage IIIA2 Stage IIIAE Stage IIIAES Stage IIIAS Stage IIIB Stage IIIBE Stage IIIBES Stage IIIBS Stage IIIC Stage IIIC1 Stage IIIC2 Stage IIID Stage IIIE Stage IIIES Stage IIIS Stage IIS Stage IS Stage IV Stage IVA Stage IVA1 Stage IVA2 Stage IVAE Stage IVAES Stage IVAS Stage IVB Stage IVBE Stage IVBES Stage IVBS Stage IVC Stage IVE Stage IVES Stage IVS In situ Localized Regionalized Distant Stage L1 Stage L2 Stage M Stage Ms Stage 2A Stage 2B Stage 3 Stage 4 Stage 4S Occult Carcinoma Not available
clinical_t_category
Any of:
TCategoryEnum
string
Allowed values: T0 T1 T1a T1a1 T1a2 T1a(s) T1a(m) T1b T1b1 T1b2 T1b(s) T1b(m) T1c T1c1 T1c2 T1d T1mi T2 T2(s) T2(m) T2a T2a1 T2a2 T2b T2c T2d T3 T3(s) T3(m) T3a T3b T3c T3d T3e T4 T4a T4a(s) T4a(m) T4b T4b(s) T4b(m) T4c T4d T4e Ta Tis Tis(DCIS) Tis(LAMN) Tis(LCIS) Tis(Paget) Tis(Paget's) Tis pu Tis pd TX
clinical_tumour_staging_system
Any of:
TumourStagingSystemEnum
string
Allowed values: AJCC cancer staging system Ann Arbor staging system Binet staging system Durie-Salmon staging system FIGO staging system International Neuroblastoma Risk Group Staging System International Neuroblastoma Staging System Lugano staging system Rai staging system Revised International staging system (R-ISS) SEER staging system St Jude staging system Not available
date_of_diagnosis
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
laterality
Any of:
PrimaryDiagnosisLateralityEnum
string
Allowed values: Bilateral Left Midline Not a paired site Right Unilateral, side not specified Not available
pathological_m_category
Any of:
MCategoryEnum
string
Allowed values: M0 M0(i+) M1 M1a M1a(0) M1a(1) M1b M1b(0) M1b(1) M1c M1c(0) M1c(1) M1d M1d(0) M1d(1) M1e MX Not applicable
pathological_n_category
Any of:
NCategoryEnum
string
Allowed values: N0 N0a N0a (biopsy) N0b N0b (no biopsy) N0(i+) N0(i-) N0(mol+) N0(mol-) N1 N1a N1a(sn) N1b N1c N1mi N2 N2a N2b N2c N2mi N3 N3a N3b N3c N4 NX
pathological_stage_group
Any of:
StageGroupEnum
string
Allowed values: Stage 0 Stage 0a Stage 0is Stage 1 Stage 1A Stage 1B Stage A Stage B Stage C Stage I Stage IA Stage IA1 Stage IA2 Stage IA3 Stage IAB Stage IAE Stage IAES Stage IAS Stage IB Stage IB1 Stage IB2 Stage IBE Stage IBES Stage IBS Stage IC Stage IE Stage IEA Stage IEB Stage IES Stage II Stage II bulky Stage IIA Stage IIA1 Stage IIA2 Stage IIAE Stage IIAES Stage IIAS Stage IIB Stage IIBE Stage IIBES Stage IIBS Stage IIC Stage IIE Stage IIEA Stage IIEB Stage IIES Stage III Stage IIIA Stage IIIA1 Stage IIIA2 Stage IIIAE Stage IIIAES Stage IIIAS Stage IIIB Stage IIIBE Stage IIIBES Stage IIIBS Stage IIIC Stage IIIC1 Stage IIIC2 Stage IIID Stage IIIE Stage IIIES Stage IIIS Stage IIS Stage IS Stage IV Stage IVA Stage IVA1 Stage IVA2 Stage IVAE Stage IVAES Stage IVAS Stage IVB Stage IVBE Stage IVBES Stage IVBS Stage IVC Stage IVE Stage IVES Stage IVS In situ Localized Regionalized Distant Stage L1 Stage L2 Stage M Stage Ms Stage 2A Stage 2B Stage 3 Stage 4 Stage 4S Occult Carcinoma Not available
pathological_t_category
Any of:
TCategoryEnum
string
Allowed values: T0 T1 T1a T1a1 T1a2 T1a(s) T1a(m) T1b T1b1 T1b2 T1b(s) T1b(m) T1c T1c1 T1c2 T1d T1mi T2 T2(s) T2(m) T2a T2a1 T2a2 T2b T2c T2d T3 T3(s) T3(m) T3a T3b T3c T3d T3e T4 T4a T4a(s) T4a(m) T4b T4b(s) T4b(m) T4c T4d T4e Ta Tis Tis(DCIS) Tis(LAMN) Tis(LCIS) Tis(Paget) Tis(Paget's) Tis pu Tis pd TX
pathological_tumour_staging_system
Any of:
TumourStagingSystemEnum
string
Allowed values: AJCC cancer staging system Ann Arbor staging system Binet staging system Durie-Salmon staging system FIGO staging system International Neuroblastoma Risk Group Staging System International Neuroblastoma Staging System Lugano staging system Rai staging system Revised International staging system (R-ISS) SEER staging system St Jude staging system Not available
primary_site
Any of:
PrimarySiteEnum
string
Allowed values: Accessory sinuses Adrenal gland Anus and anal canal Base of tongue Bladder Bones, joints and articular cartilage of limbs Bones, joints and articular cartilage of other and unspecified sites Brain Breast Bronchus and lung Cervix uteri Colon Connective, subcutaneous and other soft tissues Corpus uteri Esophagus Eye and adnexa Floor of mouth Gallbladder Gum Heart, mediastinum, and pleura Hematopoietic and reticuloendothelial systems Hypopharynx Kidney Larynx Lip Liver and intrahepatic bile ducts Lymph nodes Meninges Nasal cavity and middle ear Nasopharynx Oropharynx Other and ill-defined digestive organs Other and ill-defined sites Other and ill-defined sites in lip, oral cavity and pharynx Other and ill-defined sites within respiratory system and intrathoracic organs Other and unspecified female genital organs Other and unspecified major salivary glands Other and unspecified male genital organs Other and unspecified parts of biliary tract Other and unspecified parts of mouth Other and unspecified parts of tongue Other and unspecified urinary organs Other endocrine glands and related structures Ovary Palate Pancreas Parotid gland Penis Peripheral nerves and autonomic nervous system Placenta Prostate gland Pyriform sinus Rectosigmoid junction Rectum Renal pelvis Retroperitoneum and peritoneum Skin Small intestine Spinal cord, cranial nerves, and other parts of central nervous system Stomach Testis Thymus Thyroid gland Tonsil Trachea Ureter Uterus, NOS Vagina Vulva Unknown primary site Not available
program_id
required
Program Id
string
submitter_donor_id
required
Submitter Donor Id
string
submitter_primary_diagnosis_id
required
Submitter Primary Diagnosis Id
string
<= 64 characters /^[A-Za-z0-9\-\._]{1,64}$/
radiations
required
Radiations
Array<object>
RadiationModelSchema
object
anatomical_site_irradiated
Any of:
RadiationAnatomicalSiteEnum
string
Allowed values: LEFT ABDOMEN WHOLE ABDOMEN RIGHT ABDOMEN LOWER ABDOMEN LEFT LOWER ABDOMEN RIGHT LOWER ABDOMEN UPPER ABDOMEN LEFT UPPER ABDOMEN RIGHT UPPER ABDOMEN LEFT ADRENAL RIGHT ADRENAL BILATERAL ANKLE LEFT ANKLE RIGHT ANKLE BILATERAL ANTRUM (BULL'S EYE) LEFT ANTRUM RIGHT ANTRUM ANUS LOWER LEFT ARM LOWER RIGHT ARM BILATERAL ARMS LEFT ARM RIGHT ARM UPPER LEFT ARM UPPER RIGHT ARM LEFT AXILLA RIGHT AXILLA SKIN OR SOFT TISSUE OF BACK BILE DUCT BLADDER LOWER BODY MIDDLE BODY UPPER BODY WHOLE BODY BOOST - AREA PREVIOUSLY TREATED BRAIN LEFT BREAST BOOST RIGHT BREAST BOOST BILATERAL BREAST LEFT BREAST RIGHT BREAST BILATERAL BREASTS WITH NODES LEFT BREAST WITH NODES RIGHT BREAST WITH NODES BILATERAL BUTTOCKS LEFT BUTTOCK RIGHT BUTTOCK INNER CANTHUS OUTER CANTHUS CERVIX BILATERAL CHEST LUNG & AREA INVOLVE LEFT CHEST RIGHT CHEST CHIN LEFT CHEEK RIGHT CHEEK BILATERAL CHEST WALL (W/O BREAST) LEFT CHEST WALL RIGHT CHEST WALL BILATERAL CLAVICLE LEFT CLAVICLE RIGHT CLAVICLE COCCYX COLON WHOLE C.N.S. (MEDULLA TECHINQUE) CSF SPINE (MEDULL TECH 2 DIFF MACHI LEFT CHESTWALL BOOST RIGHT CHESTWALL BOOST BILATERAL CHESTWALL WITH NODES LEFT CHESTWALL WITH NODES RIGHT CHESTWALL WITH NODES LEFT EAR RIGHT EAR EPIGASTRIUM LOWER ESOPHAGUS MIDDLE ESOPHAGUS UPPER ESOPHAGUS ENTIRE ESOPHAGUS ETHMOID SINUS BILATERAL EYES LEFT EYE RIGHT EYE BILATERAL FACE LEFT FACE RIGHT FACE LEFT FALLOPIAN TUBES RIGHT FALLOPIAN TUBES BILATERAL FEMUR LEFT FEMUR RIGHT FEMUR LEFT FIBULA RIGHT FIBULA FINGER (INCLUDING THUMBS) FLOOR OF MOUTH (BOOSTS) BILATERAL FEET LEFT FOOT RIGHT FOOT FOREHEAD POSTERIOR FOSSA GALL BLADDER GINGIVA BILATERAL HAND LEFT HAND RIGHT HAND HEAD BILATERAL HEEL LEFT HEEL RIGHT HEEL LEFT HEMIMANTLE RIGHT HEMIMANTLE HEART BILATERAL HIP LEFT HIP RIGHT HIP LEFT HUMERUS RIGHT HUMERUS HYPOPHARYNX BILATERAL INTERNAL MAMMARY CHAIN BILATERAL INGUINAL NODES LEFT INGUINAL NODES RIGHT INGUINAL NODES INVERTED 'Y' (DOG-LEG,HOCKEY-STICK) LEFT KIDNEY RIGHT KIDNEY BILATERAL KNEE LEFT KNEE RIGHT KNEE BILATERAL LACRIMAL GLAND LEFT LACRIMAL GLAND RIGHT LACRIMAL GLAND LARYGOPHARYNX LARYNX BILATERAL LEG LEFT LEG RIGHT LEG LOWER BILATERAL LEG LOWER LEFT LEG LOWER RIGHT LEG UPPER BILATERAL LEG UPPER LEFT LEG UPPER RIGHT LEG BOTH EYELID(S) LEFT EYELID RIGHT EYELID BOTH LIP(S) LOWER LIP UPPER LIP LIVER BILATERAL LUNG LEFT LUNG RIGHT LUNG BILATERAL MANDIBLE LEFT MANDIBLE RIGHT MANDIBLE MANTLE BILATERAL MAXILLA LEFT MAXILLA RIGHT MAXILLA MEDIASTINUM MULTIPLE SKIN NASAL FOSSA NASOPHARYNX BILATERAL NECK INCLUDES NODES LEFT NECK INCLUDES NODES RIGHT NECK INCLUDES NODES NECK - SKIN NOSE ORAL CAVITY / BUCCAL MUCOSA BILATERAL ORBIT LEFT ORBIT RIGHT ORBIT OROPHARYNX BILATERAL OVARY LEFT OVARY RIGHT OVARY HARD PALATE SOFT PALATE PALATE UNSPECIFIED PANCREAS PARA-AORTIC NODES LEFT PAROTID RIGHT PAROTID BILATERAL PELVIS LEFT PELVIS RIGHT PELVIS PENIS PERINEUM PITUITARY LEFT PLEURA (AS IN MESOTHELIOMA) RIGHT PLEURA PROSTATE PUBIS PYRIFORM FOSSA (SINUSES) LEFT RADIUS RIGHT RADIUS RECTUM (INCLUDES SIGMOID) LEFT RIBS RIGHT RIBS SACRUM LEFT SALIVARY GLAND RIGHT SALIVARY GLAND BILATERAL SCAPULA LEFT SCAPULA RIGHT SCAPULA BILATERAL SUPRACLAVICULAR NODES LEFT SUPRACLAVICULAR NODES RIGHT SUPRACLAVICULAR NODES BILATERAL SCALP LEFT SCALP RIGHT SCALP SCROTUM BILATERAL SHOULDER LEFT SHOULDER RIGHT SHOULDER WHOLE BODY - SKIN SKULL CERVICAL & THORACIC SPINE SPHENOID SINUS CERVICAL SPINE LUMBAR SPINE THORACIC SPINE WHOLE SPINE SPLEEN LUMBO-SACRAL SPINE THORACIC & LUMBAR SPINE STERNUM STOMACH SUBMANDIBULAR GLANDS LEFT TEMPLE RIGHT TEMPLE BILATERAL TESTIS LEFT TESTIS RIGHT TESTIS THYROID LEFT TIBIA RIGHT TIBIA LEFT TOES RIGHT TOES TONGUE TONSIL TRACHEA LEFT ULNA RIGHT ULNA LEFT URETER RIGHT URETER URETHRA UTERUS UVULA VAGINA VULVA ABDOMEN BODY CHEST LOWER LIMB NECK OTHER PELVIS SKIN SPINE UPPER LIMB Not available
program_id
required
Program Id
string
radiation_boost
Any of:
uBooleanEnum
string
Allowed values: Yes No Not available
radiation_therapy_dosage
Any of:
integer
radiation_therapy_dosage_not_available
Radiation Therapy Dosage Not Available
boolean
radiation_therapy_fractions
Any of:
integer
radiation_therapy_fractions_not_available
Radiation Therapy Fractions Not Available
boolean
radiation_therapy_modality
Any of:
RadiationTherapyModalityEnum
string
Allowed values: Megavoltage radiation therapy using photons (procedure) Radiopharmaceutical Teleradiotherapy using electrons (procedure) Teleradiotherapy protons (procedure) Teleradiotherapy neutrons (procedure) Brachytherapy (procedure) Other Not available
radiation_therapy_type
Any of:
TherapyTypeEnum
string
Allowed values: External Internal Not available
reference_radiation_treatment_id
Any of:
string
<= 64 characters
submitter_donor_id
required
Submitter Donor Id
string
submitter_treatment_id
required
Submitter Treatment Id
string
sample_registrations
required
Sample Registrations
Array<object>
SampleRegistrationModelSchema
object
program_id
required
Program Id
string
sample_type
Any of:
SampleTypeEnum
string
Allowed values: Amplified DNA ctDNA Other DNA enrichments Other RNA fractions polyA+ RNA Protein rRNA-depleted RNA Total DNA Total RNA
specimen_tissue_source
Any of:
SpecimenTissueSourceEnum
string
Allowed values: Abdominal fluid Amniotic fluid Arterial blood Bile Blood derived - bone marrow Blood derived - peripheral blood Bone marrow fluid Bone marrow derived mononuclear cells Buccal cell Buffy coat Cerebrospinal fluid Cervical mucus Convalescent plasma Cord blood Duodenal fluid Female genital fluid Fetal blood Hydrocele fluid Male genital fluid Other Pancreatic fluid Pericardial effusion Pleural fluid Renal cyst fluid Saliva Seminal fluid Serum Solid tissue Sputum Synovial fluid Urine Venous blood Vitreous fluid Whole blood Wound
specimen_type
Any of:
SpecimenTypeEnum
string
Allowed values: Cell line - derived from normal Cell line - derived from primary tumour Cell line - derived from metastatic tumour Cell line - derived from xenograft tumour Metastatic tumour - additional metastatic Metastatic tumour - metastasis local to lymph node Metastatic tumour - metastasis to distant location Metastatic tumour Normal - tissue adjacent to primary tumour Normal Primary tumour - additional new primary Primary tumour - adjacent to normal Primary tumour Recurrent tumour Tumour - unknown if derived from primary or metastatic tumour Xenograft - derived from primary tumour Xenograft - derived from metastatic tumour Xenograft - derived from tumour cell line
submitter_donor_id
required
Submitter Donor Id
string
submitter_sample_id
required
Submitter Sample Id
string
<= 64 characters /^[A-Za-z0-9\-\._]{1,64}$/
submitter_specimen_id
required
Submitter Specimen Id
string
tumour_normal_designation
Any of:
TumourDesginationEnum
string
Allowed values: Normal Tumour
specimens
required
Specimens
Array<object>
SpecimenModelSchema
object
percent_tumour_cells_measurement_method
Any of:
CellsMeasureMethodEnum
string
Allowed values: Genomics Image analysis Pathology estimate by percent nuclei Other Not available
percent_tumour_cells_range
Any of:
PercentCellsRangeEnum
string
Allowed values: 0-19% 20-50% 51-100% Not available
program_id
required
Program Id
string
reference_pathology_confirmed_diagnosis
Any of:
ConfirmedDiagnosisTumourEnum
string
Allowed values: Yes No Not done Not available
reference_pathology_confirmed_tumour_presence
Any of:
ConfirmedDiagnosisTumourEnum
string
Allowed values: Yes No Not done Not available
specimen_anatomic_location
Any of:
string
<= 32 characters /^[C][0-9]{2}(.[0-9]{1})?$|^Not available$/
specimen_collection_date
Any of:
object
specimen_laterality
Any of:
SpecimenLateralityEnum
string
Allowed values: Left Not applicable Right Not available
specimen_processing
Any of:
SpecimenProcessingEnum
string
Allowed values: Cryopreservation in liquid nitrogen (dead tissue) Cryopreservation in dry ice (dead tissue) Cryopreservation of live cells in liquid nitrogen Cryopreservation - other Formalin fixed & paraffin embedded Formalin fixed - buffered Formalin fixed - unbuffered Fresh Other Not available
specimen_storage
Any of:
StorageEnum
string
Allowed values: Cut slide Frozen in -70 freezer Frozen in liquid nitrogen Frozen in vapour phase Not Applicable OCT embedded Other Paraffin block RNA later frozen Not available
submitter_donor_id
required
Submitter Donor Id
string
submitter_primary_diagnosis_id
required
Submitter Primary Diagnosis Id
string
submitter_specimen_id
required
Submitter Specimen Id
string
<= 64 characters /^[A-Za-z0-9\-\._]{1,64}$/
submitter_treatment_id
Any of:
string
<= 64 characters
tumour_grade
Any of:
TumourGradeEnum
string
Allowed values: Low grade High grade GX G1 G2 G3 G4 Low High Grade 1 Grade 2 Grade 3 Grade 4 Grade I Grade II Grade III Grade IV Grade Group 1 Grade Group 2 Grade Group 3 Grade Group 4 Grade Group 5 Not available
tumour_grading_system
Any of:
TumourGradingSystemEnum
string
Allowed values: FNCLCC grading system Four-tier grading system Gleason grade group system Grading system for GISTs Grading system for GNETs IASLC grading system ISUP grading system Nottingham grading system Nuclear grading system for DCIS Scarff-Bloom-Richardson grading system Three-tier grading system Two-tier grading system WHO grading system for CNS tumours Not available
tumour_histological_type
Any of:
string
<= 128 characters /^[8,9]{1}[0-9]{3}/[0,1,2,3,6,9]{1}[1-9]{0,1}$|^Not available$/
surgeries
required
Surgeries
Array<object>
SurgeryModelSchema
object
greatest_dimension_tumour
Any of:
integer
greatest_dimension_tumour_not_available
Greatest Dimension Tumour Not Available
boolean
lymphovascular_invasion
Any of:
LymphovascularInvasionEnum
string
Allowed values: Absent Both lymphatic and small vessel and venous (large vessel) invasion Lymphatic and small vessel invasion only Not applicable Present Venous (large vessel) invasion only Not available
margin_types_involved
Any of:
Array<string>
Allowed values: Circumferential resection margin Common bile duct margin Distal margin Not applicable Proximal margin Not available
margin_types_not_assessed
Any of:
Array<string>
Allowed values: Circumferential resection margin Common bile duct margin Distal margin Not applicable Proximal margin Not available
margin_types_not_involved
Any of:
Array<string>
Allowed values: Circumferential resection margin Common bile duct margin Distal margin Not applicable Proximal margin Not available
perineural_invasion
Any of:
PerineuralInvasionEnum
string
Allowed values: Absent Cannot be assessed Not applicable Present Not available
program_id
required
Program Id
string
residual_tumour_classification
Any of:
TumourClassificationEnum
string
Allowed values: Not applicable RX R0 R1 R2 Not available
submitter_donor_id
required
Submitter Donor Id
string
submitter_treatment_id
required
Submitter Treatment Id
string
surgery_location
Any of:
SurgeryLocationEnum
string
Allowed values: Local recurrence Metastatic Primary
surgery_reference_database
Any of:
SurgeryReferenceDatabaseEnum
string
Allowed values: SNOMED NCIt UMLS CCI
surgery_reference_identifier
Any of:
string
<= 64 characters
surgery_site
Any of:
string
<= 255 characters /^[C][0-9]{2}(.[0-9]{1})?$|^Not available$/
surgery_type
Any of:
string
<= 255 characters
tumour_focality
Any of:
TumourFocalityEnum
string
Allowed values: Cannot be assessed Multifocal Not applicable Unifocal Not available
tumour_length
Any of:
integer
tumour_length_not_available
Tumour Length Not Available
boolean
tumour_width
Any of:
integer
tumour_width_not_available
Tumour Width Not Available
boolean
systemic_therapies
required
Systemic Therapies
Array<object>
SystemicTherapyModelSchema
object
actual_cumulative_drug_dose
Any of:
number
actual_cumulative_drug_dose_not_available
Actual Cumulative Drug Dose Not Available
boolean
days_per_cycle
Any of:
integer
days_per_cycle_not_available
Days Per Cycle Not Available
boolean
drug_dose_units
Any of:
DosageUnitsEnum
string
Allowed values: mg/m2 IU/m2 IU/kg ug/m2 g/m2 mg/kg mg Not available
drug_name
Any of:
string
<= 255 characters
drug_reference_database
Any of:
DrugReferenceDbEnum
string
Allowed values: RxNorm PubChem NCI Thesaurus
drug_reference_identifier
Any of:
string
<= 64 characters
end_date
Any of:
object
number_of_cycles
Any of:
integer
number_of_cycles_not_available
Number Of Cycles Not Available
boolean
prescribed_cumulative_drug_dose
Any of:
number
prescribed_cumulative_drug_dose_not_available
Prescribed Cumulative Drug Dose Not Available
boolean
program_id
required
Program Id
string
start_date
Any of:
object
submitter_donor_id
required
Submitter Donor Id
string
submitter_treatment_id
required
Submitter Treatment Id
string
systemic_therapy_type
Any of:
string
<= 32 characters
treatments
required
Treatments
Array<object>
TreatmentModelSchema
object
is_primary_treatment
Any of:
uBooleanEnum
string
Allowed values: Yes No Not available
program_id
required
Program Id
string
response_to_treatment
Any of:
TreatmentResponseEnum
string
Allowed values: Complete response Partial response Progressive disease Stable disease Immune complete response (iCR) Immune partial response (iPR) Immune unconfirmed progressive disease (iUPD) Immune confirmed progressive disease (iCPD) Immune stable disease (iSD) Complete remission Partial remission Minor response Complete remission without measurable residual disease (CR MRD-) Complete remission with incomplete hematologic recovery (CRi) Morphologic leukemia-free state Primary refractory disease Hematologic relapse (after CR MRD-, CR, CRi) Molecular relapse (after CR MRD-) Physician assessed complete response Physician assessed partial response Physician assessed stable disease No evidence of disease (NED) Major response Not available
response_to_treatment_criteria_method
Any of:
TreatmentResponseMethodEnum
string
Allowed values: RECIST 1.1 iRECIST Cheson CLL 2012 Oncology Response Criteria Response Assessment in Neuro-Oncology (RANO) AML Response Criteria Physician Assessed Response Criteria Blazer score Not available
status_of_treatment
Any of:
TreatmentStatusEnum
string
Allowed values: Treatment completed as prescribed Treatment incomplete due to technical or organizational problems Treatment incomplete because patient died Patient choice (stopped or interrupted treatment) Physician decision (stopped or interrupted treatment) Treatment stopped due to lack of efficacy (disease progression) Treatment stopped due to acute toxicity Treatment ongoing Other Not available
submitter_donor_id
required
Submitter Donor Id
string
submitter_primary_diagnosis_id
required
Submitter Primary Diagnosis Id
string
submitter_treatment_id
required
Submitter Treatment Id
string
<= 64 characters /^[A-Za-z0-9\-\._]{1,64}$/
treatment_end_date
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
treatment_intent
Any of:
TreatmentIntentEnum
string
Allowed values: Curative Palliative Supportive Diagnostic Preventive Guidance Screening Forensic Not available
treatment_start_date
Any of:
DateInterval
object
day_interval
Any of:
integer
month_interval
required
Month Interval

Number of months since first diagnosis

integer
treatment_type
Any of:
Array<string>
Allowed values: Bone marrow transplant Systemic therapy No treatment Targeted molecular therapy Photodynamic therapy Radiation therapy Stem cell transplant Surgery Other
summary
required
SummaryMessageSchema
object
message
required
Message
string
record_counts
required
Record Counts
object
key
additional properties
integer
Example
{
  "data": {
    "biomarkers": [
      {
        "ca125_not_available": false,
        "cea_not_available": false,
        "er_percent_positive_not_available": false,
        "er_status": "Cannot be determined",
        "her2_ihc_status": "Cannot be determined",
        "her2_ish_status": "Cannot be determined",
        "hpv_ihc_status": "Cannot be determined",
        "hpv_pcr_status": "Cannot be determined",
        "hpv_strain": [
          "HPV16"
        ],
        "pr_percent_positive_not_available": false,
        "pr_status": "Cannot be determined",
        "psa_level_not_available": false
      }
    ],
    "comorbidities": [
      {
        "age_at_comorbidity_diagnosis_not_available": false,
        "comorbidity_treatment_status": "Yes",
        "laterality_of_prior_malignancy": "Bilateral",
        "prior_malignancy": "Yes"
      }
    ],
    "donors": [
      {
        "cause_of_death": "Died of cancer",
        "gender": "Man",
        "is_deceased": "Yes",
        "lost_to_followup_reason": "Completed study",
        "sex_at_birth": "Male"
      }
    ],
    "exposures": [
      {
        "pack_years_smoked_not_available": false,
        "tobacco_smoking_status": "Current reformed smoker for <= 15 years",
        "tobacco_type": [
          "Chewing Tobacco"
        ]
      }
    ],
    "follow_ups": [
      {
        "disease_status_at_followup": "Complete remission",
        "method_of_progression_status": [
          "Imaging (procedure)"
        ],
        "relapse_type": "Distant recurrence/metastasis"
      }
    ],
    "primary_diagnoses": [
      {
        "basis_of_diagnosis": "Clinical investigation",
        "clinical_m_category": "M0",
        "clinical_n_category": "N0",
        "clinical_stage_group": "Stage 0",
        "clinical_t_category": "T0",
        "clinical_tumour_staging_system": "AJCC cancer staging system",
        "laterality": "Bilateral",
        "pathological_m_category": "M0",
        "pathological_n_category": "N0",
        "pathological_stage_group": "Stage 0",
        "pathological_t_category": "T0",
        "pathological_tumour_staging_system": "AJCC cancer staging system",
        "primary_site": "Accessory sinuses"
      }
    ],
    "radiations": [
      {
        "anatomical_site_irradiated": "LEFT ABDOMEN",
        "radiation_boost": "Yes",
        "radiation_therapy_dosage_not_available": false,
        "radiation_therapy_fractions_not_available": false,
        "radiation_therapy_modality": "Megavoltage radiation therapy using photons (procedure)",
        "radiation_therapy_type": "External"
      }
    ],
    "sample_registrations": [
      {
        "sample_type": "Amplified DNA",
        "specimen_tissue_source": "Abdominal fluid",
        "specimen_type": "Cell line - derived from normal",
        "tumour_normal_designation": "Normal"
      }
    ],
    "specimens": [
      {
        "percent_tumour_cells_measurement_method": "Genomics",
        "percent_tumour_cells_range": "0-19%",
        "reference_pathology_confirmed_diagnosis": "Yes",
        "reference_pathology_confirmed_tumour_presence": "Yes",
        "specimen_laterality": "Left",
        "specimen_processing": "Cryopreservation in liquid nitrogen (dead tissue)",
        "specimen_storage": "Cut slide",
        "tumour_grade": "Low grade",
        "tumour_grading_system": "FNCLCC grading system"
      }
    ],
    "surgeries": [
      {
        "greatest_dimension_tumour_not_available": false,
        "lymphovascular_invasion": "Absent",
        "margin_types_involved": [
          "Circumferential resection margin"
        ],
        "margin_types_not_assessed": [
          "Circumferential resection margin"
        ],
        "margin_types_not_involved": [
          "Circumferential resection margin"
        ],
        "perineural_invasion": "Absent",
        "residual_tumour_classification": "Not applicable",
        "surgery_location": "Local recurrence",
        "surgery_reference_database": "SNOMED",
        "tumour_focality": "Cannot be assessed",
        "tumour_length_not_available": false,
        "tumour_width_not_available": false
      }
    ],
    "systemic_therapies": [
      {
        "actual_cumulative_drug_dose_not_available": false,
        "days_per_cycle_not_available": false,
        "drug_dose_units": "mg/m2",
        "drug_reference_database": "RxNorm",
        "number_of_cycles_not_available": false,
        "prescribed_cumulative_drug_dose_not_available": false
      }
    ],
    "treatments": [
      {
        "is_primary_treatment": "Yes",
        "response_to_treatment": "Complete response",
        "response_to_treatment_criteria_method": "RECIST 1.1",
        "status_of_treatment": "Treatment completed as prescribed",
        "treatment_intent": "Curative",
        "treatment_type": [
          "Bone marrow transplant"
        ]
      }
    ]
  }
}