Skip to content

Commit c63faea

Browse files
✨ File support
This sketches out basic file support
1 parent f62d035 commit c63faea

4 files changed

Lines changed: 684 additions & 22 deletions

File tree

docs/schema/include_access_model.yaml

Lines changed: 296 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -773,6 +773,47 @@ enums:
773773
definition_uri: https://includedcc.org/include-access-model/EnumLaterality
774774
description: Laterality information for the site
775775
from_schema: https://includedcc.org/include-access-model
776+
EnumEDAMFormats:
777+
name: EnumEDAMFormats
778+
definition_uri: https://includedcc.org/include-access-model/EnumEDAMFormats
779+
description: Data formats from the EDAM ontology.
780+
from_schema: https://includedcc.org/include-access-model
781+
reachable_from:
782+
source_ontology: bioregistry:edam
783+
source_nodes:
784+
- edam:format_1915
785+
relationship_types:
786+
- rdfs:subClassOf
787+
is_direct: false
788+
include_self: false
789+
EnumEDAMDataTypes:
790+
name: EnumEDAMDataTypes
791+
definition_uri: https://includedcc.org/include-access-model/EnumEDAMDataTypes
792+
description: Data types from the EDAM ontology.
793+
from_schema: https://includedcc.org/include-access-model
794+
reachable_from:
795+
source_ontology: bioregistry:edam
796+
source_nodes:
797+
- edam:data_0006
798+
relationship_types:
799+
- rdfs:subClassOf
800+
is_direct: false
801+
include_self: false
802+
EnumFileHashType:
803+
name: EnumFileHashType
804+
definition_uri: https://includedcc.org/include-access-model/EnumFileHashType
805+
description: Types of file hashes supported.
806+
from_schema: https://includedcc.org/include-access-model
807+
permissible_values:
808+
md5:
809+
text: md5
810+
title: MD5
811+
etag:
812+
text: etag
813+
title: ETag
814+
sha1:
815+
text: sha1
816+
title: SHA-1
776817
slots:
777818
study_id:
778819
name: study_id
@@ -807,12 +848,13 @@ slots:
807848
title: Study ID
808849
from_schema: https://includedcc.org/include-access-model
809850
slot_uri: includedcc:subject_id
810-
owner: Encounter
851+
owner: File
811852
domain_of:
812853
- Subject
813854
- Demographics
814855
- SubjectAssertion
815856
- Encounter
857+
- File
816858
range: Subject
817859
multivalued: false
818860
assertion_id:
@@ -1109,12 +1151,11 @@ slots:
11091151
title: Data Category
11101152
from_schema: https://includedcc.org/include-access-model
11111153
slot_uri: includedcc:data_category
1112-
owner: StudyMetadata
1154+
owner: File
11131155
domain_of:
11141156
- StudyMetadata
1157+
- File
11151158
range: EnumDataCategory
1116-
required: true
1117-
multivalued: true
11181159
clinical_data_source_type:
11191160
name: clinical_data_source_type
11201161
definition_uri: https://includedcc.org/include-access-model/clinical_data_source_type
@@ -1481,10 +1522,11 @@ slots:
14811522
title: Sample ID
14821523
from_schema: https://includedcc.org/include-access-model
14831524
slot_uri: includedcc:sample_id
1484-
owner: Aliquot
1525+
owner: File
14851526
domain_of:
14861527
- Sample
14871528
- Aliquot
1529+
- File
14881530
range: Sample
14891531
parent_sample_id:
14901532
name: parent_sample_id
@@ -1724,6 +1766,131 @@ slots:
17241766
- EncounterDefinition
17251767
- ActivityDefinition
17261768
range: ActivityDefinition
1769+
file_id:
1770+
name: file_id
1771+
definition_uri: https://includedcc.org/include-access-model/file_id
1772+
description: Unique identifier for this File.
1773+
title: File ID
1774+
from_schema: https://includedcc.org/include-access-model
1775+
slot_uri: includedcc:file_id
1776+
owner: File
1777+
domain_of:
1778+
- File
1779+
range: File
1780+
filename:
1781+
name: filename
1782+
definition_uri: https://includedcc.org/include-access-model/filename
1783+
description: The name of the file.
1784+
title: Filename
1785+
from_schema: https://includedcc.org/include-access-model
1786+
slot_uri: includedcc:filename
1787+
owner: File
1788+
domain_of:
1789+
- File
1790+
range: string
1791+
format:
1792+
name: format
1793+
definition_uri: https://includedcc.org/include-access-model/format
1794+
description: The format of the file.
1795+
title: File Format
1796+
from_schema: https://includedcc.org/include-access-model
1797+
slot_uri: includedcc:format
1798+
owner: File
1799+
domain_of:
1800+
- File
1801+
range: EnumEDAMFormats
1802+
data_type:
1803+
name: data_type
1804+
definition_uri: https://includedcc.org/include-access-model/data_type
1805+
description: The type of data within this file.
1806+
title: Data Type
1807+
from_schema: https://includedcc.org/include-access-model
1808+
slot_uri: includedcc:data_type
1809+
owner: File
1810+
domain_of:
1811+
- File
1812+
range: EnumEDAMDataTypes
1813+
size:
1814+
name: size
1815+
definition_uri: https://includedcc.org/include-access-model/size
1816+
description: Size of the file, in Bytes.
1817+
title: File Size
1818+
from_schema: https://includedcc.org/include-access-model
1819+
slot_uri: includedcc:size
1820+
owner: File
1821+
domain_of:
1822+
- File
1823+
range: integer
1824+
unit:
1825+
ucum_code: By
1826+
staging_url:
1827+
name: staging_url
1828+
definition_uri: https://includedcc.org/include-access-model/staging_url
1829+
description: URL for internal access to the data. May be temporary.
1830+
title: Staging Location
1831+
from_schema: https://includedcc.org/include-access-model
1832+
slot_uri: includedcc:staging_url
1833+
owner: File
1834+
domain_of:
1835+
- File
1836+
range: uriorcurie
1837+
release_url:
1838+
name: release_url
1839+
definition_uri: https://includedcc.org/include-access-model/release_url
1840+
description: URL for controlled or open access to the data.
1841+
title: Release Location
1842+
from_schema: https://includedcc.org/include-access-model
1843+
slot_uri: includedcc:release_url
1844+
owner: File
1845+
domain_of:
1846+
- File
1847+
range: uriorcurie
1848+
drs_uri:
1849+
name: drs_uri
1850+
definition_uri: https://includedcc.org/include-access-model/drs_uri
1851+
description: DRS location to access the data.
1852+
title: DRS URI
1853+
from_schema: https://includedcc.org/include-access-model
1854+
slot_uri: includedcc:drs_uri
1855+
owner: File
1856+
domain_of:
1857+
- File
1858+
range: uriorcurie
1859+
hash:
1860+
name: hash
1861+
definition_uri: https://includedcc.org/include-access-model/hash
1862+
description: File hash information
1863+
title: File Hash
1864+
from_schema: https://includedcc.org/include-access-model
1865+
slot_uri: includedcc:hash
1866+
owner: File
1867+
domain_of:
1868+
- File
1869+
range: FileHash
1870+
inlined: true
1871+
inlined_as_list: true
1872+
hash_type:
1873+
name: hash_type
1874+
definition_uri: https://includedcc.org/include-access-model/hash_type
1875+
description: The type of file hash, eg, md5
1876+
title: File Hash Type
1877+
from_schema: https://includedcc.org/include-access-model
1878+
slot_uri: includedcc:hash_type
1879+
owner: FileHash
1880+
domain_of:
1881+
- FileHash
1882+
range: EnumFileHashType
1883+
hash_value:
1884+
name: hash_value
1885+
definition_uri: https://includedcc.org/include-access-model/hash_value
1886+
description: The value of the file hash
1887+
title: File Hash Value
1888+
from_schema: https://includedcc.org/include-access-model
1889+
slot_uri: includedcc:hash_value
1890+
owner: FileHash
1891+
domain_of:
1892+
- FileHash
1893+
range: string
17271894
Study_study_id:
17281895
name: Study_study_id
17291896
definition_uri: https://includedcc.org/include-access-model/study_id
@@ -1762,6 +1929,25 @@ slots:
17621929
range: Study
17631930
required: true
17641931
multivalued: false
1932+
StudyMetadata_data_category:
1933+
name: StudyMetadata_data_category
1934+
definition_uri: https://includedcc.org/include-access-model/data_category
1935+
description: General category of data in this Record (e.g. Clinical, Genomics,
1936+
etc)
1937+
title: Data Category
1938+
from_schema: https://includedcc.org/include-access-model
1939+
is_a: data_category
1940+
domain: StudyMetadata
1941+
slot_uri: includedcc:data_category
1942+
alias: data_category
1943+
owner: StudyMetadata
1944+
domain_of:
1945+
- StudyMetadata
1946+
is_usage_slot: true
1947+
usage_slot_name: data_category
1948+
range: EnumDataCategory
1949+
required: true
1950+
multivalued: true
17651951
DOI_do_id:
17661952
name: DOI_do_id
17671953
definition_uri: https://includedcc.org/include-access-model/do_id
@@ -1997,6 +2183,58 @@ slots:
19972183
usage_slot_name: activity_definition_id
19982184
range: string
19992185
required: true
2186+
File_file_id:
2187+
name: File_file_id
2188+
definition_uri: https://includedcc.org/include-access-model/file_id
2189+
description: Unique identifier for this File.
2190+
title: File ID
2191+
from_schema: https://includedcc.org/include-access-model
2192+
is_a: file_id
2193+
domain: File
2194+
slot_uri: includedcc:file_id
2195+
identifier: true
2196+
alias: file_id
2197+
owner: File
2198+
domain_of:
2199+
- File
2200+
is_usage_slot: true
2201+
usage_slot_name: file_id
2202+
range: string
2203+
required: true
2204+
File_subject_id:
2205+
name: File_subject_id
2206+
definition_uri: https://includedcc.org/include-access-model/subject_id
2207+
description: INCLUDE Global ID for the Subject
2208+
title: Study ID
2209+
from_schema: https://includedcc.org/include-access-model
2210+
is_a: subject_id
2211+
domain: File
2212+
slot_uri: includedcc:subject_id
2213+
alias: subject_id
2214+
owner: File
2215+
domain_of:
2216+
- File
2217+
is_usage_slot: true
2218+
usage_slot_name: subject_id
2219+
range: Subject
2220+
multivalued: true
2221+
File_sample_id:
2222+
name: File_sample_id
2223+
definition_uri: https://includedcc.org/include-access-model/sample_id
2224+
description: The unique identifier for this Sample.
2225+
title: Sample ID
2226+
from_schema: https://includedcc.org/include-access-model
2227+
is_a: sample_id
2228+
domain: File
2229+
slot_uri: includedcc:sample_id
2230+
alias: sample_id
2231+
owner: File
2232+
domain_of:
2233+
- File
2234+
is_usage_slot: true
2235+
usage_slot_name: sample_id
2236+
range: Sample
2237+
multivalued: true
20002238
classes:
20012239
Record:
20022240
name: Record
@@ -2053,7 +2291,7 @@ classes:
20532291
- selection_criteria
20542292
- study_design
20552293
- clinical_data_source_type
2056-
- data_category
2294+
- StudyMetadata_data_category
20572295
- vbr
20582296
- research_domain
20592297
- expected_number_of_participants
@@ -2063,6 +2301,10 @@ classes:
20632301
name: study_id
20642302
identifier: true
20652303
required: true
2304+
data_category:
2305+
name: data_category
2306+
required: true
2307+
multivalued: true
20662308
class_uri: includedcc:StudyMetadata
20672309
VirtualBiorepository:
20682310
name: VirtualBiorepository
@@ -2356,9 +2598,54 @@ classes:
23562598
range: string
23572599
required: true
23582600
class_uri: includedcc:ActivityDefinition
2601+
File:
2602+
name: File
2603+
definition_uri: https://includedcc.org/include-access-model/File
2604+
description: File
2605+
title: File
2606+
from_schema: https://includedcc.org/include-access-model
2607+
is_a: Record
2608+
slots:
2609+
- external_id
2610+
- File_file_id
2611+
- File_subject_id
2612+
- File_sample_id
2613+
- filename
2614+
- format
2615+
- data_category
2616+
- data_type
2617+
- format
2618+
- size
2619+
- staging_url
2620+
- release_url
2621+
- drs_uri
2622+
- hash
2623+
slot_usage:
2624+
file_id:
2625+
name: file_id
2626+
identifier: true
2627+
range: string
2628+
required: true
2629+
subject_id:
2630+
name: subject_id
2631+
multivalued: true
2632+
sample_id:
2633+
name: sample_id
2634+
multivalued: true
2635+
class_uri: includedcc:File
2636+
FileHash:
2637+
name: FileHash
2638+
definition_uri: https://includedcc.org/include-access-model/FileHash
2639+
description: Type and value of a file content hash.
2640+
title: File Hash
2641+
from_schema: https://includedcc.org/include-access-model
2642+
slots:
2643+
- hash_type
2644+
- hash_value
2645+
class_uri: includedcc:FileHash
23592646
metamodel_version: 1.7.0
23602647
source_file: include_access_model.yaml
2361-
source_file_date: '2026-03-09T12:47:07'
2362-
source_file_size: 32279
2363-
generation_date: '2026-03-09T13:32:45'
2648+
source_file_date: '2026-03-09T16:30:20'
2649+
source_file_size: 35097
2650+
generation_date: '2026-03-09T16:31:10'
23642651

0 commit comments

Comments
 (0)