FamilyHistory

Summary of SMaHT Portal object type FamilyHistory . 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 FamilyHistory data here

Required Properties

Property	Type	Description
disease	string	See below for more details.
donor	Donor string	See below for more details.
relatives	array of enum	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.

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
donor	Donor 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.]
consortia	Consortium • array of string • unique	Consortia associated with this item. See values here
disease	string	The disease or condition that is being reported.
display_title	string • calculated	-
donor	Donor • string	The donor of the family history.
relatives  • Aunt  • Brother  • Child  • Cousin  • Daughter  • Father  • Grandfather  • Grandmother  • Grandparent  • Mother  • Nephew  • Niece  • Parent  • Sibling  • Sister  • Son  • Uncle  • Unspecified	array of enum • min items: 1 • unique	The relatives affected by the disease.
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,}_FAMILY-HISTORY_[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|_-]+$
uuid	string	Unique ID by which this object is identified.