Create Primary Diagnoses

POST

/v3/ingest/primary_diagnoses/

const url = 'https://example.com/v3/ingest/primary_diagnoses/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '[{"basis_of_diagnosis":"Clinical investigation","cancer_type_code":"example","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","date_of_diagnosis":{"day_interval":1,"month_interval":1},"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","program_id":"example","submitter_donor_id":"example","submitter_primary_diagnosis_id":"example","uuid":"example"}]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v3/ingest/primary_diagnoses/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "basis_of_diagnosis": "Clinical investigation", "cancer_type_code": "example", "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", "date_of_diagnosis": { "day_interval": 1, "month_interval": 1 }, "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", "program_id": "example", "submitter_donor_id": "example", "submitter_primary_diagnosis_id": "example", "uuid": "example" } ]'

Authorizations

IngestAuth
ServiceTokenAuth

Request Body^required

application/json

Payload

Array<object>

PrimaryDiagnosisIngestSchema

object

basis_of_diagnosis

Any of:

BasisOfDiagnosisEnum
null

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
null

string

<= 64 characters

clinical_m_category

Any of:

MCategoryEnum
null

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
null

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
null

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
null

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
null

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
null

DateInterval

object

day_interval

Any of:

integer
null

integer

month_interval

required

Month Interval

Number of months since first diagnosis

integer

laterality

Any of:

PrimaryDiagnosisLateralityEnum
null

PrimaryDiagnosisLateralityEnum

string

Allowed values: Bilateral Left Midline Not a paired site Right Unilateral, side not specified Not available

pathological_m_category

Any of:

MCategoryEnum
null

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
null

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
null

StageGroupEnum

string

pathological_t_category

Any of:

TCategoryEnum
null

TCategoryEnum

string

pathological_tumour_staging_system

Any of:

TumourStagingSystemEnum
null

TumourStagingSystemEnum

string

primary_site

Any of:

PrimarySiteEnum
null

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}$/

uuid

Any of:

string
null

string

Create Primary Diagnoses

Authorizations

Request Body^required

Responses

200

Create Primary Diagnoses

Authorizations

Request Body required

Responses

200

Request Body^required