Create Followups

POST

/v3/ingest/followups/

const url = 'https://example.com/v3/ingest/followups/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '[{"anatomic_site_progression_or_recurrence":["example"],"date_of_followup":{"day_interval":1,"month_interval":1},"date_of_relapse":{"day_interval":1,"month_interval":1},"disease_status_at_followup":"Complete remission","method_of_progression_status":["Imaging (procedure)"],"program_id":"example","relapse_type":"Distant recurrence/metastasis","submitter_donor_id":"example","submitter_follow_up_id":"example","submitter_primary_diagnosis_id":"example","submitter_treatment_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/followups/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "anatomic_site_progression_or_recurrence": [ "example" ], "date_of_followup": { "day_interval": 1, "month_interval": 1 }, "date_of_relapse": { "day_interval": 1, "month_interval": 1 }, "disease_status_at_followup": "Complete remission", "method_of_progression_status": [ "Imaging (procedure)" ], "program_id": "example", "relapse_type": "Distant recurrence/metastasis", "submitter_donor_id": "example", "submitter_follow_up_id": "example", "submitter_primary_diagnosis_id": "example", "submitter_treatment_id": "example", "uuid": "example" } ]'

Authorizations

IngestAuth
ServiceTokenAuth

Request Body^required

application/json

Payload

Array<object>

FollowUpIngestSchema

object

anatomic_site_progression_or_recurrence

Any of:

Array<string>
null

Array<string>

date_of_followup

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

date_of_relapse

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

disease_status_at_followup

Any of:

DiseaseStatusFollowupEnum
null

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>
null

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
null

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
null

string

submitter_treatment_id

Any of:

string
null

string

uuid

Any of:

string
null

string

Create Followups

Authorizations

Request Body^required

Responses

200

Create Followups

Authorizations

Request Body required

Responses

200

Request Body^required