LogoLogo
  • 🐿️NeuroInformatics Database
    • HIPAA Compliance
  • Getting Started
    • Installation
      • Quick Install
      • How to change passwords
      • Optional software
      • MySQL/MariaDB tweaks
    • Upgrade
      • Quick Upgrade
      • Migrate Existing Installation
  • Using NiDB
    • User's Guide
      • Importing data
      • Managing data
      • Finding & exporting data
      • Managing projects
      • Pipelines & analysis
      • Calendar
    • Administration
      • Front end (user facing)
      • Back end
      • nidb command line
  • Specifications
    • Data Storage Hierarchy
    • DICOM Anonymization
  • Tutorials
    • Working with Imaging Data
      • Uploading data for a sample project
      • Troubleshooting Missing Imaging Data
      • Import DICOM data
      • MR scan quality control
    • Manipulating Subjects, Studies, & Series
      • Working with subject IDs
      • Renaming series
    • Pipelines
    • Working with Redcap
      • Importing Data from a Redcap Project
      • Importing Subjects from Redcap
      • Reports based on data imported from Redcap
    • Analysis Builder
    • Administration of Users, Projects, & System
      • User Permissions
      • Creating new projects
      • Adding Users to Projects
      • Editing the config file
      • Deleting all the data
  • Contribute
    • Squirrel data sharing format
      • squirrel utilities
      • Using the squirrel library
      • Example package
      • squirrel vs BIDS
      • Specification v1.0
        • Package root
        • package
        • data
          • subjects
            • studies
              • series
                • params
              • analysis
            • observations
            • interventions
          • group-analysis
        • pipelines
          • data-steps
          • Pipeline scripts
        • experiments
        • data-dictionary
        • Modalities
      • Building squirrel library and utils
        • Building Python Wrapper
    • Building NiDB
    • Creating a Development VM
  • Help!
    • Github Issues
    • Github Discussions
Powered by GitBook
On this page
  • JSON variables
  • Recording drug administration

Was this helpful?

Export as PDF
  1. Contribute
  2. Squirrel data sharing format
  3. Specification v1.0
  4. data
  5. subjects

interventions

JSON array

PreviousobservationsNextgroup-analysis

Last updated 8 months ago

Was this helpful?

Interventions represent any substances or procedures administered to a participant; through a clinical trial or the participant’s use of prescription or recreational drugs. Detailed variables are available to record exactly how much and when a drug is administered. This allows searching by dose amount, or other variable.

JSON variables

Variable
Type
Default
Description

AdministrationRoute

string

Drug entry route (oral, IV, unknown, etc).

DateRecordCreate

string

Date the record was created in the current database. The original record may have been imported from another database.

DateRecordEntry

string

Date the record was first entered into a database.

DateRecordModify

string

Date the record was modified in the current database.

DateEnd

datetime

Datetime the intervention was stopped.

DateStart

datetime

Datetime the intervention was started.

Description

string

Longer description.

DoseString

string

Full dosing string. Examples tylenol 325mg twice daily by mouth, or 5g marijuana inhaled by volcano

DoseAmount

number

In combination with other dose variables, the quantity of the drug.

DoseFrequency

string

Description of the frequency of administration.

DoseKey

string

For clinical trials, the dose key.

DoseUnit

string

mg, g, ml, tablets, capsules, etc.

InterventionClass

string

Drug class.

InterventionName

string

Name of the intervention.

Notes

string

Notes about drug.

Rater

string

Rater/experimenter name.

Recording drug administration

The following examples convert between common language and the squirrel storage format

esomeprazole 20mg capsule by mouth daily

Variable
Value

DrugClass

PPI

DrugName

esomeprazole

DoseAmount

20mg

DoseFrequency

daily

Route

oral

DoseUnit

mg

2 puffs atrovent inhaler every 6 hours

Variable
Value

DrugName

ipratropium

DrugClass

bronchodilator

DoseAmount

2

DoseFrequency

every 6 hours

AdministrationRoute

inhaled

DoseUnit

puffs

Primary key Required

🔵
🔴
🔴
🔴
🔴
🔵