Class: Research Study Collection (ResearchStudyCollection)

Collections of research data including, but not limited, to Consortia, Programs, adhoc collections of Studies and datasets among other types of collections.

URI: kfi_fhir_sparks:ResearchStudyCollection

classDiagram class ResearchStudyCollection click ResearchStudyCollection href "../ResearchStudyCollection/" HasExternalId <|-- ResearchStudyCollection click HasExternalId href "../HasExternalId/" ResearchStudyCollection : collection_status ResearchStudyCollection --> "1" EnumCollectionStatus : collection_status click EnumCollectionStatus href "../EnumCollectionStatus/" ResearchStudyCollection : collection_title ResearchStudyCollection : description ResearchStudyCollection : external_id ResearchStudyCollection : label ResearchStudyCollection : research_study_collection_id ResearchStudyCollection : research_study_collection_member_id ResearchStudyCollection --> "1..*" ResearchStudy : research_study_collection_member_id click ResearchStudy href "../ResearchStudy/" ResearchStudyCollection : research_study_collection_type ResearchStudyCollection --> "1" EnumResearchCollectionType : research_study_collection_type click EnumResearchCollectionType href "../EnumResearchCollectionType/" ResearchStudyCollection : website

Inheritance

HasExternalId
- ResearchStudyCollection

Slots

Name	Cardinality and Range	Description	Inheritance
research_study_collection_id	1 String	Global ID for this record	direct
description	0..1 String	More details associated with the given resource	direct
collection_title	1 String	The collection's title	direct
research_study_collection_type	1 EnumResearchCollectionType	The type of collection being described	direct
label	* String	Alias such as acronym and alternate names	direct
website	0..1 Uri	URL describing the entity this represents	direct
collection_status	1 EnumCollectionStatus	The current state of the collection	direct
research_study_collection_member_id	1..* ResearchStudy	ID associated with a member of the collection (Research Study, Dataset, etc)	direct
external_id	* Uriorcurie	Other identifiers for this entity, eg, from the submitting study or in system...	HasExternalId

Identifier and Mapping Information

Annotations

property	value
fhir_resource	List

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ResearchStudyCollection
annotations:
  fhir_resource:
    tag: fhir_resource
    value: List
description: Collections of research data including, but not limited, to Consortia,
  Programs, adhoc collections of Studies and datasets among other types of collections.
title: Research Study Collection
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slots:
- research_study_collection_id
- description
- collection_title
- research_study_collection_type
- label
- website
- collection_status
- research_study_collection_member_id
slot_usage:
  research_study_collection_id:
    name: research_study_collection_id
    identifier: true
    range: string
    required: true
  description:
    name: description
    multivalued: false

Induced

name: ResearchStudyCollection
annotations:
  fhir_resource:
    tag: fhir_resource
    value: List
description: Collections of research data including, but not limited, to Consortia,
  Programs, adhoc collections of Studies and datasets among other types of collections.
title: Research Study Collection
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slot_usage:
  research_study_collection_id:
    name: research_study_collection_id
    identifier: true
    range: string
    required: true
  description:
    name: description
    multivalued: false
attributes:
  research_study_collection_id:
    name: research_study_collection_id
    description: Global ID for this record
    title: Research Study Collection ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: true
    alias: research_study_collection_id
    owner: ResearchStudyCollection
    domain_of:
    - ResearchStudyCollection
    range: string
    required: 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: ResearchStudyCollection
    domain_of:
    - AccessPolicy
    - Practitioner
    - ResearchStudy
    - ResearchStudyCollection
    - NCPIFile
    - Family
    range: string
    required: false
    multivalued: false
  collection_title:
    name: collection_title
    description: The collection's title.
    title: Collection Title
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: collection_title
    owner: ResearchStudyCollection
    domain_of:
    - ResearchStudyCollection
    range: string
    required: true
  research_study_collection_type:
    name: research_study_collection_type
    description: The type of collection being described.
    title: Research Study Collection Type
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: research_study_collection_type
    owner: ResearchStudyCollection
    domain_of:
    - ResearchStudyCollection
    range: EnumResearchCollectionType
    required: true
    multivalued: false
  label:
    name: label
    description: Alias such as acronym and alternate names.
    title: Label
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: label
    owner: ResearchStudyCollection
    domain_of:
    - ResearchStudyCollection
    range: string
    required: false
    multivalued: true
  website:
    name: website
    description: URL describing the entity this represents. This can include a formal
      website, such as the Entity's website, or to an online document describing the
      entity.
    title: Website
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: website
    owner: ResearchStudyCollection
    domain_of:
    - AccessPolicy
    - ResearchStudyCollection
    range: uri
    required: false
    multivalued: false
  collection_status:
    name: collection_status
    description: The current state of the collection
    title: Collection Status
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: collection_status
    owner: ResearchStudyCollection
    domain_of:
    - ResearchStudyCollection
    range: EnumCollectionStatus
    required: true
    multivalued: false
  research_study_collection_member_id:
    name: research_study_collection_member_id
    annotations:
      target_slot:
        tag: target_slot
        value: research_study_id
    description: ID associated with a member of the collection (Research Study, Dataset,
      etc)
    title: Research Study Collection Member ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    identifier: false
    alias: research_study_collection_member_id
    owner: ResearchStudyCollection
    domain_of:
    - ResearchStudyCollection
    range: ResearchStudy
    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: ResearchStudyCollection
    domain_of:
    - HasExternalId
    range: uriorcurie
    required: false
    multivalued: true