Create Surgeries

POST

/v3/ingest/surgeries/

curl --request POST \
  --url https://example.com/v3/ingest/surgeries/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "greatest_dimension_tumour": 1, "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", "program_id": "example", "residual_tumour_classification": "Not applicable", "submitter_donor_id": "example", "submitter_treatment_id": "example", "surgery_location": "Local recurrence", "surgery_reference_database": "SNOMED", "surgery_reference_identifier": "example", "surgery_site": "example", "surgery_type": "example", "tumour_focality": "Cannot be assessed", "tumour_length": 1, "tumour_length_not_available": false, "tumour_width": 1, "tumour_width_not_available": false, "uuid": "example" } ]'

Authorizations

• IngestAuth
• ServiceTokenAuth

Request Body ^required

Media type application/json

Payload

Array<object>

SurgeryIngestSchema

object

greatest_dimension_tumour

Any of:

integer

integer

null

null

greatest_dimension_tumour_not_available

Greatest Dimension Tumour Not Available

boolean

lymphovascular_invasion

Any of:

LymphovascularInvasionEnum

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

null

null

margin_types_involved

Any of:

Array<string>

Array<string>

Allowed values: Circumferential resection margin Common bile duct margin Distal margin Not applicable Proximal margin Not available

null

null

margin_types_not_assessed

Any of:

Array<string>

Array<string>

Allowed values: Circumferential resection margin Common bile duct margin Distal margin Not applicable Proximal margin Not available

null

null

margin_types_not_involved

Any of:

Array<string>

Array<string>

Allowed values: Circumferential resection margin Common bile duct margin Distal margin Not applicable Proximal margin Not available

null

null

perineural_invasion

Any of:

PerineuralInvasionEnum

PerineuralInvasionEnum

string

Allowed values: Absent Cannot be assessed Not applicable Present Not available

null

null

program_id

required

Program Id

string

residual_tumour_classification

Any of:

TumourClassificationEnum

TumourClassificationEnum

string

Allowed values: Not applicable RX R0 R1 R2 Not available

null

null

submitter_donor_id

required

Submitter Donor Id

string

submitter_treatment_id

required

Submitter Treatment Id

string

surgery_location

Any of:

SurgeryLocationEnum

SurgeryLocationEnum

string

Allowed values: Local recurrence Metastatic Primary

null

null

surgery_reference_database

Any of:

SurgeryReferenceDatabaseEnum

SurgeryReferenceDatabaseEnum

string

Allowed values: SNOMED NCIt UMLS CCI

null

null

surgery_reference_identifier

Any of:

string

string

<= 64 characters

null

null

surgery_site

Any of:

string

string

<= 255 characters /^[C][0-9]{2}(.[0-9]{1})?$|^Not available$/

null

null

surgery_type

Any of:

string

string

<= 255 characters

null

null

tumour_focality

Any of:

TumourFocalityEnum

TumourFocalityEnum

string

Allowed values: Cannot be assessed Multifocal Not applicable Unifocal Not available

null

null

tumour_length

Any of:

integer

integer

null

null

tumour_length_not_available

Tumour Length Not Available

boolean

tumour_width

Any of:

integer

integer

null

null

tumour_width_not_available

Tumour Width Not Available

boolean

uuid

Any of:

string

string

null

null

Responses

200

OK