Class: Research Study (ResearchStudy)

The NCPI Research Study FHIR resource represents an individual research effort and acts as a grouper or “container” for that effort’s study participants and their related data files.

URI: kfi_fhir_sparks:ResearchStudy

classDiagram class ResearchStudy click ResearchStudy href "../ResearchStudy/" HasExternalId <|-- ResearchStudy click HasExternalId href "../HasExternalId/" ResearchStudy : description ResearchStudy : external_id ResearchStudy : parent_study_id ResearchStudy --> "0..1" ResearchStudy : parent_study_id click ResearchStudy href "../ResearchStudy/" ResearchStudy : research_study_id ResearchStudy : study_acknowledgement ResearchStudy : study_condition ResearchStudy : study_design ResearchStudy : study_focus ResearchStudy : study_personnel ResearchStudy --> "1..*" AssociatedParty : study_personnel click AssociatedParty href "../AssociatedParty/" ResearchStudy : study_status ResearchStudy --> "1" EnumStudyStatus : study_status click EnumStudyStatus href "../EnumStudyStatus/" ResearchStudy : study_title

Inheritance

HasExternalId
- ResearchStudy

Slots

Name	Cardinality and Range	Description	Inheritance
research_study_id	1 String	The Global ID for the Research Study	direct
study_title	0..1 String	Research Study's formal title	direct
parent_study_id	0..1 ResearchStudy	ID For Parent Study if this is a substudy	direct
study_focus	* Uriorcurie	The primary, non-disease focus(es) of the study	direct
description	0..1 String	More details associated with the given resource	direct
study_condition	* Uriorcurie	The primary focus(es) of the study	direct
study_acknowledgement	* String	Any attribution or acknowledgements relevant to the study	direct
study_status	1 EnumStudyStatus	The current state of the study	direct
study_design	* Uriorcurie	Study Design and Study Type ([example ValueSet can be found here](https://hl7	direct
study_personnel	1..* AssociatedParty	Every study must have at least one Primary Contact defined	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
StudyMembership	research_study_id	range	ResearchStudy
ResearchStudy	parent_study_id	range	ResearchStudy
ResearchStudyCollection	research_study_collection_member_id	range	ResearchStudy

Identifier and Mapping Information

Annotations

property	value
fhir_resource	ResearchStudy

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ResearchStudy
annotations:
  fhir_resource:
    tag: fhir_resource
    value: ResearchStudy
description: The NCPI Research Study FHIR resource represents an individual research
  effort and acts as a grouper or “container” for that effort’s study participants
  and their related data files.
title: Research Study
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slots:
- research_study_id
- study_title
- parent_study_id
- study_focus
- description
- study_condition
- study_acknowledgement
- study_status
- study_design
- study_personnel
slot_usage:
  research_study_id:
    name: research_study_id
    description: The Global ID for the Research Study.
    identifier: true
    range: string
    required: true

Induced

name: ResearchStudy
annotations:
  fhir_resource:
    tag: fhir_resource
    value: ResearchStudy
description: The NCPI Research Study FHIR resource represents an individual research
  effort and acts as a grouper or “container” for that effort’s study participants
  and their related data files.
title: Research Study
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slot_usage:
  research_study_id:
    name: research_study_id
    description: The Global ID for the Research Study.
    identifier: true
    range: string
    required: true
attributes:
  research_study_id:
    name: research_study_id
    description: The Global ID for the Research Study.
    title: Research Study ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: true
    alias: research_study_id
    owner: ResearchStudy
    domain_of:
    - StudyMembership
    - ResearchStudy
    range: string
    required: true
  study_title:
    name: study_title
    description: Research Study's formal title.
    title: Title
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: study_title
    owner: ResearchStudy
    domain_of:
    - ResearchStudy
    range: string
    required: false
  parent_study_id:
    name: parent_study_id
    annotations:
      db_column:
        tag: db_column
        value: parent_study_id
      target_slot:
        tag: target_slot
        value: research_study_id
    description: ID For Parent Study if this is a substudy
    title: Parent Study
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: parent_study_id
    owner: ResearchStudy
    domain_of:
    - ResearchStudy
    range: ResearchStudy
    required: false
  study_focus:
    name: study_focus
    description: The primary, non-disease focus(es) of the study. This can include
      terms related to intervention, drug, device, or other focus.
    title: Study Focus
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: study_focus
    owner: ResearchStudy
    domain_of:
    - ResearchStudy
    range: uriorcurie
    required: false
    multivalued: true
  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: ResearchStudy
    domain_of:
    - AccessPolicy
    - Practitioner
    - ResearchStudy
    - ResearchStudyCollection
    - NCPIFile
    - Family
    range: string
    required: false
  study_condition:
    name: study_condition
    description: The primary focus(es) of the study. This is specific to the disease.
      MeSH terms are preferred.
    title: Study Condition
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: study_condition
    owner: ResearchStudy
    domain_of:
    - ResearchStudy
    range: uriorcurie
    required: false
    multivalued: true
  study_acknowledgement:
    name: study_acknowledgement
    description: Any attribution or acknowledgements relevant to the study. This can
      include but is not limited to funding sources, organizational affiliations or
      sponsors.
    title: Study Acknowledgement
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: study_acknowledgement
    owner: ResearchStudy
    domain_of:
    - ResearchStudy
    range: string
    required: false
    multivalued: true
  study_status:
    name: study_status
    description: The current state of the study.
    title: Study Status
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: study_status
    owner: ResearchStudy
    domain_of:
    - ResearchStudy
    range: EnumStudyStatus
    required: true
    multivalued: false
  study_design:
    name: study_design
    description: Study Design and Study Type ([example ValueSet can be found here](https://hl7.org/fhir/valueset-study-design.html))
    title: Study Design
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: study_design
    owner: ResearchStudy
    domain_of:
    - ResearchStudy
    range: uriorcurie
    required: false
    multivalued: true
  study_personnel:
    name: study_personnel
    description: Every study must have at least one Primary Contact defined. Additional
      personnel such as Primary Investigator(s), Administrator(s), Collaborator(s)
      or other roles may also be included. If there are no appropriate individuals
      who can serve as primary contact for a study, an organization may be provided.
    title: Study Personnel
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: study_personnel
    owner: ResearchStudy
    domain_of:
    - ResearchStudy
    range: AssociatedParty
    required: true
    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: ResearchStudy
    domain_of:
    - HasExternalId
    range: uriorcurie
    required: false
    multivalued: true