Class: Family Member (FamilyMember)

Designates a Subject as a member of a family with a specified role.

classDiagram class FamilyMember click FamilyMember href "../FamilyMember/" Record <|-- FamilyMember click Record href "../Record/" FamilyMember : access_policy_id FamilyMember --> "0..1" AccessPolicy : access_policy_id click AccessPolicy href "../AccessPolicy/" FamilyMember : external_id FamilyMember : family_id FamilyMember --> "1" Family : family_id click Family href "../Family/" FamilyMember : family_role FamilyMember : study_id FamilyMember --> "0..1" Study : study_id click Study href "../Study/" FamilyMember : subject_id FamilyMember --> "1" Subject : subject_id click Subject href "../Subject/"

Inheritance

Record
- FamilyMember

Slots

Name	Cardinality and Range	Description	Inheritance
family_id	1 Family	Global ID for the Family	direct
subject_id	1 Subject	INCLUDE Global ID for the Subject	direct
family_role	0..1 Uriorcurie	The "role" of this individual in this family	direct
external_id	* Uriorcurie	Other identifiers for this entity, eg, from the submitting study or in system...	Record
access_policy_id	0..1 AccessPolicy	Global identifier for the access policy that applies to this row of data	Record
study_id	0..1 Study	INCLUDE Global ID for the study	Record

Identifier and Mapping Information

Schema Source

from schema: https://includedcc.org/include-access-model

Mappings

Mapping Type	Mapped Value
self	includedcc:FamilyMember
native	includedcc:FamilyMember

LinkML Source

Direct

name: FamilyMember
description: Designates a Subject as a member of a family with a specified role.
title: Family Member
from_schema: https://includedcc.org/include-access-model
is_a: Record
slots:
- family_id
- subject_id
- family_role
slot_usage:
  family_id:
    name: family_id
    required: true
  subject_id:
    name: subject_id
    required: true
unique_keys:
  main:
    unique_key_name: main
    unique_key_slots:
    - family_id
    - subject_id
    description: Family membership is defined by family and subject ids.

Induced

name: FamilyMember
description: Designates a Subject as a member of a family with a specified role.
title: Family Member
from_schema: https://includedcc.org/include-access-model
is_a: Record
slot_usage:
  family_id:
    name: family_id
    required: true
  subject_id:
    name: subject_id
    required: true
attributes:
  family_id:
    name: family_id
    description: Global ID for the Family
    title: Family ID
    from_schema: https://includedcc.org/include-access-model
    rank: 1000
    alias: family_id
    owner: FamilyMember
    domain_of:
    - Family
    - FamilyMember
    range: Family
    required: true
  subject_id:
    name: subject_id
    description: INCLUDE Global ID for the Subject
    title: Study ID
    from_schema: https://includedcc.org/include-access-model
    rank: 1000
    alias: subject_id
    owner: FamilyMember
    domain_of:
    - Subject
    - Demographics
    - FamilyRelationship
    - FamilyMember
    - SubjectAssertion
    - Encounter
    - File
    range: Subject
    required: true
    multivalued: false
  family_role:
    name: family_role
    description: The "role" of this individual in this family. Could include terms
      like "proband", "mother", etc.
    from_schema: https://includedcc.org/include-access-model
    rank: 1000
    alias: family_role
    owner: FamilyMember
    domain_of:
    - FamilyMember
    range: uriorcurie
  external_id:
    name: external_id
    description: Other identifiers for this entity, eg, from the submitting study
      or in systems like dbGaP
    title: External Identifiers
    from_schema: https://includedcc.org/include-access-model
    rank: 1000
    alias: external_id
    owner: FamilyMember
    domain_of:
    - Record
    range: uriorcurie
    required: false
    multivalued: true
  access_policy_id:
    name: access_policy_id
    description: Global identifier for the access policy that applies to this row
      of data.
    title: Access Policy ID
    from_schema: https://includedcc.org/include-access-model
    rank: 1000
    alias: access_policy_id
    owner: FamilyMember
    domain_of:
    - Record
    - AccessPolicy
    range: AccessPolicy
  study_id:
    name: study_id
    description: INCLUDE Global ID for the study
    title: Study ID
    from_schema: https://includedcc.org/include-access-model
    rank: 1000
    alias: study_id
    owner: FamilyMember
    domain_of:
    - Record
    - StudyMetadata
    range: Study
    multivalued: false
unique_keys:
  main:
    unique_key_name: main
    unique_key_slots:
    - family_id
    - subject_id
    description: Family membership is defined by family and subject ids.