This document provides an intuitive introduction and guide to the NIDASH Data Model for neuroimaging data sharing. NIDASH defines a core vocabulary that extends the PROV Data Model for provenance with terms that capture information about neuroimaging research, from data acquisition to analysis and results. This primer explains the fundamental NIDASH concepts and provides examples of its use. The primer is intended as a starting point for neuroimaging scientists or developers interested in using or creating apps with NIDM.
This document is part of the NIDASH Family of Documents, a set of documents defining various aspects of neuroimaging research that are necessary to achieve the vision of inter-operable interchange of information in heterogeneous environments such as the Web, research consortia, and laboratories. A list of current NIDASH documents and the latest revision of this specification can be found in the NIDM specification index. These documents are listed below.
The NIDASH Working Group encourages implementation of the specifications overviewed in this document. Work on this document by the NIDASH Working Group is ongoing, errors and suggestions may be reported in the issue tracker and these may be addressed in future revisions.
This document was published by the NIDASH Working Group as a Working Draft. If you wish to make comments regarding this document, please report using the NIDM issue tracker. You can also ask questions at Neurostars Q&A. All comments are welcome.
This primer document provides ...
This section provides an explanation of ...
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:'Model Specification' | prov:Activity | nidm:ModelSpecification |
nidm:'Project' | nidm:Project | |
nidm:'Group' | prov:'Entity' | nidm:Group |
nidm:'Protocol' | nidm:Protocol | |
nidm:'Specified Plan' | nidm:SpecifiedPlan |
nidm:'Model Specification' is a prov:Activity.
nidm:'Project' is a prov:Activity and has the following child: sio:'clinical trial'.
nidm:'Group' is a prov:'Entity' and has the following children: sio:'control group', sio:'intervention group'.
nidm:'Specified Plan' is a prov:'Entity'.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:'Behavioral Data Acquisition' | prov:Activity | nidm:BehavioralDataAcquisition |
nidm:'Demographics Data Acquisition' | nidm:DemographicsDataAcquisition | |
nidm:'Image Data Reconstruction' | nidm:ImageDataReconstruction | |
nidm:'Informed Consent Acquisition' | nidm:InformedConsentAcquisition | |
nidm:'Series' | nidm:Session | |
nidm:'Acquisition Method' | prov:'Entity' | nidm:AcquisitionMethod |
nidm:'Acquisition Modality' | nidm:AcquisitionModality | |
nidm:'Acquisition Object' | nidm:AcquisitionObject | |
nidm:'Acquisition Object Quality' | nidm:AcquisitionObjectQuality | |
nidm:'Auxiliary File' | nidm:AuxiliaryFile | |
nidm:'Auxiliary File Collection' | nidm:AuxiliaryFileCollection | |
nidm:'Clinical Assessment Acquisition Object' | nidm:ClinicalAssessmentAcquisitionObject | |
nidm:'Image Contrast Type' | nidm:ImageContrastType | |
nidm:'Image Usage Type' | nidm:ImageUsageType | |
nidm:'Performed Plan' | nidm:PerformedPlan | |
nidm:'Pulse Sequence' | nidm:PulseSequence | |
nidm:'Raw Acquisition Object' | nidm:RawAcquisitionObject | |
nidm:'Reconstructed Acquisition Object' | nidm:ReconstructedAcquisitionObject | |
nidm:'Session Object' | nidm:SessionObject | |
nidm:'Presentation Software' | prov:Agent | nidm:PresentationSoftware |
nidm:'Demographics Data Acquisition' is a nidm:'Acquisition'.
nidm:'Image Data Reconstruction' is a prov:Activity.
nidm:'Informed Consent Acquisition' is a nidm:'Acquisition'.
nidm:'Series' is a prov:Activity.
nidm:'Acquisition Method' is a nidm:'Acquisition Object Quality' and has the following children: nidm:'Amperometry', nidm:'Arterial Spin Labeling', nidm:'Current Clamp', nidm:'Dynamic Contrast Enhanced', nidm:'Dynamic Susceptibility Contrast', nidm:'Electrocorticography', nidm:'Electroencephalography', nidm:'Field Potential', nidm:'Multi-unit Recording', nidm:'Parallel Imaging', nidm:'Patch Clamp', nidm:'Sharp Electrode', nidm:'Simultaneous Multislice Method', nidm:'Single-unit Recording', nidm:'Voltage Clamp'.
nidm:'Arterial Spin Labeling' is a nidm:'Acquisition Method'.
nidm:'Dynamic Contrast Enhanced' is a nidm:'Acquisition Method'.
nidm:'Dynamic Susceptibility Contrast' is a nidm:'Acquisition Method'.
nidm:'Electroencephalography' is a nidm:'Acquisition Method'.
nidm:'Simultaneous Multislice Method' is a nidm:'Acquisition Method'.
nidm:'Single-unit Recording' is a nidm:'Acquisition Method'.
nidm:'Acquisition Modality' is a nidm:'Acquisition Object Quality' and has the following children: nidm:'Electrophysiology Recording', nidm:'Magnetic Resonance Imaging', nidm:'Magnetoencephalography', nidm:'Nuclear Magnetic Resonance Spectroscopic Imaging', nidm:'Nuclear Magnetic Resonance Spectroscopy', nidm:'Positron Emission Tomography', nidm:'X-ray Computed Tomography'.
nidm:'Electrophysiology Recording' is a nidm:'Acquisition Modality' and has the following children: nidm:'Extracellular Electrophysiology Recording', nidm:'Intracellular Electrophysiology Recording'.
nidm:'Extracellular Electrophysiology Recording' is a nidm:'Electrophysiology Recording'.
nidm:'Intracellular Electrophysiology Recording' is a nidm:'Electrophysiology Recording'.
nidm:'Magnetic Resonance Imaging' is a nidm:'Acquisition Modality'.
nidm:'Magnetoencephalography' is a nidm:'Acquisition Modality'.
nidm:'Nuclear Magnetic Resonance Spectroscopic Imaging' is a nidm:'Acquisition Modality'.
nidm:'Nuclear Magnetic Resonance Spectroscopy' is a nidm:'Acquisition Modality'.
nidm:'Positron Emission Tomography' is a nidm:'Acquisition Modality'.
nidm:'X-ray Computed Tomography' is a nidm:'Acquisition Modality'.
nidm:'Acquisition Object' is a prov:'Entity' and has the following children: neuro:assessment-instrument, neuro:instrument-variable, nidm:'Clinical Assessment Acquisition Object', nidm:'Demographics Acquisition Object', nidm:'Raw Acquisition Object', nidm:'Reconstructed Acquisition Object'.
nidm:'Acquisition Object Quality' is a prov:'Entity' and has the following children: nidm:'Acquisition Method', nidm:'Acquisition Modality', nidm:'Image Contrast Type', nidm:'Image Usage Type', nidm:'fMRI Design Type', nidm:'k-space Traversal Scheme'.
nidm:'Auxiliary File' is a prov:'Entity' and has the following children: nidm:'Stimulus Presentation File', nidm:'Stimulus Response File', nidm:'b-value File', nidm:'b-vector File'.
nidm:'Auxiliary File Collection' is a prov:'Entity'.
nidm:'Clinical Assessment Acquisition Object' is a nidm:'Acquisition Object'.
nidm:'Image Contrast Type' is a nidm:'Acquisition Object Quality' and has the following children: nidm:'Diffusion Weighted', nidm:'Flow Weighted', nidm:'Proton Density Weighted', nidm:'Susceptibility Weighted', nidm:'T1 Weighted', nidm:'T2 Weighted', nidm:'T2-Star Weighted'.
nidm:'Proton Density Weighted' is a nidm:'Image Contrast Type'.
nidm:'Susceptibility Weighted' is a nidm:'Image Contrast Type'.
nidm:'Image Usage Type' is a nidm:'Acquisition Object Quality' and has the following children: nidm:'Anatomical', nidm:'Diffusion Tensor', nidm:'Functional', nidm:'Quantitative Susceptibility Mapping', nidm:'Stimulus Response File', nidm:'Susceptibility Weighted Imaging'.
nidm:'Quantitative Susceptibility Mapping' is a nidm:'Image Usage Type'.
nidm:'Susceptibility Weighted Imaging' is a nidm:'Image Usage Type'.
nidm:'Performed Plan' is a prov:'Entity' and has the following child: nidm:'Protocol'.
nidm:'Pulse Sequence' is a prov:'Entity'.
nidm:'Raw Acquisition Object' is a nidm:'Acquisition Object'.
nidm:'Reconstructed Acquisition Object' is a nidm:'Acquisition Object' and has the following child: dctype:Image.
nidm:'Session Object' is a prov:'Entity'.
nidm:'Presentation Software' is a prov:Agent.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:'Series' | prov:Activity | nidm:Session |
nidm:'Task' | nidm:Task | |
nidm:'Anatomical' | prov:'Entity' | nidm:Anatomical |
nidm:'Cartesian' | nidm:Cartesian | |
nidm:'DICOM Tag Collection' | nidm:DICOMTagCollection | |
nidm:'Diffusion Tensor' | nidm:DiffusionTensor | |
nidm:'Diffusion Weighted' | nidm:DiffusionWeighted | |
nidm:'Dynamic Contrast Enhanced' | nidm:DynamicContrastEnhanced | |
nidm:'Dynamic Susceptibility Contrast' | nidm:DynamicSusceptibilityContrast | |
nidm:'Echo Planar' | nidm:EchoPlanar | |
nidm:'Flow Weighted' | nidm:FlowWeighted | |
nidm:'Functional' | nidm:Functional | |
nidm:'Inside-out Spiral' | nidm:Inside-outSpiral | |
nidm:'Magnetic Resonance Imaging' | nidm:MagneticResonanceImaging | |
nidm:'Nuclear Magnetic Resonance Spectroscopy' | nidm:NuclearMagneticResonanceSpectroscopy | |
nidm:'Outside-in Spiral' | nidm:Outside-inSpiral | |
nidm:'Parallel Imaging' | nidm:ParallelImaging | |
nidm:'Proton Density Weighted' | nidm:ProtonDensityWeighted | |
nidm:'Rectilinear' | nidm:Rectilinear | |
nidm:'Simultaneous Multislice Method' | nidm:SimultaneousMultisliceMethod | |
nidm:'Stimulus Presentation File' | nidm:StimulusPresentationFile | |
nidm:'Stimulus Response File' | nidm:StimulusResponseFile | |
nidm:'Stimulus Response File' | nidm:Structural | |
nidm:'Susceptibility Weighted' | nidm:SusceptibilityWeighted | |
nidm:'Susceptibility Weighted Imaging' | nidm:SusceptibilityWeightedImaging | |
nidm:'T1 Weighted' | nidm:T1Weighted | |
nidm:'T2-Star Weighted' | nidm:T2StarWeighted | |
nidm:'T2 Weighted' | nidm:T2Weighted | |
nidm:'b-value File' | nidm:b-ValueFile | |
nidm:'b-vector File' | nidm:b-VectorFile | |
nidm:'k-space Traversal Scheme' | nidm:k-spaceTraversalScheme | |
nidm:'Block-Based Design' | nidm:NIDM_0000152 | |
nidm:'Event-Related Design' | nidm:NIDM_0000153 | |
nidm:'Mixed Design' | nidm:NIDM_0000154 | |
nidm:'fMRI Design Type' | nidm:NIDM_0000155 |
nidm:'Series' is a prov:Activity.
nidm:'Task' is a prov:Activity.
nidm:'DICOM Tag Collection' is a prov:'Entity'.
nidm:'Dynamic Contrast Enhanced' is a nidm:'Acquisition Method'.
nidm:'Dynamic Susceptibility Contrast' is a nidm:'Acquisition Method'.
nidm:'Inside-out Spiral' is a nidm:'k-space Traversal Scheme'.
nidm:'Magnetic Resonance Imaging' is a nidm:'Acquisition Modality'.
nidm:'Nuclear Magnetic Resonance Spectroscopy' is a nidm:'Acquisition Modality'.
nidm:'Outside-in Spiral' is a nidm:'k-space Traversal Scheme'.
nidm:'Proton Density Weighted' is a nidm:'Image Contrast Type'.
nidm:'Simultaneous Multislice Method' is a nidm:'Acquisition Method'.
nidm:'Stimulus Presentation File' is a nidm:'Auxiliary File'.
nidm:'Susceptibility Weighted' is a nidm:'Image Contrast Type'.
nidm:'Susceptibility Weighted Imaging' is a nidm:'Image Usage Type'.
nidm:'k-space Traversal Scheme' is a nidm:'Acquisition Object Quality' and has the following children: nidm:'Cartesian', nidm:'Echo Planar', nidm:'Inside-out Spiral', nidm:'Outside-in Spiral', nidm:'Rectilinear'.
nidm:'fMRI Design Type' is a nidm:'Acquisition Object Quality' and has the following children: nidm:'Block-Based Design', nidm:'Event-Related Design', nidm:'Mixed Design'.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:'Amperometry' | prov:'Entity' | nidm:Amperometry |
nidm:'Current Clamp' | nidm:CurrentClamp | |
nidm:'Electroencephalography' | nidm:Electroencephalography | |
nidm:'Extracellular Electrophysiology Recording' | nidm:ExtracellularElectrophysiologyRecording | |
nidm:'Electrocorticography' | nidm:Electrocorticography | |
nidm:'Field Potential' | nidm:FieldPotential | |
nidm:'Intracellular Electrophysiology Recording' | nidm:IntracellularElectrophysiologyRecording | |
nidm:'Multi-unit Recording' | nidm:MultiUnitReccording | |
nidm:'Sharp Electrode' | nidm:SharpElectrode | |
nidm:'Single-unit Recording' | nidm:SingleUnitReccording | |
nidm:'Patch Clamp' | nidm:PatchClamp | |
nidm:'Voltage Clamp' | nidm:VoltageClamp |
nidm:'Electroencephalography' is a nidm:'Acquisition Method'.
nidm:'Extracellular Electrophysiology Recording' is a nidm:'Electrophysiology Recording'.
nidm:'Intracellular Electrophysiology Recording' is a nidm:'Electrophysiology Recording'.
nidm:'Single-unit Recording' is a nidm:'Acquisition Method'.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:'Positron Emission Tomography' | prov:'Entity' | nidm:PositronEmissionTomography |
nidm:'Positron Emission Tomography' is a nidm:'Acquisition Modality'.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:'X-ray Computed Tomography' | prov:'Entity' | nidm:X-rayComputedTomography |
nidm:'X-ray Computed Tomography' is a nidm:'Acquisition Modality'.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:'Acquisition' | prov:Activity | nidm:Acquisition |
nidm:'Clinical Data Acquisition' | nidm:ClinicalDataAcquisition | |
nidm:'Series' | nidm:Series | |
nidm:'Demographics Acquisition Object' | prov:'Entity' | nidm:DemographicsAcquisitionObject |
nidm:'Acquisition' is a prov:Activity and has the following children: neuro:instrument-based-assessment, neuro:variable-assessment, nidm:'Behavioral Data Acquisition', nidm:'Clinical Data Acquisition', nidm:'Demographics Data Acquisition', nidm:'Informed Consent Acquisition'.
neuro:instrument-based-assessment is a nidm:'Acquisition' and has the following children: neuro:questionnaire-based-assessment, neuro:test-based-assessment.
neuro:questionnaire-based-assessment is a prov:Activity and has the following children: neuro:behavioural-interview, neuro:neuroclinical-interview, neuro:psychological-interview.
neuro:behavioural-interview is a prov:Activity.
neuro:neuroclinical-interview is a prov:Activity.
neuro:psychological-interview is a prov:Activity.
neuro:test-based-assessment is a prov:Activity and has the following children: neuro:behavioural-test, neuro:neuroclinical-test, neuro:psychological-test.
neuro:behavioural-test is a prov:Activity.
neuro:neuroclinical-test is a prov:Activity.
neuro:psychological-test is a prov:Activity and has the following children: neuro:experimental-psychology-test, neuro:neuropsychological-test.
neuro:experimental-psychology-test is and has the following child: neuro:psychophysical-test.
neuro:variable-assessment is a nidm:'Acquisition' and has the following children: neuro:coded-variable-assessment, neuro:numerical-variable-assessment.
neuro:coded-variable-assessment is a prov:Activity.
neuro:numerical-variable-assessment is a prov:Activity.
nidm:'Series' is a prov:Activity.
nidm:'Demographics Acquisition Object' is a nidm:'Acquisition Object'.
TBD
TBD
This document has been produced by the NIDASH Working Group, and its contents reflect extensive discussion within the Working Group as a whole.
Members of the NIDASH Working Group at the time of publication of this document were: