MedicalTreatment

Summary of SMaHT Portal object type MedicalTreatment . Property names in red are required properties; those in blue are identifying properties; and properties with types in green are reference properties.

Tip

See actual MedicalTreatment data here

Required Properties

Property Type Description
category array of enum See below for more details.
medical_history MedicalHistory
string 		See below for more details.
submission_centers SubmissionCenter
array of string 		See below for more details.
See values here
submitted_id string See below for more details.
title string See below for more details.

Identifying Properties

Property Type Description
accession string See below for more details.
submitted_id string See below for more details.
uuid string See below for more details.

Reference Properties

Property Type Description
consortia Consortium
array of string 		See below for more details.
See values here
diagnosis Diagnosis
string 		See below for more details.
medical_history MedicalHistory
string 		See below for more details.
submission_centers SubmissionCenter
array of string 		See below for more details.
See values here

Properties

Property Type Description
accession string A unique identifier to be used to reference the object. [Only admins are allowed to set or update this value.]
alternate_accessions array of string
• restricted
 Accessions previously assigned to objects that have been merged with this object. [Only admins are allowed to set or update this value.]
category
 • Chemotherapy
 • Radiation
 • Surgery 		array of enum
• min items: 1
• unique
 Type of treatment.
comments string Additional information on the treatment.
consortia Consortium
• array of string
• unique
 Consortia associated with this item.
See values here
counts integer
• min value: 1
 Number of times the treatment was performed.
diagnosis Diagnosis
• string
 Link to the associated diagnosis.
display_title string
• calculated
 -
medical_history MedicalHistory
• string
 Link to the associated medical history.
status
 • deleted
 • draft
 • in review ← default
 • obsolete
 • public
 • released
 • restricted 		enum of string
• default: in review
 -
submission_centers SubmissionCenter
• array of string
• unique
 Submission Centers that created this item.
See values here
submitted_id string Unique identifier for the item assigned by the submitter.
Must adhere to (regex) pattern: ^[A-Z0-9]{3,}_MEDICAL-TREATMENT_[A-Z0-9-_.]{4,}$
tags array of string
• min string length: 1
• max string length: 50
• unique
• restricted
 Key words that can tag an item - useful for filtering.
Must adhere to (regex) pattern: ^[a-zA-Z0-9|_-]+$
title string
• min length: 3
 Name of the treatment.
uuid string Unique ID by which this object is identified.
year_end integer
• min value: 1900
• max value: 2100
 Year in which the treatment was last administered.
year_start integer
• min value: 1900
• max value: 2100
 Year in which the treatment was first administered.