Skip to content

Class: Family (Family)

Group of Participants that are related.

URI: kfi_fhir_sparks:Family

classDiagram class Family click Family href "../Family/" HasExternalId <|-- Family click HasExternalId href "../HasExternalId/" Family : consanguinity Family --> "0..1" EnumConsanguinity : consanguinity click EnumConsanguinity href "../EnumConsanguinity/" Family : description Family : external_id Family : family_focus Family : family_global_id Family : family_id Family : family_type Family --> "1" EnumFamilyType : family_type click EnumFamilyType href "../EnumFamilyType/"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
family_global_id 1
String		 Family Global ID direct
family_id 1
String		 External ID common to all family members direct
family_type 1
EnumFamilyType		 Describes the 'type' of study family, eg, trio direct
description 0..1
String		 More details associated with the given resource direct
consanguinity 0..1
EnumConsanguinity		 Is there known or suspected consanguinity in this study family? direct
family_focus 0..1
Uriorcurie		 What is this study family investigating? EG, a specific condition direct
external_id *
Uriorcurie		 Other identifiers for this entity, eg, from the submitting study or in system... HasExternalId

Usages

used by used in type used
Participant family_global_id range Family

Identifier and Mapping Information

Annotations

property value
fhir_resource Group
fhir_profile https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-study-family

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Family
annotations:
  fhir_resource:
    tag: fhir_resource
    value: Group
  fhir_profile:
    tag: fhir_profile
    value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-study-family
description: Group of Participants that are related.
title: Family
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slots:
- family_global_id
- family_id
- family_type
- description
- consanguinity
- family_focus
slot_usage:
  family_global_id:
    name: family_global_id
    identifier: true
    range: string
    required: true

Induced

name: Family
annotations:
  fhir_resource:
    tag: fhir_resource
    value: Group
  fhir_profile:
    tag: fhir_profile
    value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-study-family
description: Group of Participants that are related.
title: Family
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slot_usage:
  family_global_id:
    name: family_global_id
    identifier: true
    range: string
    required: true
attributes:
  family_global_id:
    name: family_global_id
    description: Family Global ID
    title: Family Global ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: true
    alias: family_global_id
    owner: Family
    domain_of:
    - Participant
    - Family
    range: string
    required: true
  family_id:
    name: family_id
    description: External ID common to all family members
    title: Family ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: family_id
    owner: Family
    domain_of:
    - Family
    range: string
    required: true
    multivalued: false
  family_type:
    name: family_type
    description: Describes the 'type' of study family, eg, trio.
    title: Family Type
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: family_type
    owner: Family
    domain_of:
    - Family
    range: EnumFamilyType
    required: true
    multivalued: false
  description:
    name: description
    description: More details associated with the given resource
    title: Description
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: description
    owner: Family
    domain_of:
    - AccessPolicy
    - Practitioner
    - ResearchStudy
    - ResearchStudyCollection
    - NCPIFile
    - Family
    range: string
    required: false
  consanguinity:
    name: consanguinity
    description: Is there known or suspected consanguinity in this study family?
    title: Consanguinity
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: consanguinity
    owner: Family
    domain_of:
    - Family
    range: EnumConsanguinity
    required: false
    multivalued: false
  family_focus:
    name: family_focus
    description: What is this study family investigating? EG, a specific condition
    title: Family Focus
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: family_focus
    owner: Family
    domain_of:
    - Family
    range: uriorcurie
    required: false
    multivalued: false
  external_id:
    name: external_id
    description: Other identifiers for this entity, eg, from the submitting study
      or in systems link dbGaP
    title: External Identifiers
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: external_id
    owner: Family
    domain_of:
    - HasExternalId
    range: uriorcurie
    required: false
    multivalued: true