Skip to content

NFDI4Immuno Model Schema

Common data model schema for the NFDI4Immuno.

URI: https://codebase.helmholtz.cloud/nfdi4immuno/portal-infra/metadata_schema

Name: nfdi4immuno-schema

Classes

Class Description
AbstractKnowledgeOrganizationSystem A concept referenced by a standardized identifier from an external system suc...
        AntibodyRegistry The identifier of an antibody in the Antibody Registry
        Disease A reference to an ICD10 identifier
        HLAGene The HLA gene/locus as defined in the MHC Restriction Ontology
        Organization A reference to a ROR-registered organization
        Species A reference to a NCBITaxon identifier
                HomoSapiens Fixed to NCBITaxon:9606 - Homo sapiens
        Tissue A reference to an UBERON identifier
AbstractSubject Abstract subject class
        CellCultureSubject Cell line subject of a study
        HumanSubject A human subject in a study
        NonHumanSubject A non-human animal subject in a study
Affiliation The affiliation of the contributor
AIRRAssay A record representing an AIRR-seq assay
AIRRRun A record representing an AIRR-seq run
Antibody Information about an antibody used in a cytometry staining panel
Container Container for other model objects
Contributor A person contributing to the creation of the deposited data
CytometryDataProcessing The data processing steps used in a cytometry experiment
CytometryExperiment A record representing a cytometry experiment
DataFile A record representing an attached datafile
HLAGenotype The HLA makeup of a study subject
InstrumentInformation Information about the instrument used in a cytometry experiment
NucleicAcidProcessing A record of the procedures used to prepare nucleic acid libraries for sequenc...
OpticalConfiguration The instrument configuration of lasers, detectors, and bandpass filters
PCRTarget A target locus and primer locations used in PCR amplification of immunoglobul...
Publication Publications describing the rationale and/or outcome of the study
Sample A biological sample collected from a subject
SampleEvent Realisation of a study event which contains time relevant information
SampleEventCollection Collection of sample events indexed by sample ID
SequencingRun A record of a sequencing experiment, including run metadata and output data f...
StainingPanel The methods and reagents used in a cytometry panel
Study A record representing a single biomedical study

Slots

