Class: NCPI File (NCPIFile)

Information about a file related to a research participant

classDiagram class NCPIFile click NCPIFile href "../NCPIFile/" HasExternalId <|-- NCPIFile click HasExternalId href "../HasExternalId/" NCPIFile : content_version NCPIFile : description NCPIFile : external_id NCPIFile : file_format NCPIFile : file_global_id NCPIFile : file_hash NCPIFile : file_hash_type NCPIFile : file_location_id NCPIFile --> "1..*" FileLocation : file_location_id click FileLocation href "../FileLocation/" NCPIFile : file_meta_data_id NCPIFile --> "*" FileMetaData : file_meta_data_id click FileMetaData href "../FileMetaData/" NCPIFile : file_size NCPIFile : file_size_unit NCPIFile : file_type NCPIFile : participant_id NCPIFile --> "1" Participant : participant_id click Participant href "../Participant/"

Inheritance

HasExternalId
- NCPIFile

Slots

Name	Cardinality and Range	Description	Inheritance
participant_id	1 Participant	The Global ID for the Participant	direct
file_format	1 Uriorcurie	The file format used ([EDAM](http://edamontology	direct
file_location_id	1..* FileLocation	Location details (this is not a global ID)	direct
file_meta_data_id	* FileMetaData	Representation of file metadata for NCPI	direct
file_size	1 Float	The size of the file, e	direct
file_size_unit	1 Uriorcurie	Units associated with the file_size value (ucum)	direct
content_version	0..1 String	Version of the file content	direct
file_type	1 Uriorcurie	The type of data contained in this file	direct
file_hash	1 String	Value of hashing the file	direct
file_hash_type	0..1 Uriorcurie	Algorithm used to calculate the hash (and size, where applicable)	direct
description	0..1 String	More details associated with the given resource	direct
file_global_id	1 String	File Global ID	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	DocumentReference
fhir_profile	https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-drs-file

Schema Source

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

Mappings

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

LinkML Source

Direct

name: NCPIFile
annotations:
  fhir_resource:
    tag: fhir_resource
    value: DocumentReference
  fhir_profile:
    tag: fhir_profile
    value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-drs-file
description: Information about a file related to a research participant
title: NCPI File
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
slots:
- participant_id
- file_format
- file_location_id
- file_meta_data_id
- file_size
- file_size_unit
- content_version
- file_type
- file_hash
- file_hash_type
- description
attributes:
  file_global_id:
    name: file_global_id
    description: File Global ID
    title: File Global ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input/ncpi-file
    rank: 1000
    identifier: true
    domain_of:
    - NCPIFile
    range: string
    required: true

Induced

name: NCPIFile
annotations:
  fhir_resource:
    tag: fhir_resource
    value: DocumentReference
  fhir_profile:
    tag: fhir_profile
    value: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/ncpi-drs-file
description: Information about a file related to a research participant
title: NCPI File
from_schema: https://carrollaboratory.github.io/kfi-fhir-input
is_a: HasExternalId
attributes:
  file_global_id:
    name: file_global_id
    description: File Global ID
    title: File Global ID
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input/ncpi-file
    rank: 1000
    identifier: true
    alias: file_global_id
    owner: NCPIFile
    domain_of:
    - NCPIFile
    range: string
    required: true
  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
    alias: participant_id
    owner: NCPIFile
    domain_of:
    - ParticipantAssertion
    - Participant
    - Person
    - StudyMembership
    - Sample
    - NCPIFile
    range: Participant
    required: true
  file_format:
    name: file_format
    description: The file format used ([EDAM](http://edamontology.org) where possible)
    title: File Format
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: file_format
    owner: NCPIFile
    domain_of:
    - NCPIFile
    range: uriorcurie
    required: true
    multivalued: false
  file_location_id:
    name: file_location_id
    description: Location details (this is not a global ID)
    title: File Location
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: file_location_id
    owner: NCPIFile
    domain_of:
    - NCPIFile
    - FileLocation
    range: FileLocation
    required: true
    multivalued: true
  file_meta_data_id:
    name: file_meta_data_id
    description: Representation of file metadata for NCPI
    title: File Meta Data
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: file_meta_data_id
    owner: NCPIFile
    domain_of:
    - NCPIFile
    - FileMetaData
    range: FileMetaData
    required: false
    multivalued: true
  file_size:
    name: file_size
    description: The size of the file, e.g., in bytes.
    title: File Size
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: file_size
    owner: NCPIFile
    domain_of:
    - NCPIFile
    range: float
    required: true
    multivalued: false
  file_size_unit:
    name: file_size_unit
    description: Units associated with the file_size value (ucum)
    title: File Size Units
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: file_size_unit
    owner: NCPIFile
    domain_of:
    - NCPIFile
    range: uriorcurie
    required: true
    multivalued: false
  content_version:
    name: content_version
    description: Version of the file content
    title: Content Version
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: content_version
    owner: NCPIFile
    domain_of:
    - NCPIFile
    range: string
    required: false
    multivalued: false
  file_type:
    name: file_type
    description: The type of data contained in this file. Should be as detailed as
      possible, e.g., Whole Exome Variant Calls.
    title: File Type
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: file_type
    owner: NCPIFile
    domain_of:
    - NCPIFile
    range: uriorcurie
    required: true
    multivalued: false
  file_hash:
    name: file_hash
    description: Value of hashing the file
    title: File Hash
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: file_hash
    owner: NCPIFile
    domain_of:
    - NCPIFile
    range: string
    required: true
    multivalued: false
  file_hash_type:
    name: file_hash_type
    description: Algorithm used to calculate the hash (and size, where applicable)
    title: File Has Type
    from_schema: https://carrollaboratory.github.io/kfi-fhir-input
    rank: 1000
    alias: file_hash_type
    owner: NCPIFile
    domain_of:
    - NCPIFile
    range: uriorcurie
    required: false
    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: NCPIFile
    domain_of:
    - AccessPolicy
    - Practitioner
    - ResearchStudy
    - ResearchStudyCollection
    - NCPIFile
    - Family
    range: string
    required: 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: NCPIFile
    domain_of:
    - HasExternalId
    range: uriorcurie
    required: false
    multivalued: true