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:Model | nidm:Model | |
nidm:OrganismType | nidm:OrganismType | |
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:Model is a prov:'Entity'.
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:Session | nidm:Session | |
nidm:'Acquisition Method' | prov:'Entity' | nidm:AcquisitionMethod |
nidm:'Acquisition Modality' | nidm:AcquisitionModality | |
nidm:'Acquisition Object' | nidm:AcquisitionObject | |
nidm:AcquisitionObjectQuality | nidm:AcquisitionObjectQuality | |
nidm:'Auxiliary File' | nidm:AuxiliaryFile | |
nidm:'Auxiliary File Collection' | nidm:AuxiliaryFileCollection | |
nidm:'Clinical Assessment Acquisition Object' | nidm:ClinicalAssessmentAcquisitionObject | |
nidm:'Computer' | nidm:Computer | |
nidm:'DICOM Tag Collection' | nidm:DICOMTagCollection | |
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:PresentationSoftware | prov:Agent | nidm:PresentationSoftware |
nidm:'Image Data Reconstruction' is a prov:Activity.
nidm:Session is a prov:Activity.
nidm:'Acquisition Method' is a nidm:AcquisitionObjectQuality and has the following children: nidm:'Amperometry', nidm:'Current Clamp', nidm:'Field Potential', nidm:'Multi-unit Recording', nidm:'Parallel Imaging Method', nidm:'Patch Clamp', nidm:'Sharp Electrode', nidm:'Simultaneous Multislice Method', nidm:'Single-unit Recording', nidm:'Voltage Clamp'.
nidm:'Parallel Imaging Method' is a nidm:'Acquisition Method'.
nidm:'Simultaneous Multislice Method' is a nidm:'Acquisition Method'.
nidm:'Acquisition Modality' is a nidm:AcquisitionObjectQuality and has the following children: nidm:'Computed Tomography', nidm:'Electrocorticography', nidm:'Electroencephalography', nidm:'Extracellular Electrophysiology Recording', nidm:'Intracellular Electrophysiology Recording', nidm:'Magnetic Resonance Imaging', nidm:'Magnetoencephalography', nidm:'Nuclear Magnetic Resonance Spectroscopy', nidm:'Positron Emission Tomography'.
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:AcquisitionObjectQuality 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:'Computer' is a prov:'Entity'.
nidm:'DICOM Tag Collection' is a prov:'Entity'.
nidm:'Image Contrast Type' is a nidm:AcquisitionObjectQuality and has the following children: nidm:'Diffusion Weighted', nidm:'Flow Weighted', nidm:'Proton Density Weighted', nidm:'Susceptibility Weighted', nidm:'T1 Weighted', nidm:'T2 Star Weighted', nidm:'T2 Weighted'.
nidm:'Image Usage Type' is a nidm:AcquisitionObjectQuality and has the following children: nidm:'Diffusion Tensor', nidm:'Dynamic Susceptibility Contrast', nidm:'Dynamic Susceptibility Enhancement', nidm:'Susceptibility Weighted Imaging', nidm:Anatomical, nidm:Functional, nidm:Structural.
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:PresentationSoftware is a prov:Agent.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:Session | prov:Activity | nidm:Session |
nidm:'Task' | nidm:Task | |
nidm:'Amperometry' | prov:'Entity' | nidm:Amperometry |
nidm:Anatomical | nidm:Anatomical | |
nidm:'Cartesian' | nidm:Cartesian | |
nidm:'Computed Tomography' | nidm:ComputedTomography | |
nidm:'Current Clamp' | nidm:CurrentClamp | |
nidm:'Diffusion Tensor' | nidm:DiffusionTensor | |
nidm:'Diffusion Weighted' | nidm:DiffusionWeighted | |
nidm:'Dynamic Susceptibility Enhancement' | nidm:DynamicContrastEnhancement | |
nidm:'Dynamic Susceptibility Contrast' | nidm:DynamicSusceptibilityContrast | |
nidm:'Echo Planar' | nidm:EchoPlanar | |
nidm:'Electrocorticography' | nidm:Electrocorticography | |
nidm:'Electroencephalography' | nidm:Electroencephalography | |
nidm:'Extracellular Electrophysiology Recording' | nidm:ExtracellularElectrophysiologyRecording | |
nidm:'Field Potential' | nidm:FieldPotential | |
nidm:FingerTappingTest | nidm:FingerTappingTest | |
nidm:'Flow Weighted' | nidm:FlowWeighted | |
nidm:Functional | nidm:Functional | |
nidm:'Inside-out Spiral' | nidm:Inside-outSpiral | |
nidm:'Intracellular Electrophysiology Recording' | nidm:IntracellularElectrophysiologyRecording | |
nidm:'Magnetic Resonance Imaging' | nidm:MagneticResonanceImaging | |
nidm:'Multi-unit Recording' | nidm:MultiUnitReccording | |
nidm:'Nuclear Magnetic Resonance Spectroscopy' | nidm:NuclearMagneticResonanceSpectroscopy | |
nidm:'Outside-in Spiral' | nidm:Outside-inSpiral | |
nidm:'Parallel Imaging Method' | nidm:ParallelImagingMethod | |
nidm:'Patch Clamp' | nidm:PatchClamp | |
nidm:'Positron Emission Tomography' | nidm:PositronEmissionTomography | |
nidm:'Proton Density Weighted' | nidm:ProtonDensityWeighted | |
nidm:'Rectilinear' | nidm:Rectilinear | |
nidm:'Sharp Electrode' | nidm:SharpElectrode | |
nidm:'Simultaneous Multislice Method' | nidm:SimultaneousMultisliceMethod | |
nidm:'Single-unit Recording' | nidm:SingleUnitReccording | |
nidm:'Stimulus Presentation File' | nidm:StimulusPresentationFile | |
nidm:'Stimulus Response File' | nidm:StimulusResponseFile | |
nidm:Structural | 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:'Voltage Clamp' | nidm:VoltageClamp | |
nidm:'b-value File' | nidm:bValueFile | |
nidm:'b-vector File' | nidm:bVectorFile | |
nidm:'k-space Traversal Scheme' | nidm:k-spaceTraversalScheme |
nidm:Session is a prov:Activity.
nidm:'Task' is a prov:Activity.
nidm:FingerTappingTest is a prov:'Entity'.
nidm:'Inside-out Spiral' is a nidm:'k-space Traversal Scheme'.
nidm:'Outside-in Spiral' is a nidm:'k-space Traversal Scheme'.
nidm:'Parallel Imaging Method' is a nidm:'Acquisition Method'.
nidm:'Simultaneous Multislice Method' is a nidm:'Acquisition Method'.
nidm:'Stimulus Presentation File' is a nidm:'Auxiliary File'.
nidm:'k-space Traversal Scheme' is a nidm:AcquisitionObjectQuality and has the following children: nidm:'Cartesian', nidm:'Echo Planar', nidm:'Inside-out Spiral', nidm:'Outside-in Spiral', nidm:'Rectilinear'.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:BarnesScale | prov:'Entity' | nidm:BarnesScale |
nidm:CalgaryDepressionScale | nidm:CalgaryDepressionScale | |
nidm:CategoryFluencyTest | nidm:CategoryFluencyTest | |
nidm:ClinicalGlobalImpression | nidm:ClinicalGlobalImpression | |
nidm:CombinedAssessment | nidm:CombinedAssessment | |
nidm:ContinuousPerformanceTest | nidm:ContinuousPerformanceTest | |
nidm:DelayedSemanticVerbalLearningTest | nidm:DelayedSemanticVerbalLearningTest | |
nidm:DelayedVisualFiguralLearningTest | nidm:DelayedVisualFiguralLearningTest | |
nidm:EdinburghHandnessTest | nidm:EdinburghHandnessTest | |
nidm:FacialEmotionDiscriminationTest | nidm:FacialEmotionDiscriminationTest | |
nidm:FagerstromSmokingTest | nidm:FagerstromSmokingTest | |
nidm:LetterFluencyTest | nidm:LetterFluencyTest | |
nidm:LetterNumberSpanTest | nidm:LetterNumberSpanTest | |
nidm:MazeSolvingTest | nidm:MazeSolvingTest | |
nidm:NorthAmericanAdultReadingTest | nidm:NorthAmericanAdultReadingTest | |
nidm:PositiveAndNegativeSyndromeScale | nidm:PositiveAndNegativeSyndromeScale | |
nidm:PremorbidAdjustment | nidm:PremorbidAdjustment | |
nidm:SemanticVerbalLearningTest | nidm:SemanticVerbalLearningTest | |
nidm:SimpsonAngusRatingScale | nidm:SimpsonAngusRatingScale | |
nidm:SocioeconomicScale | nidm:SocioeconomicScale | |
nidm:SpatialMemorySpan | nidm:SpatialMemorySpan | |
nidm:StroopTest | nidm:StroopTest | |
nidm:SymbolDigitAssociationTest | nidm:SymbolDigitAssociationTest | |
nidm:TrailsA | nidm:TrailsA | |
nidm:TrailsB | nidm:TrailsB | |
nidm:VisualFiguralLearningTest | nidm:VisualFiguralLearningTest | |
nidm:WisconsinCardSortingTest | nidm:WisconsinCardSortingTest |
nidm:BarnesScale is a prov:'Entity'.
nidm:CalgaryDepressionScale is a prov:'Entity'.
nidm:CategoryFluencyTest is a prov:'Entity'.
nidm:ClinicalGlobalImpression is a prov:'Entity'.
nidm:CombinedAssessment is a prov:'Entity'.
nidm:ContinuousPerformanceTest is a prov:'Entity'.
nidm:DelayedSemanticVerbalLearningTest is a prov:'Entity'.
nidm:DelayedVisualFiguralLearningTest is a prov:'Entity'.
nidm:EdinburghHandnessTest is a prov:'Entity'.
nidm:FacialEmotionDiscriminationTest is a prov:'Entity'.
nidm:FagerstromSmokingTest is a prov:'Entity'.
nidm:LetterFluencyTest is a prov:'Entity'.
nidm:LetterNumberSpanTest is a prov:'Entity'.
nidm:MazeSolvingTest is a prov:'Entity'.
nidm:NorthAmericanAdultReadingTest is a prov:'Entity'.
nidm:PositiveAndNegativeSyndromeScale is a prov:'Entity'.
nidm:PremorbidAdjustment is a prov:'Entity'.
nidm:SemanticVerbalLearningTest is a prov:'Entity'.
nidm:SimpsonAngusRatingScale is a prov:'Entity'.
nidm:SocioeconomicScale is a prov:'Entity'.
nidm:SpatialMemorySpan is a prov:'Entity'.
nidm:StroopTest is a prov:'Entity'.
nidm:SymbolDigitAssociationTest is a prov:'Entity'.
nidm:TrailsA is a prov:'Entity'.
nidm:TrailsB is a prov:'Entity'.
nidm:VisualFiguralLearningTest is a prov:'Entity'.
nidm:WisconsinCardSortingTest is a prov:'Entity'.
NIDM-Experiment Concept | PROV type | Identifier |
---|---|---|
nidm:Acquisition | prov:Activity | nidm:Acquisition |
nidm:'Demographics Acquisition Object' | prov:'Entity' | nidm:DemographicsAcquisitionObject |
nidm:'fMRI Design Type' | nidm:NIDM_0000155 |
nidm:Acquisition is a prov:Activity and has the following children: neuro:instrument-based-assessment, neuro:variable-assessment, nidm:'Behavioral 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:'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: