Skip to content

Class: Participant (Participant)

Research oriented patient

URI: kfi_fhir_sparks:Participant

classDiagram class Participant click Participant href "../Participant/" HasExternalId <|-- Participant click HasExternalId href "../HasExternalId/" Participant : age_at_last_vital Participant : birthsex Participant --> "0..1" EnumBirthSex : birthsex click EnumBirthSex href "../EnumBirthSex/" Participant : deceased_rel Participant --> "0..1" RelativeDateTime : deceased_rel click RelativeDateTime href "../RelativeDateTime/" Participant : dob Participant : dob_method Participant --> "0..1" EnumDobMethod : dob_method click EnumDobMethod href "../EnumDobMethod/" Participant : ethnicity Participant --> "1" EnumEthnicity : ethnicity click EnumEthnicity href "../EnumEthnicity/" Participant : external_id Participant : family_global_id Participant --> "0..1" Family : family_global_id click Family href "../Family/" Participant : is_deceased Participant : participant_id Participant : patient_knowledge_source Participant --> "0..1" EnumPatientKnowledgeSource : patient_knowledge_source click EnumPatientKnowledgeSource href "../EnumPatientKnowledgeSource/" Participant : population Participant --> "0..1" EnumPopulation : population click EnumPopulation href "../EnumPopulation/" Participant : race Participant --> "1..*" EnumRace : race click EnumRace href "../EnumRace/" Participant : sample_id Participant --> "*" Sample : sample_id click Sample href "../Sample/"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
participant_id 1
String		 The Global ID for the Participant direct
birthsex 0..1
EnumBirthSex		 Sex assigned at birth (or pre-natal observed sex) direct
race 1..*
EnumRace		 Reported race as defined by the 1997 OMB directives direct
ethnicity 1
EnumEthnicity		 Reported ethnicity as defined by the 1997 OMB directives direct
population 0..1
EnumPopulation		 opulation, Race, and/or Ethnicity information direct
dob 0..1
String		 Date of Birth of the participant direct
dob_method 0..1
EnumDobMethod		 Specifies method used to alter DOB for research sharing direct
age_at_last_vital 0..1
String		 Age or date of last vital status direct
is_deceased 0..1
Boolean		 Is the participant known to be Deceased, T, or Alive, F direct
deceased_rel 0..1
RelativeDateTime		 Implementers can provide relativeDateTime if information is available direct
patient_knowledge_source 0..1
EnumPatientKnowledgeSource		 The source of the knowledge represented by this Patient resource direct
family_global_id 0..1
Family		 The family the participant is a part of direct
sample_id *
Sample		 Samples associated with this participant 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
ParticipantAssertion participant_id range Participant
Person participant_id range Participant
StudyMembership participant_id range Participant
Sample participant_id range Participant
NCPIFile participant_id range Participant
FamilyRelationship patient_id range Participant
FamilyRelationship relative_id range Participant

Identifier and Mapping Information

Annotations

property value
fhir_profile https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-participant
fhir_resource Patient

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Participant
annotations:
  fhir_profile:
    tag: fhir_profile
    value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-participant
  fhir_resource:
    tag: fhir_resource
    value: Patient
description: Research oriented patient
title: Participant
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slots:
- participant_id
- birthsex
- race
- ethnicity
- population
- dob
- dob_method
- age_at_last_vital
- is_deceased
- deceased_rel
- patient_knowledge_source
- family_global_id
- sample_id
slot_usage:
  participant_id:
    name: participant_id
    identifier: true
    range: string
  sample_id:
    name: sample_id
    description: Samples associated with this participant
    identifier: false
    required: false
    multivalued: true
  family_global_id:
    name: family_global_id
    description: The family the participant is a part of

Induced

name: Participant
annotations:
  fhir_profile:
    tag: fhir_profile
    value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-participant
  fhir_resource:
    tag: fhir_resource
    value: Patient
