Class: Family Relationship (FamilyRelationship)

A relationship between individuals in a pedigree or family.

classDiagram class FamilyRelationship click FamilyRelationship href "../FamilyRelationship/" FamilyRelationship : family_relationship_id FamilyRelationship : knowledge_source FamilyRelationship --> "1" EnumRelationshipKnowledgeSource : knowledge_source click EnumRelationshipKnowledgeSource href "../EnumRelationshipKnowledgeSource/" FamilyRelationship : patient_id FamilyRelationship --> "1" Participant : patient_id click Participant href "../Participant/" FamilyRelationship : relationship FamilyRelationship --> "1" EnumFamilyRelationship : relationship click EnumFamilyRelationship href "../EnumFamilyRelationship/" FamilyRelationship : relative_id FamilyRelationship --> "1" Participant : relative_id click Participant href "../Participant/"

Slots

Name	Cardinality and Range	Description	Inheritance
family_relationship_id	1 String	Family Relationship Global ID	direct
patient_id	1 Participant	The child from the parent-child relationship	direct
relative_id	1 Participant	The parent from the parent-child relationship	direct
relationship	1 EnumFamilyRelationship	The role the relative (parent) fills with respect to the patient (child) for ...	direct
knowledge_source	1 EnumRelationshipKnowledgeSource	The source for the reltionship term	direct

Identifier and Mapping Information

Annotations

property	value
fhir_resource	FamilyMemberHistory
fhir_profile	http://purl.org/ga4gh/pedigree-fhir-ig/StructureDefinition/PedigreeRelationship

Schema Source

from schema: https://carrollaboratory.github.io/kfi-fhir-input

Mappings

Mapping Type	Mapped Value
self	kfi_fhir_sparks:FamilyRelationship
native	kfi_fhir_sparks:FamilyRelationship

LinkML Source

Direct

name: FamilyRelationship
annotations:
  fhir_resource:
    tag: fhir_resource
    value: FamilyMemberHistory
  fhir_profile:
    tag: fhir_profile
    value: http://purl.org/ga4gh/pedigree-fhir-ig/StructureDefinition/PedigreeRelationship
description: A relationship between individuals in a pedigree or family.
title: Family Relationship
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
slots:
- family_relationship_id
- patient_id
- relative_id
- relationship
- knowledge_source

Induced

name: FamilyRelationship
annotations:
  fhir_resource:
    tag: fhir_resource
    value: FamilyMemberHistory
  fhir_profile:
    tag: fhir_profile
    value: http://purl.org/ga4gh/pedigree-fhir-ig/StructureDefinition/PedigreeRelationship
description: A relationship between individuals in a pedigree or family.
title: Family Relationship
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
attributes:
  family_relationship_id:
    name: family_relationship_id
    description: Family Relationship Global ID
    title: Family Relationship Global ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: true
    alias: family_relationship_id
    owner: FamilyRelationship
    domain_of:
    - FamilyRelationship
    range: string
    required: true
  patient_id:
    name: patient_id
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-family-relationship
      fhir_element:
        tag: fhir_element
        value: patient
      fhir_resource:
        tag: fhir_resource
        value: FamilyMemberHistory
    description: The child from the parent-child relationship
    title: Patient (Child)
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: false
    alias: patient_id
    owner: FamilyRelationship
    domain_of:
    - FamilyRelationship
    range: Participant
    required: true
    multivalued: false
  relative_id:
    name: relative_id
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-family-relationship
      fhir_element:
        tag: fhir_element
        value: extension[relative]
      fhir_resource:
        tag: fhir_resource
        value: FamilyMemberHistory
      db_column:
        tag: db_column
        value: relative_id
      target_slot:
        tag: target_slot
        value: participant_id
    description: The parent from the parent-child relationship
    title: Relative (Parent)
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: false
    alias: relative_id
    owner: FamilyRelationship
    domain_of:
    - FamilyRelationship
    range: Participant
    required: true
    multivalued: false
  relationship:
    name: relationship
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-family-relationship
      fhir_element:
        tag: fhir_element
        value: relationship
      fhir_resource:
        tag: fhir_resource
        value: FamilyMemberHistory
    description: The role the relative (parent) fills with respect to the patient
      (child) for this relationship.
    title: Relationship
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: false
    alias: relationship
    owner: FamilyRelationship
    domain_of:
    - FamilyRelationship
    range: EnumFamilyRelationship
    required: true
    multivalued: false
  knowledge_source:
    name: knowledge_source
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-family-relationship
      fhir_element:
        tag: fhir_element
        value: relationship
      fhir_resource:
        tag: fhir_resource
        value: exception[KnowledgeSource]
    description: The source for the reltionship term
    title: Knowledge Source
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: false
    alias: knowledge_source
    owner: FamilyRelationship
    domain_of:
    - FamilyRelationship
    range: EnumRelationshipKnowledgeSource
    required: true
    multivalued: false