Slot Description
abstract_id An abstract identifier
additional_information Additional information related to this object
affiliations The affiliations of a contributor
age The age of a subject at the "reference" timepoint (= when subject was include...
age_unit The unit of the age value (e
airr_runs References to AIRR-seq runs associated with a sample
allele The HLA allele (field 1 in the HLA nomenclature)
analyte_name Name the antigen that was stained for
ancestry Broad geographic origin of ancestry (continent)
antibody_registry A reference to an entry in an antibody registry
atcc_key The American Type Culture Collection (ATCC) product number
background_strain The background strain of the animal
bandpass The wavelength range transmitted by the detector’s bandpass filter, expressed...
batch_normalization_method Which batch normalization method was used? If none was used, please write: n...
breed To come
checksum_algorithm The algorithm used to calculate the file checksum
clone The clone of the antibody
collection_relative_time_point_event_label The baseline event relative to which the time point is measured
collection_relative_time_point_unit The unit of the collection time point relative to the baseline event
collection_relative_time_point_value The numeric value of the collection time point relative to the baseline event
comorbidities The comorbidities of a human subject
compensation_method Which compensation methods were used? If none were used, please write: no me...
complete_sequences To be considered complete, the procedure used for library construction MUST...
compression The type of compression (if any) used for the file (e
conjugate The conjugate (e
contributors Contributors to the creation of the data set
data_access_level The data access level for the study
data_processing The data processing steps used in a cytometry experiment
data_transformation_method Which data transformation methods were used? If none were used, please write...
debarcoding_method Which debarcoding method was used? If none was used, please write: no method...
department The department the contributor belongs to
description A thorough description of the project including study design, disease, and ou...
detector_name The name or identifier of the detector used to capture emitted light from the...
dilution The dilution used for the antibody
disease_or_healthy Indicate if subject had a disease or if healthy
disease_states The current state of the diseases of the subject at the time of sampling
diseases Relevant diseases at the time of sampling
email The email address of the contributor
ethnicity The cultural or geographical group the subject belongs to
expression_level Changes to HLA expression levels (suffix field in the HLA nomenclature)
file_checksum The checksum for the file
file_id The unique identifier for the deposited data file
file_name The name of the files with the data for the given sample
file_uuid The UUID of the file object on the storage
fixation Was a fixation step included before the acquisition? If so, please specify t...
forward_pcr_primer_target_location Position of the most distal nucleotide templated by the forward primer or pri...
gating_description The gating strategy or a reference to where it is described in detail (e
gene The HLA gene/locus as defined in the MHC Restriction Ontology
grants Grants supporting the study
hlas The HLA object
instrument_information The information of the instrument used in a cytometry experiment
key Identifier/code for the referenced concept
keywords Keywords fitting the study
library_generation_kit_version When using a library generation protocol from a commercial provider, provide ...
library_generation_method Generic type of library generation
library_generation_protocol Description of processes applied to substrate to obtain a library that is rea...
manufacturer The manufacturer of the antibody or instrument
medications Medications given to the subject
model Instrument model shall be titled
modifications To come
name A name - redefined where used
noncoding_variant Nucleotide polymorphism outside of the gene's coding region (field 4 in the H...
normalization_method Which other normalization methods, besides the compensation methods and batch...
nucleic_acid_processing Procedures used to prepare nucleic acid libraries for sequencing
number_of_lasers The number of lasers in the flow cytometer
optical_configurations The set of optical configurations used by the instrument, including informat...
orcid The ORCID identifier for the contributor
organization The organization the contributor is affiliated with
pcr_target_locus Designation of the target locus
pcr_targets The IG/TR locus or loci under investigation
physical_linkage In case an experimental setup is used that physically links nucleic acids der...
power The output power of the laser expressed in milliwatts (mW)
primary_antibody The primary antibody used in the staining panel
protein The HLA protein (field 2 in the HLA nomenclature)
publication_curie The PMID or DOI of the publication
publications List of publications
randomization_method Which randomization methods were used? If none were used, please write: no m...
reverse_pcr_primer_target_location Position of the most proximal nucleotide templated by the reverse primer or p...
role The role of the contributor in the study
sample_collection_method The method used to collect the sample (e
sample_event_entries A collection of individual sample events
sample_event_id A sample ID to associate the subjects with a sample event
sample_events Reference to the SampleEventCollection
sample_id The user defined sample ID used to associate samples with the sample event
samples Reference to the study samples
secondary_antibody The secondary antibody used in the staining panel, if applicable
sequencing_batch_number ID of sequencing run assigned by the sequencing facility
sequencing_facility Name and address of sequencing facility
sequencing_kit Name, manufacturer, order and lot numbers of sequencing kit
sequencing_platform Designation of sequencing instrument used
sequencing_run Metadata about the sequencing experiment
sequencing_run_date Date of sequencing run in the format year-month-day
sex The biological sex of the subject
species The species of the subject
staining_panels The methods and reagents used in a cytometry panel
study Reference to a research study or experiment containing metadata, methodology,...
study_id The internal identifier of the study
study_type Type of the study
subject_id The user defined subject ID used to associate subject with samples
subject_type Is the subject human, rodent, animal or a cell culture subject
subjects Reference to the study subjects
synonymous_variant The synonymous mutation within the HLA coding region (field 3 in the HLA nome...
template_amount_unit The unit of the template amount that went into the process
template_amount_value Amount of template that went into the process
template_class The class of nucleic acid that was used as primary starting material for the ...
template_quality Description and results of the quality control performed on the template mate...
term The human-readable term or label
tissue The tissue from which the sample was taken
title The full title of the study
title_short A short title of the study
total_reads_passing_qc_filter Number of usable reads for analysis
unmixing_method Which unmixing method was used? If none was used, please write: no method wa...
wavelength The wavelength of the laser in nanometers and its associated spectral region ...

Enumerations

Enumeration Description
BiologicalSex Possible values to biological sex
ChecksumAlgorithms Commonly used checksum algorithms, see http://spdx
CompleteSequences Classification of the completeness of the generated sequences in the library
Compressions Commonly used compression algorithms
ContributorRoles Roles a contributor may have in the context of a dataset
DataAccessLevels Possible data access levels
DiseaseOrHealthy Indicate if subject had a disease or if healthy
GeographicalLocations Possible geographical locations, taken from https://unstats
HLAExpression Permissible changes to HLA expression
LibraryGenerationMethod Generic type of library generation
PCRTargetLoci These elements are meant to provide a generic classification of the locus, no...
PhysicalLinkage Mode of physical linkage between nucleic acids derived from distinct rearrang...
StudyTypes Study types as defined by the SEPI ontology outer nodes under SEPIO:0000125 (...
SubjectType Possible values to subject type
TemplateClass The class of nucleic acid that was used as primary starting material for the ...
TimeUnits Possible time units
WeightUnits Possible physical units

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description