description: Research oriented patient
title: Participant
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slot_usage:
  participant_id:
    name: participant_id
    identifier: true
    range: string
  sample_id:
    name: sample_id
    description: Samples associated with this participant
    identifier: false
    required: false
    multivalued: true
  family_global_id:
    name: family_global_id
    description: The family the participant is a part of
attributes:
  participant_id:
    name: participant_id
    description: The Global ID for the Participant
    title: Participant ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: true
    alias: participant_id
    owner: Participant
    domain_of:
    - ParticipantAssertion
    - Participant
    - Person
    - StudyMembership
    - Sample
    - NCPIFile
    range: string
    required: true
  birthsex:
    name: birthsex
    annotations:
      fhir_profile:
        tag: fhir_profile
        value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-participant
      fhir_extension:
        tag: fhir_extension
        value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
      fhir_resource:
        tag: fhir_resource
        value: Consent
    description: Sex assigned at birth (or pre-natal observed sex)
    title: Birth Sex
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: birthsex
    owner: Participant
    domain_of:
    - Participant
    range: EnumBirthSex
    required: false
    multivalued: false
  race:
    name: race
    description: Reported race as defined by the 1997 OMB directives.
    title: Race
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: race
    owner: Participant
    domain_of:
    - Participant
    range: EnumRace
    required: true
    multivalued: true
  ethnicity:
    name: ethnicity
    description: Reported ethnicity as defined by the 1997 OMB directives.
    title: Ethnicity
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: ethnicity
    owner: Participant
    domain_of:
    - Participant
    range: EnumEthnicity
    required: true
  population:
    name: population
    description: opulation, Race, and/or Ethnicity information.
    title: Population
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: population
    owner: Participant
    domain_of:
    - Participant
    range: EnumPopulation
    required: false
    multivalued: false
  dob:
    name: dob
    description: Date of Birth of the participant. Details of privacy method should
      be included in DOBMethod
    title: Date of Birth
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: dob
    owner: Participant
    domain_of:
    - Participant
    range: string
    required: false
    multivalued: false
  dob_method:
    name: dob_method
    description: Specifies method used to alter DOB for research sharing. Details
      should be available in the study protocols.
    title: Date of Birth Method
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: dob_method
    owner: Participant
    domain_of:
    - Participant
    range: EnumDobMethod
    required: false
    multivalued: false
  age_at_last_vital:
    name: age_at_last_vital
    description: Age or date of last vital status
    title: Age At Last Vital Status
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: age_at_last_vital
    owner: Participant
    domain_of:
    - Participant
    range: string
    required: false
    multivalued: false
  is_deceased:
    name: is_deceased
    description: Is the participant known to be Deceased, T, or Alive, F
    title: Is Deceased
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: is_deceased
    owner: Participant
    domain_of:
    - Participant
    range: boolean
    required: false
    multivalued: false
  deceased_rel:
    name: deceased_rel
    description: Implementers can provide relativeDateTime if information is available.
    title: Deceased Relative Date
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: deceased_rel
    owner: Participant
    domain_of:
    - Participant
    range: RelativeDateTime
    required: false
    multivalued: false
  patient_knowledge_source:
    name: patient_knowledge_source
    description: The source of the knowledge represented by this Patient resource.
    title: Patient Knowledge Source
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: patient_knowledge_source
    owner: Participant
    domain_of:
    - Participant
    range: EnumPatientKnowledgeSource
    required: false
    multivalued: false
  family_global_id:
    name: family_global_id
    description: The family the participant is a part of
    title: Family Global ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: false
    alias: family_global_id
    owner: Participant
    domain_of:
    - Participant
    - Family
    range: Family
    required: false
  sample_id:
    name: sample_id
    description: Samples associated with this participant
    title: Sample ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: false
    alias: sample_id
    owner: Participant
    domain_of:
    - Participant
    - Sample
    - Aliquot
    range: Sample
    required: false
    multivalued: true
  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: Participant
    domain_of:
    - HasExternalId
    range: uriorcurie
    required: false
    multivalued: true