> For the complete documentation index, see [llms.txt](https://docs.opencga.opencb.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opencga.opencb.org/develop-2/data-models/family.md). # Family ## Overview Family data model hosts information about any family. ### Summary | Field | Create | Update | Unique | Required | | ---------------- | :-----------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | | id | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | | uuid | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | name | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | members | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | phenotypes | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | disorders | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | qualityControl | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | creationDate | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | modificationDate | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | expectedSize | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | description | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | status | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | internal | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | roles | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | attributes | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/yes.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | release | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | | version | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ![](https://github.com/opencb/opencga/blob/develop/docs/data-models/no.png?raw=true) | ## Data Model ### Family You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/family/Family.java). | Field | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

id
String

| Family is a mandatory parameter when creating a new sample, this ID cannot be changed at the moment. | |

uuid
String

| Unique 32-character identifier assigned automatically by OpenCGA. | |

name
String

| Family name. | |

members
List<Individual>

| List of individuals who are family members. | |

phenotypes
List<Phenotype>

| List of phenotypes . | |

disorders
List<Disorder>

| Family disorders. | |

qualityControl
FamilyQualityControl

| Contains different metrics to evaluate the quality of the individual. | |

creationDate
String

since: 1.0

| Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was first registered. | |

modificationDate
String

since: 1.0

| Autogenerated date following the format YYYYMMDDhhmmss containing the date when the entry was last modified. | |

expectedSize
int

| Family expected size. | |

description
String

| Users may provide a description for the entry. | |

status
Status

since: 2.0

| Object to set a custom status. | |

internal
FamilyInternal

since: 2.0

| Internal field for manage the object. | |

roles
Map\

| Map of members ids and enum of roles (FATHER, MOTHER, IDENTICAL\_TWIN, SON, UNCLE, PATERNAL\_GRANDFATHER.) . | |

attributes
Map\

since: 1.0

| You can use this field to store any other information, keep in mind this is not indexed so you cannot search by attributes. | |

release
int

| An integer describing the current data release. | |

version
int

| Autoincremental version assigned to the registered entry. By default, updates does not create new versions. To enable versioning, users must set the `incVersion` flag from the /update web service when updating the document. | ### Status You can find the Java code [here](https://github.com/opencb/biodata/tree/develop/biodata-models/src/main/java/org/opencb/biodata/models/common/Status.java). ### FamilyInternal You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/family/FamilyInternal.java). | Field | Description | | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | |

status
InternalStatus

| Status of the internal object. | |

registrationDate
String

| Registration date of the internal object. | |

lastModified
String

| Date of the last modification of the internal object. | ### Phenotype You can find the Java code [here](https://github.com/opencb/biodata/tree/develop/biodata-models/src/main/java/org/opencb/biodata/models/clinical/Phenotype.java). | Field | Description | | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | |

id
String

| Id to identify the object | |

ageOfOnset
String

| Indicates the age of on set of the phenotype | |

status
Status

| Status of phenotype OBSERVED, NOT\_OBSERVED, UNKNOWN | |

name
String

| Object name | |

description
String

| Users may provide a description for the entry. | |

source
String

| Ontology source | |

url
String

| Ontology url | |

attributes
Map\

| Dictionary that can be customised by users to store any additional information users may require.. | ### FamilyQualityControl You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/family/FamilyQualityControl.java). | Field | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | |

relatedness
List<RelatednessReport>

| Reports of family relationship. | |

files
List\

| File IDs related to the quality control. | |

comments
List<ClinicalComment>

| Comments related to the quality control. | ### Disorder You can find the Java code [here](https://github.com/opencb/biodata/tree/develop/biodata-models/src/main/java/org/opencb/biodata/models/clinical/Disorder.java). | Field | Description | | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | |

id
String

| Id to identify the object | |

name
String

| Object name | |

description
String

| Users may provide a description for the entry. | |

source
String

| Ontology source | |

url
String

| Ontology url | |

attributes
Map\

| Dictionary that can be customised by users to store any additional information users may require.. | ### RelatednessReport You can find the Java code [here](https://github.com/opencb/biodata/tree/develop/biodata-models/src/main/java/org/opencb/biodata/models/clinical/qc/RelatednessReport.java). | Field | Description | | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | |

method
String

| Method of the relatedness report | |

maf
String

| Minor allele frequency to filter variants, e.g.: 1kg\_phase3:CEU>0.35, cohort:ALL>0.05 | |

scores
List\

| Relatedness scores for pair of samples | |

files
List\

| List of files of Relatedness Report | ### InternalStatus You can find the Java code [here](https://github.com/opencb/opencga/tree/TASK-1587/opencga-core/src/main/java/org/opencb/opencga/core/models/common/InternalStatus.java). ### ClinicalComment You can find the Java code [here](https://github.com/opencb/biodata/tree/develop/biodata-models/src/main/java/org/opencb/biodata/models/clinical/ClinicalComment.java). | Field | Description | | ---------------------------------------------------------- | ------------------------------------- | |

author
String

| Clinical comment author | |

message
String

| Clinical comment message | |

tags
List\

| List of tags for the clinical comment | |

date
String

| Date of the clinical comment | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.opencga.opencb.org/develop-2/data-models/family.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.