Procedure schemas

Type-specific details of in-vivo procedures performed on a subject.

Table of contents

  1. How to use this family
  2. Quick type map
  3. Anesthesia, Drug and Fluid Administration
    1. Analgesic
    2. Anesthesia
    3. Anti-inflammatory
    4. Antibiotic
    5. Drug administration (other)
    6. Fluid therapy
    7. Local anesthetic
    8. Sedative
  4. Surgical Procedures
    1. Baseplating
    2. Burr hole
    3. Cranial window
    4. Craniectomy
    5. Craniotomy
    6. Head fixation
    7. Headcap
    8. Headpost
  5. Implant Procedures
    1. Blood pressure sensor implant
    2. Breathing sensor implant
    3. Cannula implant
    4. Catheter implant
    5. ECG implant (Electrocardiography)
    6. ECoG implant (Electrocorticography)
    7. EEG implant (Electroencephalography)
    8. EMG implant (Electromyography)
    9. Generic implant
    10. GRIN (Gradient Index) lens implant
    11. Nerve cuff implant
    12. Optic fiber implant
    13. Prism implant
    14. Reference electrode implant
    15. Silicon probe implant
    16. Single wire electrode implant
    17. Temperature sensor implant
    18. Tetrode wire electrode implant
  6. Injection and Infusion Procedures
    1. Injection
    2. Virus injection
  7. Sample Collection Procedures
    1. Blood collection
    2. Tissue collection
  8. Brain and Tissue Procedures
    1. Brain extraction
    2. Brain lesion
    3. Brain perfusion fixation
  9. Endpoint Procedures (Euthanasia)
    1. Barbiturate injection
    2. Cervical dislocation
    3. CO₂ chamber euthanasia
    4. Decapitation
    5. Inhalant overdose

How to use this family

  • procedure: set type to a type code below and send its properties in details.
  • proceduretemplate: set type to a type code below and send its properties in details.
  • Every version is published at https://www.brainstem.org/schemas/Procedure/<Type>/<version>.json and never changes; https://www.brainstem.org/schemas/Procedure/<Type>.json is the current version and https://www.brainstem.org/schemas/Procedure/<Type>/ lists the versions. See Public schemas.
  • Quantities are objects {"value": <number>, "unit": "<code>"}. Property paths with [] are inside a repeatable list of rows. The server sets the schema version field itself.

Quick type map

Type codeTitleGroupVersionRequired propertiesSchema
AnalgesicAnalgesicAnesthesia, Drug and Fluid Administration2.0.0route2.0.0.json
AnesthesiaAnesthesiaAnesthesia, Drug and Fluid Administration8.0.1none8.0.1.json
AntiInflammatoryAnti-inflammatoryAnesthesia, Drug and Fluid Administration2.0.0route2.0.0.json
AntibioticAntibioticAnesthesia, Drug and Fluid Administration2.0.0route, indication2.0.0.json
BarbiturateInjectionBarbiturate injectionEndpoint Procedures (Euthanasia)5.0.0route, confirmationOfDeath5.0.0.json
BaseplatingBaseplatingSurgical Procedures1.0.0none1.0.0.json
BloodCollectionBlood collectionSample Collection Procedures2.0.0collectionSite2.0.0.json
BloodPressureSensorImplantBlood pressure sensor implantImplant Procedures4.0.0sensorType, fixationMethod4.0.0.json
BrainExtractionBrain extractionBrain and Tissue Procedures3.0.2extractionMethod, preservationMethod3.0.2.json
BrainLesionBrain lesionBrain and Tissue Procedures2.0.0none2.0.0.json
BreathingSensorImplantBreathing sensor implantImplant Procedures5.0.0sensorType, fixationMethod5.0.0.json
BurrHoleBurr holeSurgical Procedures2.1.0none2.1.0.json
CannulaImplantCannula implantImplant Procedures1.1.0targetSite1.1.0.json
CatheterImplantCatheter implantImplant Procedures4.0.0targetSite4.0.0.json
CervicalDislocationCervical dislocationEndpoint Procedures (Euthanasia)2.0.3dislocationMethod, confirmationOfDeath2.0.3.json
Co2ChamberEuthanasiaCO₂ chamber euthanasiaEndpoint Procedures (Euthanasia)4.0.0co2Concentration, exposureDuration, confirmationOfDeath4.0.0.json
CranialWindowCranial windowSurgical Procedures1.2.1none1.2.1.json
CraniectomyCraniectomySurgical Procedures2.0.1none2.0.1.json
CraniotomyCraniotomySurgical Procedures2.0.1none2.0.1.json
DecapitationDecapitationEndpoint Procedures (Euthanasia)3.0.1decapitationMethod3.0.1.json
DrugAdministrationDrug administration (other)Anesthesia, Drug and Fluid Administration3.0.0purpose, route3.0.0.json
EcgImplantECG implant (Electrocardiography)Implant Procedures4.0.0fixationMethod4.0.0.json
EcogImplantECoG implant (Electrocorticography)Implant Procedures1.0.1none1.0.1.json
EegImplantEEG implant (Electroencephalography)Implant Procedures4.0.0wireCount, electrodeType, electrodeMaterial, fixationMethod4.0.0.json
EmgImplantEMG implant (Electromyography)Implant Procedures3.1.0wireCount, implantMethod3.1.0.json
FluidTherapyFluid therapyAnesthesia, Drug and Fluid Administration2.0.0volume, route2.0.0.json
GenericImplantGeneric implantImplant Procedures2.1.0implantType2.1.0.json
GrinLensImplantGRIN (Gradient Index) lens implantImplant Procedures2.1.0none2.1.0.json
HeadFixationHead fixationSurgical Procedures2.0.3none2.0.3.json
HeadcapHeadcapSurgical Procedures4.0.1none4.0.1.json
HeadpostHeadpostSurgical Procedures4.0.1none4.0.1.json
InhalantOverdoseInhalant overdoseEndpoint Procedures (Euthanasia)5.0.0none5.0.0.json
InjectionInjectionInjection and Infusion Procedures3.1.0none3.1.0.json
LocalAnestheticLocal anestheticAnesthesia, Drug and Fluid Administration2.0.0placementTechnique2.0.0.json
NerveCuffImplantNerve cuff implantImplant Procedures5.0.0cuffType, fixationMethod5.0.0.json
OpticFiberImplantOptic fiber implantImplant Procedures2.2.1none2.2.1.json
PerfusionFixationBrain perfusion fixationBrain and Tissue Procedures3.0.1none3.0.1.json
PrismImplantPrism implantImplant Procedures3.0.0none3.0.0.json
ReferenceElectrodeImplantReference electrode implantImplant Procedures2.1.0electrodeCount, electrodeMaterial2.1.0.json
SedativeSedativeAnesthesia, Drug and Fluid Administration2.0.1route2.0.1.json
SiliconProbeImplantSilicon probe implantImplant Procedures2.2.1none2.2.1.json
SingleWireElectrodeImplantSingle wire electrode implantImplant Procedures2.1.0wireCount2.1.0.json
TemperatureSensorImplantTemperature sensor implantImplant Procedures5.0.0sensorType, fixationMethod5.0.0.json
TetrodeWireElectrodeImplantTetrode wire electrode implantImplant Procedures3.0.1tetrodeCount3.0.1.json
TissueCollectionTissue collectionSample Collection Procedures2.0.0collectionSite2.0.0.json
VirusInjectionVirus injectionInjection and Infusion Procedures3.0.0none3.0.0.json

Anesthesia, Drug and Fluid Administration

Analgesic

  • type code Analgesic · version 2.0.0 · schema

The administration of a pain-relieving agent, such as buprenorphine or meloxicam. Use this for systemic analgesia given before, during, or after a potentially painful intervention.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeVolume administeredquantity with unit units mL, µL, L; default {"unit": "mL"}Total volume of solution delivered to the animal in this administration, not the share of any one component.
routeAdministration routechoiceyesone of sc, ip, im, iv, oral, topical, otherRoute of analgesic administration.
indicationIndicationchoice one of prophylactic, therapeuticWhether the analgesic was given to prevent expected pain or to treat pain already present.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "route": "sc",
    "volume": {
        "value": 1,
        "unit": "mL"
    },
    "indication": "prophylactic"
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ActiveAgent (Active agent)yes PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyesApplied dose or concentration
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
CarrierGas (Carrier gas)  MedicalGasMedicalGasyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Anesthesia

  • type code Anesthesia · version 8.0.1 · schema

The administration of anesthetic agents to induce unconsciousness, analgesia, or sedation. This entry captures anesthetic protocol details and can stand alone or support a larger procedure episode.

PropertyTitleShapeRequiredAllowed valuesMeaning
depthAnesthetic depthchoice one of light_sedation, moderate_sedation, deep_sedation, surgical_plane, otherThe anesthetic depth reached; deep sedation is not surgical plane.
endOfAnesthesiaEnd of anesthesiatext  Time when anesthesia ended, as HH:MM.
durationTotal durationquantity with unit units h, min, s; default {"unit": "min"}Total time the animal spent under anesthesia, across every phase of it.
recoveryTimeRecovery timequantity with unit units h, min, s; default {"unit": "min"}Time from end of anesthesia to return of righting reflex or normal activity.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.
monitoringMonitoringtable of rows format tableWhat was followed during the anesthetic, how it was assessed, and how often. One row per parameter; an empty table means nothing was monitored.
monitoring[].parameterParameterchoiceyesone of anesthetic_depth, blood_pressure, heart_rate, oxygen_saturation, respiratory_rate, temperature, otherWhat this row followed — the parameter itself, never the instrument that read it. Anesthetic depth is one of them: choose it, and record the checks used beside it.
monitoring[].methodAssessment methodmulti-select one of pedal_withdrawal_reflex, palpebral_reflex, corneal_reflex, tail_pinch_reflex, visual_observation, pulse_oximetry, ecg, eeg, capnography, rectal_probe, other; format select2How this parameter was assessed; select every check or instrument used.
monitoring[].intervalIntervalquantity with unit units h, min, s; default {"unit": "min"}How often this parameter was checked. Leave empty for continuous monitoring.
supportiveCareSupportive caretable of rows format tableCare given alongside the anesthetic. One row per measure; an empty table means none was given.
supportiveCare[].measureMeasurechoiceyesone of eye_lubricant, fluid_therapy, heating_pad, oxygen_supplementation, otherWhich supportive measure was given while the animal was under.

Illustrative payload:

{
    "depth": "light_sedation",
    "endOfAnesthesia": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
AnestheticAgent (Anesthetic agent)yes PharmacologicalAgentPharmacologicalAgentyesApplied dose or concentration
CarrierGas (Carrier gas)  MedicalGasMedicalGasyes 
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
ReversalAgent (Reversal agent)  PharmacologicalAgentPharmacologicalAgentyes 
SupportiveAgent (Supportive-care agent)  PharmacologicalAgent, PhysiologicalSolutionPharmacologicalAgent, PhysiologicalSolutionyes 
SurgicalSupply (Anesthesia supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other anesthesia material)    yes 

Stages:

  • induction (Induction), no detail schema; repeatable
  • maintenance (Maintenance), no detail schema; repeatable
  • top_up (Top-up), no detail schema; repeatable
  • reversal (Reversal), no detail schema; repeatable
  • emergence (Emergence), no detail schema; repeatable
  • other (Other), no detail schema; repeatable

Anti-inflammatory

  • type code AntiInflammatory · version 2.0.0 · schema

The administration of a corticosteroid, NSAID, or another agent to reduce inflammation.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeVolume administeredquantity with unit units mL, µL, L; default {"unit": "mL"}Total volume of solution physically administered.
routeAdministration routechoiceyesone of sc, ip, im, iv, oral, topical, otherRoute of administration.
indicationIndicationchoice one of prophylactic, therapeuticWhether the anti-inflammatory was given to prevent inflammation or to treat inflammation already present.
administrationRoleAdministration rolechoice one of clinical_care, experimental_treatmentWhether the agent was given as clinical care or as the experimental treatment itself.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "route": "sc",
    "volume": {
        "value": 1,
        "unit": "mL"
    },
    "indication": "prophylactic"
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ActiveAgent (Active agent)yes PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyesApplied dose or concentration
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Antibiotic

  • type code Antibiotic · version 2.0.0 · schema

The administration of an antimicrobial agent, whether given preventively, as treatment, or as the experimental manipulation itself.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeVolume administeredquantity with unit units mL, µL, L; default {"unit": "mL"}Total volume actually administered, spanning the agent and any vehicle.
routeAdministration routechoiceyesone of sc, ip, im, iv, oral, topical, otherRoute of antibiotic administration.
indicationIndicationchoiceyesone of prophylactic, therapeutic, experimental_manipulation, otherWhether the antibiotic was given to prevent a problem, to treat an observed one, or as the experimental manipulation itself.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "route": "sc",
    "indication": "prophylactic",
    "volume": {
        "value": 1,
        "unit": "mL"
    },
    "fatalOutcome": "not_fatal"
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ActiveAgent (Active agent)yes PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyesApplied dose or concentration
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Drug administration (other)

  • type code DrugAdministration · version 3.0.0 · schema

Use this catch-all only for medication that does not fit a dedicated type, such as a hormone, reversal agent, antidote, or supplement. File by why the drug was given, not by what the drug is: meloxicam for pain is an analgesic, not a drug administration.

PropertyTitleShapeRequiredAllowed valuesMeaning
purposePurposechoiceyesone of hormone, reversal_antidote, supplement, otherWhat the substance was given for. Use a dedicated procedure type wherever one fits.
administrationRoleAdministration rolechoice one of clinical_care, experimental_treatmentWhether the substance was given as supportive care or as the experimental treatment itself.
volumeVolume administeredquantity with unit units mL, µL, L; default {"unit": "mL"}Total volume of solution delivered to the animal in this administration.
routeAdministration routechoiceyesone of sc, ip, im, iv, oral, topical, inhaled, otherRoute of administration.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "purpose": "hormone",
    "route": "sc",
    "administrationRole": "clinical_care",
    "volume": {
        "value": 1,
        "unit": "mL"
    }
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ActiveAgent (Active agent)yes PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyesApplied dose or concentration
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
CarrierGas (Carrier gas)  MedicalGasMedicalGasyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Fluid therapy

  • type code FluidTherapy · version 2.0.0 · schema

The administration of a physiological solution, such as saline or Ringer’s solution, for hydration or volume support. Record the total procedure-level volume and the clinical problem it addressed; state the delivery profile rather than leaving the rate empty to imply a bolus.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeTotal volume administeredquantity with unityesunits L, mL, µL; default {"unit": "mL"}Total volume of fluid administered in this event, summed across every site.
routeAdministration routechoiceyesone of sc, ip, iv, io, oral, otherRoute of fluid administration.
injectionProfileDelivery profilechoice one of bolus_injection, slow_injection, continuous_infusionThe shape the delivery took over time.
rateInfusion ratequantity with unit units mL/h, mL/kg/h, µL/h; default {"unit": "mL/h"}The rate set for this delivery, as configured rather than measured afterwards.
numberOfSitesNumber of sitesinteger ≥ 1How many separate needle placements or entry points the total volume was divided across.
temperatureFluid temperaturequantity with unit units °C, °F, K; default {"unit": "°C"}Temperature of the fluid itself when it was given, not the animal’s body temperature.
fluidIndicationFluid indicationchoice one of dehydration, perioperative_support, blood_or_fluid_loss, reduced_intake_or_anorexia, hypoglycaemia, otherWhich clinical problem the fluid was given to address.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "volume": {
        "value": 1,
        "unit": "mL"
    },
    "route": "sc",
    "injectionProfile": "bolus_injection",
    "rate": {
        "value": 1,
        "unit": "mL/h"
    }
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
AdministeredFluid (Administered fluid)yes PhysiologicalSolution, PharmacologicalAgentPhysiologicalSolution, PharmacologicalAgentyes 
FluidAdditive (Fluid additive)  PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Local anesthetic

  • type code LocalAnesthetic · version 2.0.0 · schema

A site-directed nerve block, infiltration, or topical application, such as bupivacaine at an incision line. Use Analgesic instead for systemic pain relief.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeVolume administeredquantity with unit units mL, µL, L; default {"unit": "mL"}Total volume of anaesthetic solution placed at the site in this administration.
placementTechniquePlacement techniquechoiceyesone of infiltration, perineural, splash, instillation, topical_application, otherHow the anaesthetic was physically deposited in or on the tissue.
siteSitetext  Structure or region the anaesthetic was placed at; record the side in the laterality field.
lateralityLateralitychoice one of left, right, bilateral, midlineWhich side of the body the anaesthetic was placed on.
guidanceMethodGuidance methodchoice one of blind_landmark, nerve_locator, ultrasound, direct_vision, otherHow the target was located while the anaesthetic was being placed.
applicationDwellTimeApplication dwell timequantity with unit units s, min, h; default {"unit": "min"}How long a topical preparation was left in contact before the next step: the wait after applying, not how long the delivery took.
blockEffectivenessBlock effectivenesschoice one of no_response_at_incision, reduced_response, full_response, not_assessedThe operator’s judgement of whether the block worked, from the response seen at the first incision.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "placementTechnique": "infiltration",
    "volume": {
        "value": 1,
        "unit": "mL"
    },
    "site": "text"
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ActiveAgent (Active agent)yes PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyesApplied dose or concentration
PharmacologicalAdjuvant (Pharmacological adjunct)  PharmacologicalAgentPharmacologicalAgentyes 
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Sedative

  • type code Sedative · version 2.0.1 · schema

A sedative or anxiolytic given for non-surgical restraint, imaging, or transport, as distinct from full anesthesia. Record the level the animal actually reached, which may be deeper than the level intended.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeVolume administeredquantity with unit units mL, µL, L; default {"unit": "mL"}Total volume of solution that entered the animal in this event, vehicle included.
rateInfusion ratequantity with unit units mL/h, µL/h; default {"unit": "mL/h"}Rate the sedative infusion ran at; the delivery profile says whether there was one.
routeAdministration routechoiceyesone of sc, ip, im, iv, inhaled, oral, otherRoute of sedative administration.
injectionProfileDelivery profilechoice one of bolus_injection, slow_injection, continuous_infusionShape the delivery took over time, which an empty rate cannot state.
sedationLevelSedation levelchoice one of light_sedation, moderate_sedation, deep_sedation, surgical_plane, otherThe level the animal actually reached; deep sedation is not surgical plane.
durationSedation durationquantity with unit units h, min, s; default {"unit": "min"}Time from administration of the agent to the end of the sedation.
recoveryTimeRecovery timequantity with unit units h, min, s; default {"unit": "min"}Time from the end of the sedation until the animal rights itself and moves normally.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.
monitoringMonitoringtable of rows format tableWhat was followed while the animal was sedated, how, and how often. One row per parameter; an empty table means nothing was monitored.
monitoring[].parameterParameterchoiceyesone of anesthetic_depth, blood_pressure, heart_rate, oxygen_saturation, respiratory_rate, temperature, otherWhat this row followed — the parameter itself, never the instrument that read it. Anesthetic depth covers the sedation level.
monitoring[].methodAssessment methodmulti-select one of pedal_withdrawal_reflex, palpebral_reflex, corneal_reflex, tail_pinch_reflex, visual_observation, pulse_oximetry, ecg, eeg, capnography, rectal_probe, other; format select2How this parameter was assessed; select every check or instrument used.
monitoring[].intervalIntervalquantity with unit units h, min, s; default {"unit": "min"}How often this parameter was checked. Leave empty for continuous monitoring.
supportiveCareSupportive caretable of rows format tableCare given alongside the sedation. One row per measure; an empty table means none was given.
supportiveCare[].measureMeasurechoiceyesone of eye_lubricant, fluid_therapy, heating_pad, oxygen_supplementation, otherWhich supportive measure was given while the animal was sedated.

Illustrative payload:

{
    "route": "sc",
    "volume": {
        "value": 1,
        "unit": "mL"
    },
    "rate": {
        "value": 1,
        "unit": "mL/h"
    }
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ActiveAgent (Active agent)yes PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyesApplied dose or concentration
PharmacologicalAdjuvant (Pharmacological adjunct)  PharmacologicalAgentPharmacologicalAgentyes 
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
CarrierGas (Carrier gas)  MedicalGasMedicalGasyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Stages:

  • induction (Induction), no detail schema; repeatable
  • maintenance (Maintenance), no detail schema; repeatable

Surgical Procedures

Baseplating

  • type code Baseplating · version 1.0.0 · schema

Documents fixing a baseplate to the skull or headcap to dock a head-mounted miniature microscope, typically over a previously implanted GRIN lens or prism.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
Baseplate (Baseplate)yes ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
ShieldingMaterial (Light-shielding material)  ImplantMaterial, ConsumableDeviceImplantMaterial, ConsumableDeviceyes 
OtherComponent (Other baseplate component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Burr hole

  • type code BurrHole · version 2.1.0 · schema

A small hole drilled in the skull to provide access for electrode placement, cannula insertion, injection, or another targeted action while otherwise maintaining skull integrity.

PropertyTitleShapeRequiredAllowed valuesMeaning
diameterHole diameterquantity with unit units mm, µm, cm, m; default {"unit": "mm"}Diameter of the burr hole.
drillSpeedDrill speedquantity with unit units RPM, Hz; default {"unit": "RPM"}Speed of the drill.
purposePurposetext  Primary purpose of creating the burr hole.
coolingMethodCooling methodchoice one of saline_irrigation, air_cooling, none, otherMethod used to prevent overheating during drilling.
duraHandlingDura handlingchoice one of left_intact, punctured, incised, excisedHow the dura was left by this opening; an incidental nick counts as punctured.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "diameter": {
        "value": 1,
        "unit": "mm"
    },
    "drillSpeed": {
        "value": 1,
        "unit": "RPM"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
IrrigationSolution (Irrigation solution)  PhysiologicalSolutionPhysiologicalSolutionyes 
HemostaticAgent (Hemostatic agent)  PharmacologicalAgent, SurgicalDisposablePharmacologicalAgent, SurgicalDisposableyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Cranial window

  • type code CranialWindow · version 1.2.1 · schema

A section of skull opened and fitted with a transparent window for direct, often long-term optical access to the brain surface.

PropertyTitleShapeRequiredAllowed valuesMeaning
surgicalMethodSurgical methodtext  Describe the surgical technique used to create the cranial window. Common methods include the use of a surgical drill, bone saw, automatic or manual cutting tools to remove a section of the skull.
shapeShape of cranial windowtext  Describe the shape of the cranial window performed, such as square, circular, elliptical, or other specific form. This helps in understanding the surgical approach and potential impact on the underlying brain tissue.
dimensionsDimensions of cranial windowtext  Dimensions of the window: length, width, diameter or thickness. E.g., ‘1.0 mm diameter × 4 mm length’.
orientationOrientation of cranial windowtext  Describe the orientation of the cranial window relative to anatomical landmarks. This can include angle and direction, which are important for precise targeting and minimizing damage to critical areas.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "surgicalMethod": "text",
    "shape": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
CranialWindow (Cranial window)yes ConsumableDevice, ImplantMaterial, OpticalComponentConsumableDevice, ImplantMaterial, OpticalComponentyes 
IrrigationSolution (Irrigation solution)  PhysiologicalSolutionPhysiologicalSolutionyes 
HemostaticAgent (Hemostatic agent)  PharmacologicalAgent, SurgicalDisposablePharmacologicalAgent, SurgicalDisposableyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Craniectomy

  • type code Craniectomy · version 2.0.1 · schema

Removal of a portion of the skull that is left open: the bone is not replaced and the opening is not sealed again. Use Craniotomy when the opening is closed afterwards.

PropertyTitleShapeRequiredAllowed valuesMeaning
surgicalMethodSurgical methodtext  Describe the surgical technique used for the craniectomy. Common methods include the use of a surgical drill, bone saw, automatic or manual cutting tools to remove a section of the skull.
shapeShape of craniectomytext  Describe the shape of the craniectomy, such as square, circular, oval, or irregular.
dimensionsDimensions of craniectomytext  Dimensions of the craniectomy: length, width, or diameter. E.g., ‘1.0 mm diameter × 4 mm length’.
orientationOrientation of craniectomytext  Indicate the orientation of the craniectomy relative to major anatomical landmarks.
duraHandlingDura handlingchoice one of left_intact, punctured, incised, excisedHow the dura was left by this opening; an incidental nick counts as punctured.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "surgicalMethod": "text",
    "shape": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
IrrigationSolution (Irrigation solution)  PhysiologicalSolutionPhysiologicalSolutionyes 
HemostaticAgent (Hemostatic agent)  PharmacologicalAgent, SurgicalDisposablePharmacologicalAgent, SurgicalDisposableyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Craniotomy

  • type code Craniotomy · version 2.0.1 · schema

Opening of the skull to expose the brain, after which the opening is sealed again, by replacing the bone flap or covering it with a window, cement or another seal. Use Craniectomy when the bone is removed and the opening left open.

PropertyTitleShapeRequiredAllowed valuesMeaning
surgicalMethodSurgical methodtext  Describe the surgical technique used for the craniotomy. Common methods include the use of a surgical drill, bone saw, automatic or manual cutting tools to remove a section of the skull.
shapeShape of craniotomytext  Shape of the craniotomy, such as square, circular, or elliptical.
dimensionsDimensions of craniotomytext  Dimensions of the craniotomy: length, width, or diameter. E.g., ‘1.0 mm diameter × 4 mm length’.
orientationOrientation of craniotomytext  Describe the orientation of the craniotomy relative to anatomical landmarks. This can include angle and direction, which are important for precise targeting and minimizing damage to critical areas.
duraHandlingDura handlingchoice one of left_intact, punctured, incised, excisedHow the dura was left by this opening; an incidental nick counts as punctured.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "surgicalMethod": "text",
    "shape": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
IrrigationSolution (Irrigation solution)  PhysiologicalSolutionPhysiologicalSolutionyes 
HemostaticAgent (Hemostatic agent)  PharmacologicalAgent, SurgicalDisposablePharmacologicalAgent, SurgicalDisposableyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Head fixation

  • type code HeadFixation · version 2.0.3 · schema

Immobilization of the subject’s head for stable recordings, manipulations, or imaging. Use Headpost for the separate action of attaching the device used for fixation.

PropertyTitleShapeRequiredAllowed valuesMeaning
fixationMethodFixation methodsmulti-select one of ear_bars, nose_clamp, tooth_bar, headpost_clamp, custom_holder, other; format select2Methods used to the fixate head, typically using a stereotaxic frame or custom apparatus.
alignmentAlignmenttext  The alignment achieved in the fixation procedure (e.g. bregma and lambda aligned; slight ML tilt to the left)
fixationDetailsFixation detailstext  Further details on the fixation method used, including materials (e.g. ‘steel ear bars and ML adjustment screws - firm fit, no movement’)

Illustrative payload:

{
    "fixationMethod": [
        "ear_bars"
    ],
    "alignment": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
Headpost (Headpost)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Headcap

  • type code Headcap · version 4.0.1 · schema

Attachment of a protective covering over cranial implants while retaining any required experimental access points.

PropertyTitleShapeRequiredAllowed valuesMeaning
materialMaterialtext hidden legacy fieldMaterial used to build the headcap, e.g., dental cement, acrylic, epoxy, UV-cured resin, titanium, stainless steel, or plastic.
shapeShapetext hidden legacy fieldGeometrical shape or design (e.g. hexagonal, square, oval, cylinder).
constructionMethodConstruction Methodchoice one of manually_built, custom_built, 3d_printed, milled, molded, otherHow the headcap was constructed.
fixationMethodAttachment Methodchoice one of dental_cement, uv_cured_resin, super_glue, epoxy, screws, otherMethod used to affix the headcap to the skull.
shieldingFaraday Shieldingchoice one of none, conductive_paint, copper_mesh, aluminum_foil, custom, unknown; hidden legacy fieldWhether and how the headcap was shielded to reduce electrical noise.
skullPreparationSkull preparationmulti-select one of cleaned, periosteum_removed, roughened, dried, etched, primed, none; format select2How the skull was prepared before attachment; select every step that was carried out.
deviceIdentifierDevice identifiertext  The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "material": "text",
    "shape": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
HeadcapAssembly (Headcap assembly)yes ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
ShieldingMaterial (Shielding material)  ImplantMaterial, ConsumableDeviceImplantMaterial, ConsumableDeviceyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other headcap material)    yes 

Headpost

  • type code Headpost · version 4.0.1 · schema

Attachment of a device to the skull that enables later head fixation, including during experiments with awake subjects.

PropertyTitleShapeRequiredAllowed valuesMeaning
materialMaterialtext  Material of the headpost, e.g., titanium, stainless steel, or plastic.
shapeShapetext  Geometrical shape or design (e.g., flat bar, U-frame, circular post).
constructionMethodConstruction methodchoice one of manually_built, custom_built, 3d_printed, milled, otherHow the headpost was constructed prior to implantation.
fixationMethodAttachment methodchoice one of dental_cement, super_glue, epoxy, screws, otherMethod used to affix the headpost to the skull.
skullPreparationSkull preparationmulti-select one of cleaned, periosteum_removed, roughened, dried, etched, primed, none; format select2How the skull was prepared before attachment; select every step that was carried out.
deviceIdentifierDevice identifiertext  The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "material": "text",
    "shape": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
Headpost (Headpost)yes ImplantMaterial, ConsumableDeviceImplantMaterial, ConsumableDeviceyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Implant Procedures

Blood pressure sensor implant

  • type code BloodPressureSensorImplant · version 4.0.0 · schema

Surgical placement of a sensor intended to monitor blood pressure continuously or repeatedly.

PropertyTitleShapeRequiredAllowed valuesMeaning
sensorTypeSensor typechoiceyesone of telemetric, catheter_based, fluid_filled, fiber_optic, otherType of blood pressure sensor used.
implantSiteImplant sitetext  Vascular or body location where the pressure sensor was implanted — e.g., ‘Femoral artery’,’Carotid artery’,’Aorta’,’Ventral tail artery’,’Left ventricle’.
catheterMaterialCatheter materialtext  Material used for the catheter or tubing connecting the pressure sensor to vasculature.
fixationMethodAnchoring methodchoiceyesone of sutured, subcutaneous_tunnel, tissue_glue, headcap, cemented_to_skull, otherHow the sensor or catheter were secured in place to prevent movement.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneSterilization technique used before implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "sensorType": "telemetric",
    "fixationMethod": "sutured",
    "implantSite": "text",
    "catheterMaterial": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
BloodPressureSensor (Blood-pressure sensor)yes ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Breathing sensor implant

  • type code BreathingSensorImplant · version 5.0.0 · schema

Placement of a sensor used to monitor respiratory patterns or rate.

PropertyTitleShapeRequiredAllowed valuesMeaning
sensorTypeSensor typechoiceyesone of piezoelectric, chest_wall_emg, intranasal_thermocouple, intranasal_pressure, tracheal_airflow, thoracic_pressure, plethysmography_cannula, otherType of breathing sensor used.
implantSiteImplant sitetext  Anatomical location where the breathing sensor was implanted or attached — e.g., ‘Chest wall’, ‘Diaphragm’, ‘Nasal cavity’, ‘Trachea’, ‘Pleural cavity’, ‘Subcutaneous (telemetry)’, ‘Other’.
wireMaterialWire or lead materialtext  Material used for connecting wires or leads (e.g., stainless steel, silver, silver chloride, platinum, tungsten).
fixationMethodAnchoring methodchoiceyesone of sutured, tissue_glue, subcutaneous_tunnel, cemented_to_skull, headcap, custom_mount, otherHow the sensor or wires were fixed in place during implantation.
signalTransmissionSignal transmissionchoice one of tethered, wireless, telemetric, inductive, optical, otherMode of signal transmission from the sensor to the acquisition device.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneSterilization technique applied before implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "sensorType": "piezoelectric",
    "fixationMethod": "sutured",
    "implantSite": "text",
    "wireMaterial": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
RespiratorySensor (Respiratory sensor)yes ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Cannula implant

  • type code CannulaImplant · version 1.1.0 · schema

Implantation of a guide or infusion cannula for targeted delivery, sampling, microdialysis, or cerebrospinal-fluid access.

PropertyTitleShapeRequiredAllowed valuesMeaning
targetSiteTarget sitechoiceyesone of lateral_ventricle, third_ventricle, cisterna_magna, intrathecal_spinal_cord, otherCSF or ventricular compartment targeted by the cannula. For a parenchymal target, use the structured brain region field.
cannulaTypeCannula typechoice one of guide_cannula, infusion_cannula, icv_cannula, osmotic_pump_cannula, microdialysis_guide, otherFunctional type of cannula implanted.
cannulaGaugeCannula gaugeinteger ≥ 0Gauge of the cannula, if applicable.
cannulaLengthCannula lengthquantity with unit units mm, cm, µm; default {"unit": "mm"}Length of the implanted cannula.
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
lateralityLateralitychoice one of left, right, bilateral, midline, unknownSide of the brain or body targeted by the cannula.
implantPurposeImplant purposechoice one of drug_delivery, infusion, sampling, microdialysis, cerebrospinal_fluid_access, otherPrimary purpose of the implanted cannula.
fixationMethodFixation methodchoice one of dental_cement, screws_and_cement, adhesive, suture, otherHow the cannula was secured.
obturatorUsedObturator usedyes/no  Whether an obturator or dummy cannula was inserted after implantation.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneSterilization technique used prior to implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "targetSite": "lateral_ventricle",
    "cannulaType": "guide_cannula",
    "cannulaGauge": 1
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
Cannula (Cannula)yes ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
Obturator (Obturator)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Catheter implant

  • type code CatheterImplant · version 4.0.0 · schema

Insertion of a flexible tube into a vessel or body cavity for delivery, sampling, drainage, or pressure monitoring.

PropertyTitleShapeRequiredAllowed valuesMeaning
targetSiteTarget sitechoiceyesone of jugular_vein, femoral_vein, carotid_artery, lateral_ventricle, third_ventricle, intrathecal_spinal_cord, cisterna_magna, peritoneal_cavity, otherAnatomical target of the catheter.
catheterTypeCatheter typetext  Model or description of the catheter (e.g., PE-10, Silastic).
materialMaterialtext  Material of the catheter tubing.
purposePurposechoice one of infusion, sampling, pressure_monitoring, drug_delivery, otherPrimary purpose of the catheter implant.
fixationMethodFixation methodchoice one of sutures, dental_cement, epoxy, tissue_glue, subcutaneous_tunnel, otherHow the catheter was secured to the body or skull.
externalPortExternal portchoice one of head_mounted, back_mounted, tail_mounted, subcutaneous, noneWhere the external port or connector was positioned.
deviceIdentifierDevice identifiertext  The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "targetSite": "jugular_vein",
    "catheterType": "text",
    "material": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
Catheter (Catheter)yes ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

ECG implant (Electrocardiography)

  • type code EcgImplant · version 4.0.0 · schema

Placement of electrodes used to record the electrical activity of the heart.

PropertyTitleShapeRequiredAllowed valuesMeaning
wireCountWire countinteger ≥ 1Number of ECG wires implanted.
wireMaterialWire materialtext  Material used for ECG wire leads.
wireInsulationWire insulation typechoice one of teflon, polyimide, silicone, none, otherInsulation material covering the wire shaft, excluding the exposed recording tip.
implantSiteImplant sitetext  Where the ECG electrodes were implanted — e.g., ‘chest wall’, ‘right shoulder’, ‘left hindlimb’, or ‘subcutaneous over heart’.
fixationMethodAnchoring methodchoiceyesone of sutured, subcutaneous_tunnel, tissue_glue, headcap, cemented_to_skull, otherHow the ECG wires were fixed in place to prevent movement.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneSterilization technique used for ECG components.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "fixationMethod": "sutured",
    "wireCount": 1,
    "wireMaterial": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ElectrodeAssembly (ECG electrode assembly)yes ElectrodeComponent, SingleWireElectrode, ConsumableDeviceElectrodeComponent, SingleWireElectrode, ConsumableDeviceyes 
GroundElectrode (Ground electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

ECoG implant (Electrocorticography)

  • type code EcogImplant · version 1.0.1 · schema

Placement of a flexible grid or strip array of contacts on the brain surface, above or beneath the dura, or on thinned skull, to record without penetrating the tissue. The array itself is recorded as the required ECoG array material row, sourced from your ECoG array stock or catalog.

PropertyTitleShapeRequiredAllowed valuesMeaning
placementLayerPlacement layerchoice one of epidural, subdural, epicranialWhich tissue layer the array was laid on: the dura, the brain surface after opening the dura, or the bone.
duraHandlingDura handlingchoice one of left_intact, punctured, incised, excisedHow the dura was handled at the opening before the array was laid down; a strip slid under the bone edge over intact dura counts as left intact.
skullPreparationSkull preparationmulti-select one of cleaned, periosteum_removed, roughened, dried, etched, primed, none; format select2How the skull was prepared before attachment; select every step that was carried out.
arrayAdhesionArray adhesionchoice one of none, tissue_adhesive, cement_at_margin, sutured_to_dura, otherHow the array itself was held on the surface; how the connector was anchored goes under fixation method.
groundPlacementGround placementchoice one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, none, otherWhere the ground screw or wire was placed on the animal in this surgery.
referencePlacementReference placementchoice one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, on_array, none, otherWhere the reference was placed in this surgery; on the array means a dedicated contact of the array itself.
groundReferenceTiedGround and reference tiedyes/no  Check this if the ground and the reference were joined together on the animal.
fixationMethodFixation methodmulti-select one of dental_cement, acrylic, uv_cured_resin, super_glue, epoxy, screws, headcap, custom_holder, none, other; format select2How the skull-borne assembly (connector and ribbon root) was held to the skull; select every method that contributed.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "placementLayer": "epidural",
    "duraHandling": "left_intact"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
EcogArray (ECoG array)yes EcogArrayEcogArrayDesignyes 
ReferenceElectrode (Reference electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
GroundElectrode (Ground electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
ShieldingMaterial (Shielding material)  ImplantMaterial, ConsumableDeviceImplantMaterial, ConsumableDeviceyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

EEG implant (Electroencephalography)

  • type code EegImplant · version 4.0.0 · schema

Placement of electrodes on or beneath the skull to record large-scale brain electrical activity.

PropertyTitleShapeRequiredAllowed valuesMeaning
wireCountWire countintegeryes≥ 1; default 1Number of electrodes used for EEG recording.
electrodeTypeElectrode typechoiceyesone of skull_screw, flat_wire, disc, custom, otherForm factor of the EEG electrode, e.g., skull screws or flat metal contacts.
electrodeMaterialElectrode materialtextyes Material used in the electrode. Common choices include stainless steel and Ag/AgCl.
fixationMethodAnchoring methodchoiceyesone of dental_cement, screws, acrylic, uv_cured_resin, headcap, otherHow the EEG electrodes were secured in place.
shieldingFaraday shieldingchoice one of none, copper_mesh, conductive_paint, aluminum_foil, headcap_integrated, otherWhether and how the EEG implant was shielded from external noise.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneHow the EEG components were sterilized before implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "wireCount": 1,
    "electrodeType": "skull_screw",
    "electrodeMaterial": "text",
    "fixationMethod": "dental_cement",
    "shielding": "none",
    "sterilizationMethod": "autoclave"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ElectrodeAssembly (EEG electrode assembly)yes ElectrodeComponent, SingleWireElectrode, ConsumableDeviceElectrodeComponent, SingleWireElectrode, ConsumableDeviceyes 
ReferenceElectrode (Reference electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
GroundElectrode (Ground electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
ShieldingMaterial (Shielding material)  ImplantMaterial, ConsumableDeviceImplantMaterial, ConsumableDeviceyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

EMG implant (Electromyography)

  • type code EmgImplant · version 3.1.0 · schema

Placement of electrodes in or on muscles to record muscle electrical activity.

PropertyTitleShapeRequiredAllowed valuesMeaning
wireCountWire countintegeryes≥ 1; default 1Number of implanted EMG wires (typically one or two per muscle).
wireMaterialWire materialtext  Material used for the EMG wires. Stainless steel is common in rodents.
wireInsulationWire insulation typechoice one of teflon, polyimide, silicone, none, otherType of insulation around the wire shaft, except at exposed recording tip.
muscleTargetsTarget musclestext  List of muscles where EMG wires were implanted (e.g., neck, diaphragm, masseter, forelimb biceps).
implantMethodImplant methodchoiceyesone of direct_insertion, needle_guided, subcutaneous_tunnel, sutured, otherHow the wire was placed into the muscle.
fixationMethodAnchoring methodchoice one of sutured_to_muscle, cemented_to_skull, subcutaneous_tunnel, tissue_glue, headcap, otherHow the wires were fixed to prevent displacement during recovery or recording.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneSterilization technique applied before implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "wireCount": 1,
    "implantMethod": "direct_insertion",
    "wireMaterial": "text",
    "wireInsulation": "teflon"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ElectrodeAssembly (EMG electrode assembly)yes ElectrodeComponent, SingleWireElectrode, ConsumableDeviceElectrodeComponent, SingleWireElectrode, ConsumableDeviceyes 
ReferenceElectrode (Reference electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
GroundElectrode (Ground electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Generic implant

  • type code GenericImplant · version 2.1.0 · schema

Use this only when an implantation action does not fit any specific implant type above. Describe the implanted item and purpose clearly in the structured details and notes.

PropertyTitleShapeRequiredAllowed valuesMeaning
implantTypeImplant typechoiceyesone of sensor, electrode, optical_device, mechanical_device, fluidic_device, structural_support, otherGeneral category or function of the implant. This helps classify the implant for downstream filtering and interpretation.
implantNameImplant name or descriptiontext  A short name or description of the implant (e.g., ‘custom probe’, ‘prototype sensor’, ‘flex circuit’).
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
fixationMethodAnchoring methodchoice one of sutured, tissue_glue, subcutaneous_tunnel, dental_cement, headcap, custom_mount, none, otherHow the implant was secured in place.
signalTransmissionSignal transmissionchoice one of tethered, wireless, telemetric, optical, none, otherHow the implant communicates data (if applicable).
powerSourcePower sourcechoice one of battery, inductive, wired, passive, none, otherHow the implant is powered, if relevant.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneSterilization technique used prior to implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "implantType": "sensor",
    "implantName": "text",
    "insertionRate": {
        "value": 1,
        "unit": "µm/s"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
GenericDevice (Other implanted device)yes ConsumableDevice, EcogArray, ElectrodeComponent, ImplantMaterial, OpticFiber, OpticalComponent, SiliconProbe, SingleWireElectrodeConsumableDevice, EcogArrayDesign, ElectrodeComponent, ImplantMaterial, OpticFiberDesign, OpticalComponent, SiliconProbeDesign, SingleWireElectrodeyes 
FixedPositioningAssembly (Fixed implant carrier or shuttle)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ManualMicrodrive (Manual microdrive)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
MotorizedMicrodrive (Motorized microdrive)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ReferenceElectrode (Reference electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
GroundElectrode (Ground electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
Obturator (Obturator)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ShieldingMaterial (Shielding material)  ImplantMaterial, ConsumableDeviceImplantMaterial, ConsumableDeviceyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

GRIN (Gradient Index) lens implant

  • type code GrinLensImplant · version 2.1.0 · schema

Implantation of a gradient-index lens to provide optical access to deep tissue for imaging.

PropertyTitleShapeRequiredAllowed valuesMeaning
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
fixationMethodMounting methodchoice one of cement_only, cement_baseplate, headcap_integrated, custom_holder, otherHow the GRIN lens was secured in place after implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "insertionRate": {
        "value": 1,
        "unit": "µm/s"
    },
    "fixationMethod": "cement_only"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
GrinLens (GRIN lens)yes OpticalComponent, ConsumableDeviceOpticalComponent, ConsumableDeviceyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Nerve cuff implant

  • type code NerveCuffImplant · version 5.0.0 · schema

Placement of a cuff electrode around a peripheral nerve for recording or stimulation.

PropertyTitleShapeRequiredAllowed valuesMeaning
cuffTypeCuff typechoiceyesone of monopolar, bipolar, tripolar, multi_contact, split_ring, spiral, otherConfiguration and geometry of the cuff. Common types include bipolar and tripolar configurations.
targetNerveTarget nervetext  Name or anatomical label of the nerve the cuff was implanted on (e.g., ‘sciatic’, ‘vagus’, ‘median’, ‘hypoglossal’).
cuffMaterialCuff materialtext  Base material used for the body of the nerve cuff (e.g., silicone tubing or flexible polymer).
electrodeMaterialElectrode materialtext  Material of the embedded electrode contacts inside the nerve cuff.
fixationMethodAnchoring methodchoiceyesone of suture_surrounding_tissue, tissue_glue, self_closing_cuff, loose_fit, subcutaneous_tunnel, otherHow the cuff was fixed around or near the nerve to prevent displacement.
wireExitRouteWire exit routechoice one of subcutaneous_tunnel_headcap, abdominal_connector, dorsal_skin_exit, wireless_inductive, otherHow the lead wires exited the body or were routed for connection to recording/stimulation equipment.
signalTransmissionSignal transmissionchoice one of tethered, wireless, telemetric, optical, none, otherHow the signal was transmitted to external devices (e.g., via headstage cable, telemetry).
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneSterilization technique used prior to implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "cuffType": "monopolar",
    "fixationMethod": "suture_surrounding_tissue",
    "targetNerve": "text",
    "cuffMaterial": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
NerveCuff (Nerve cuff)yes ConsumableDevice, ImplantMaterial, ElectrodeComponentConsumableDevice, ImplantMaterial, ElectrodeComponentyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
ReferenceElectrode (Reference electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
GroundElectrode (Ground electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Optic fiber implant

  • type code OpticFiberImplant · version 2.2.1 · schema

Placement of an optical fiber for delivering or collecting light, such as in optogenetic stimulation or fiber photometry.

PropertyTitleShapeRequiredAllowed valuesMeaning
duraHandlingDura handlingchoice one of left_intact, punctured, incised, excisedHow the dura was handled at the entry site; a device driven through intact dura counts as punctured.
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
skullPreparationSkull preparationmulti-select one of cleaned, periosteum_removed, roughened, dried, etched, primed, none; format select2How the skull was prepared before attachment; select every step that was carried out.
fixationMethodFixation methodmulti-select one of dental_cement, acrylic, uv_cured_resin, super_glue, epoxy, screws, headcap, custom_holder, none, other; format select2How the finished assembly was held to the skull; select every method that contributed.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "duraHandling": "left_intact",
    "insertionRate": {
        "value": 1,
        "unit": "µm/s"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
OpticFiber (Implanted optic fiber)yes OpticFiberOpticFiberDesignyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterial, OpticalComponentConsumableDevice, ImplantMaterial, OpticalComponentyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other optic-fiber material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Prism implant

  • type code PrismImplant · version 3.0.0 · schema

Placement of a prism that redirects the optical path to make a difficult-to-access tissue plane visible.

PropertyTitleShapeRequiredAllowed valuesMeaning
deviceIdentifierDevice identifiertext  The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, alcohol, noneMethod used to sterilize the prism before implantation.
fixationMethodMounting methodchoice one of cement_only, cement_baseplate, headcap_integrated, custom_holder, otherHow the prism was secured in place after implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "insertionRate": {
        "value": 1,
        "unit": "µm/s"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
Prism (Prism)yes OpticalComponent, ConsumableDeviceOpticalComponent, ConsumableDeviceyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Reference electrode implant

  • type code ReferenceElectrodeImplant · version 2.1.0 · schema

Placement of an electrode that supplies a reference signal for other recording electrodes.

PropertyTitleShapeRequiredAllowed valuesMeaning
electrodeCountElectrode countintegeryes≥ 1; default 1Number of electrodes in the reference electrode assembly. Typically 1, but multiple electrodes may be used for redundancy or averaging.
electrodeMaterialElectrode materialtextyesdefault "stainless steel"Material of the electrode.
impedanceImpedancequantity with unit units kΩ, Ω, MΩ; default {"unit": "kΩ"}Approximate impedance of the reference electrode at 1 kHz. Lower is typically preferred for stable referencing.
electrodeDiameterElectrode diameterquantity with unit units µm, mm, nm, m; default {"unit": "µm"}Diameter of electrode. Affects flexibility, durability, and impedance.
placementSitePlacement sitetext  Where the reference electrode was implanted or placed (e.g., cerebellum, skull surface, contralateral cortex, subcutaneous).
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
fixationMethodAnchoring methodchoice one of dental_cement, tissue_glue, bone_screw, subcutaneous_tunnel, otherHow the reference electrode was secured in place.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "electrodeCount": 1,
    "electrodeMaterial": "text",
    "impedance": {
        "value": 1,
        "unit": "kΩ"
    },
    "electrodeDiameter": {
        "value": 1,
        "unit": "µm"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ElectrodeAssembly (Electrode assembly)  ElectrodeComponent, SingleWireElectrode, ConsumableDeviceElectrodeComponent, SingleWireElectrode, ConsumableDeviceyes 
ReferenceElectrode (Reference electrode)yes ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Silicon probe implant

  • type code SiliconProbeImplant · version 2.2.1 · schema

Insertion of a silicon probe with one or more recording sites, chronic or acute. The probe itself is recorded as the required Silicon probe material row, sourced from your probe stock or catalog.

PropertyTitleShapeRequiredAllowed valuesMeaning
duraHandlingDura handlingchoice one of left_intact, punctured, incised, excisedHow the dura was handled at the entry site; a device driven through intact dura counts as punctured.
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
groundPlacementGround placementchoice one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, none, otherWhere the ground screw or wire was placed on the animal in this surgery.
referencePlacementReference placementchoice one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, none, otherWhere the reference screw or wire was placed on the animal in this surgery.
groundReferenceTiedGround and reference tiedyes/no  Check this if the ground and the reference were joined together on the animal.
fixationMethodFixation methodmulti-select one of dental_cement, acrylic, uv_cured_resin, super_glue, epoxy, screws, headcap, custom_holder, none, other; format select2How the finished assembly was held to the skull; select every method that contributed.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "duraHandling": "left_intact",
    "insertionRate": {
        "value": 1,
        "unit": "µm/s"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
SiliconProbe (Silicon probe)yes SiliconProbeSiliconProbeDesignyes 
FixedPositioningAssembly (Fixed probe carrier or shuttle)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ManualMicrodrive (Manual probe microdrive)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
MotorizedMicrodrive (Motorized probe microdrive)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterial, SingleWireElectrodeConsumableDevice, ImplantMaterial, SingleWireElectrodeyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Single wire electrode implant

  • type code SingleWireElectrodeImplant · version 2.1.0 · schema

Implantation of a single wire electrode for neural recording or stimulation.

PropertyTitleShapeRequiredAllowed valuesMeaning
wireCountWire countintegeryes≥ 0; default 1Number of wires used in the electrode assembly.
wireDiameterWire Diameterquantity with unit units µm, mm, nm, m; default {"unit": "µm"}The diameter of the electrode wire. Wire diameter affects the electrode’s impedance and recording or stimulation capabilities.
wireMaterialWire materialtext  Common materials include stainless steel, platinum-iridium, and gold. Material choice affects biocompatibility, conductivity, and overall performance of the electrode.
impedanceImpedancequantity with unit units Ω, kΩ, MΩ; default {"unit": "kΩ"}The electrical impedance of the electrode, critical for matching with recording equipment and optimizing signal-to-noise ratio.
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, alcohol, noneSterilization technique used prior to implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "wireCount": 1,
    "wireDiameter": {
        "value": 1,
        "unit": "µm"
    },
    "wireMaterial": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
SingleWireElectrode (Single-wire electrode)yes SingleWireElectrode, ConsumableDeviceSingleWireElectrode, ConsumableDeviceyes 
FixedPositioningAssembly (Fixed electrode carrier or shuttle)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ManualMicrodrive (Manual electrode microdrive)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
MotorizedMicrodrive (Motorized electrode microdrive)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Temperature sensor implant

  • type code TemperatureSensorImplant · version 5.0.0 · schema

Placement of a sensor used to monitor body or tissue temperature.

PropertyTitleShapeRequiredAllowed valuesMeaning
sensorTypeSensor typechoiceyesone of thermocouple, thermistor, digital_ic, telemetric, passive_logger, fiber_optic, otherType of temperature sensor implanted. Examples include thermocouples, telemetry sensors, or passive loggers.
wireMaterialWire or lead materialtext  Material of the sensor leads, if applicable. Thermocouples often use copper or constantan.
fixationMethodAnchoring methodchoiceyesone of sutured, tissue_glue, subcutaneous_tunnel, cemented_to_skull, headcap, free_floating, otherHow the sensor or wires were secured at the implantation site.
signalTransmissionSignal transmissionchoice one of tethered, wireless, telemetric, optical, retrieved_logger, none, otherHow temperature data is retrieved. ‘Logger (retrieved)’ refers to onboard storage until post hoc download.
powerSourcePower sourcechoice one of battery, inductive, wired, passive, none, otherHow the temperature sensor is powered, if applicable.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, noneSterilization technique used before implantation.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "sensorType": "thermocouple",
    "fixationMethod": "sutured",
    "wireMaterial": "text",
    "signalTransmission": "tethered"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
TemperatureSensor (Temperature probe or sensor)yes ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Tetrode wire electrode implant

  • type code TetrodeWireElectrodeImplant · version 3.0.1 · schema

Implantation of a four-wire electrode bundle used to distinguish activity from nearby neurons.

PropertyTitleShapeRequiredAllowed valuesMeaning
tetrodeCountTetrode countintegeryes≥ 1Number of tetrodes loaded on the drive at implant, as built.
nWiresTetrodeWires per tetrodeinteger ≥ 1Wires twisted into each tetrode as built: 4 for a tetrode, 2 for a stereotrode.
duraHandlingDura handlingchoice one of left_intact, punctured, incised, excisedHow the dura was handled at the entry site; a bundle driven through intact dura counts as punctured.
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
groundPlacementGround placementchoice one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, none, otherWhere the ground screw or wire was placed on the animal in this surgery.
referencePlacementReference placementchoice one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, in_bundle, none, otherWhere the reference was placed: a skull screw or wire, or a reference tetrode within the bundle.
groundReferenceTiedGround and reference tiedyes/no  Check this if the ground and the reference were joined together on the animal.
fixationMethodFixation methodmulti-select one of dental_cement, acrylic, uv_cured_resin, super_glue, epoxy, screws, headcap, custom_holder, none, other; format select2How the drive was held to the skull; select every method that contributed.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "tetrodeCount": 1,
    "nWiresTetrode": 1,
    "duraHandling": "left_intact"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ElectrodeAssembly (Tetrode assembly)yes SingleWireElectrode, ElectrodeComponent, ConsumableDeviceSingleWireElectrode, ElectrodeComponent, ConsumableDeviceyes 
FixedPositioningAssembly (Fixed electrode carrier or shuttle)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ManualMicrodrive (Manual electrode microdrive)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
MotorizedMicrodrive (Motorized electrode microdrive)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
ReferenceElectrode (Reference electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
GroundElectrode (Ground electrode)  ElectrodeComponent, SingleWireElectrodeElectrodeComponent, SingleWireElectrodeyes 
ConnectorComponent (Connector component)  ConnectorComponentConnectorComponentyes 
OtherComponent (Other implant component)  ConsumableDevice, ImplantMaterialConsumableDevice, ImplantMaterialyes 
AdhesiveSealant (Adhesive, cement, or sealant)  AdhesiveCementAdhesiveCementyes 
Fastener (Anchor screw, pin, or fastener)  FastenerAnchorFastenerAnchoryes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 
Coating (Coating)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 

Injection and Infusion Procedures

Injection

  • type code Injection · version 3.1.0 · schema

Delivery of a solution to a defined anatomical site. Use this for pharmacological agents, tracers, cells, or other injected materials that are not viral vectors.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeInjection Volumequantity with unit units L, mL, µL, nL, pL; default {"unit": "mL"}The total volume of the solution injected.
rateInjection ratequantity with unit units mL/s, µL/s, mL/min, µL/min; default {"unit": "mL/s"}Rate at which the solution is injected.
concentrationConcentration of solutionquantity with unit units mg/mL, µg/mL, g/L, mg/L, µg/L, % w/v, % v/v, % w/w; default {"unit": "mg/mL"}Concentration of the injected solution.
injectionMethodInjection Methodchoice one of icv, im, iv, id, sc, ic, ip, it, epidural, retro_orbital, intranasal, intra_articular, intravitreal, intralesionalDefines the injection method.
injectionProfileInjection profilechoice one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titrationDescribes the injection profile.
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
lateralityInjection side (brain hemisphere or body side)choice one of left, right, midline, unknownWhich side of the brain or body the injection targets.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "volume": {
        "value": 1,
        "unit": "mL"
    },
    "rate": {
        "value": 1,
        "unit": "mL/s"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
DeliveredComponent (Injected component)  PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution, TracerDyePharmacologicalAgent, ChemicalReagent, PhysiologicalSolution, TracerDyeyesApplied dose, mass, concentration, or dilution, Applied volume
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
StainDye (Stain or dye)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 
NeuralTracer (Neural tracer)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyesApplied concentration, dilution, or mass, Applied volume
CellSuspension (Cell suspension)  BiologicalMaterialBiologicalMaterialyesApplied cell count or concentration, Applied volume
ParticleSuspension (Particle suspension)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyesApplied particle count or concentration, Applied volume
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Virus injection

  • type code VirusInjection · version 3.0.0 · schema

Injection of a viral vector to introduce or manipulate genetic material in a target population. Describe each vector and its material-specific volume in Material usage when a total injection contains more than one material.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeInjection volumequantity with unit units nL, µL, mL, L; default {"unit": "nL"}The total volume of the viral solution injected.
rateInjection ratequantity with unit units nL/min, µL/min, mL/min, nL/s, µL/s; default {"unit": "nL/min"}Rate at which the viral solution was injected; for a non-constant profile, the nominal or average rate.
injectionProfileInjection profilechoice one of bolus_injection, continuous_infusion, intermittent_bolus, ramp_infusion, step_infusionShape the delivery took over time, within a single infusion.
routeInjection routechoice one of intraparenchymal, icv, intracisternal, it, iv, retro_orbital, ip, im, subretinal, otherAnatomical route the vector entered by; intraparenchymal is into the tissue itself, while systemic routes reach the brain only through the circulation.
insertionRateInsertion ratequantity with unit units µm/s, µm/min, mm/s, mm/min; default {"unit": "µm/s"}Rate of the final slow segment through the target tissue. Leave empty if the descent was made by hand.
postInfusionDwellPost-infusion dwellquantity with unit units s, min, h; default {"unit": "min"}How long the injector was held at the target between the end of the infusion and the start of withdrawal.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "volume": {
        "value": 1,
        "unit": "nL"
    },
    "rate": {
        "value": 1,
        "unit": "nL/min"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
ViralComponent (Viral-vector preparation)yes VirusSolutionVirusConstructyesApplied volume, Effective delivered titer
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
ActiveAgent (Other active agent)  PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyes 
StainDye (Stain or dye)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 
NeuralTracer (Neural tracer)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 
SurgicalSupply (Injection supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other injection material)    yes 

Sample Collection Procedures

Blood collection

  • type code BloodCollection · version 2.0.0 · schema

Collection of blood from a defined anatomical site for hematology, serum or plasma preparation, biochemistry, pharmacokinetics, genotyping, or another analysis.

PropertyTitleShapeRequiredAllowed valuesMeaning
collectionSiteCollection sitechoiceyesone of tail_vein, saphenous_vein, facial_vein, submandibular_vein, retro_orbital_sinus, jugular_vein, femoral_vein, cardiac_puncture, trunk, otherAnatomical site used for blood collection.
collectionMethodCollection methodchoice one of venipuncture, lancet, capillary_tube, catheter, otherMethod used to collect the blood sample.
volumeSample volumequantity with unit units mL, µL, L; default {"unit": "µL"}Approximate volume of blood collected.
samplePurposeSample purposechoice one of hematology, plasma_serum, biochemistry, pharmacokinetics, genotyping, otherPrimary downstream use of the blood sample.
postMortemCollectionPost-mortem collectionyes/no  Whether the sample was taken after the animal was already dead, rather than from a living animal.
storageConditionsStorage conditionstext  Storage or handling conditions before processing.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "collectionSite": "tail_vein",
    "collectionMethod": "venipuncture",
    "volume": {
        "value": 1,
        "unit": "µL"
    }
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
Anticoagulant (Anticoagulant)  PharmacologicalAgent, PhysiologicalSolution, ChemicalReagentPharmacologicalAgent, PhysiologicalSolution, ChemicalReagentyes 
CollectionAdditive (Collection additive)  PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyes 
CollectionContainer (Collection container)  SurgicalDisposable, ConsumableDeviceSurgicalDisposable, ConsumableDeviceyes 
StorageMedium (Storage medium)  PhysiologicalSolution, HistologyReagentPhysiologicalSolution, HistologyReagentyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Tissue collection

  • type code TissueCollection · version 2.0.0 · schema

Collection of non-brain tissue, such as a tail tip, ear punch, biopsy, or excised tissue. Use the structured details to record the site, method, amount, preservation, purpose, and terminal status where applicable.

PropertyTitleShapeRequiredAllowed valuesMeaning
collectionSiteCollection sitechoiceyesone of tail_tip, ear_punch, skin_biopsy, muscle_biopsy, organ_biopsy, tumor_biopsy, otherAnatomical source of the collected tissue.
collectionMethodCollection methodchoice one of snip, punch, biopsy, excision, scraping, otherMethod used to collect the tissue sample.
sampleLengthSample lengthquantity with unit units mm, cm, µm; default {"unit": "mm"}Approximate sample length, useful for tail-tip or similar samples.
sampleMassSample massquantity with unit units g, mg, µg; default {"unit": "mg"}Approximate mass of the tissue collected.
samplePurposeSample purposechoice one of genotyping, histology, molecular_analysis, cell_culture, pathology, otherPrimary downstream use of the tissue sample.
preservationMethodPreservation methodchoice one of fresh, ethanol, rnalater, paraformaldehyde_fixation, formalin_fixation, flash_freezing, liquid_nitrogen, dry_ice, otherMethod used to preserve the collected tissue.
postMortemCollectionPost-mortem collectionyes/no  Whether the sample was taken after the animal was already dead, rather than from a living animal.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "collectionSite": "tail_tip",
    "collectionMethod": "snip",
    "sampleLength": {
        "value": 1,
        "unit": "mm"
    }
}
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
SurgicalSupply (Collection supply)  SurgicalDisposableSurgicalDisposableyes 
Anticoagulant (Anticoagulant)  PharmacologicalAgent, PhysiologicalSolution, ChemicalReagentPharmacologicalAgent, PhysiologicalSolution, ChemicalReagentyes 
Medium (Collection medium)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
StorageMedium (Initial storage medium)  PhysiologicalSolution, HistologyReagentPhysiologicalSolution, HistologyReagentyes 
CollectionContainer (Collection container)  SurgicalDisposable, ConsumableDeviceSurgicalDisposable, ConsumableDeviceyes 
Other (Other collection material)    yes 

Brain and Tissue Procedures

Brain extraction

  • type code BrainExtraction · version 3.0.2 · schema

Removal of the brain following an endpoint procedure for subsequent histological, molecular, physiological, or other analysis.

PropertyTitleShapeRequiredAllowed valuesMeaning
extractionMethodExtraction methodchoiceyesone of complete_removal, partial_removal, sectional_removal, otherMethod used for brain extraction.
timeToExtractionTime to Extractionquantity with unit units s, min, h, ms; default {"unit": "min"}Time from euthanasia to brain extraction. Important for tissue quality.
brainWeightBrain Weightquantity with unit units g, kg, mg, µg; default {"unit": "g"}Weight of the extracted brain in grams.
preservationMethodPreservation methodchoiceyesone of fresh, paraformaldehyde_fixation, formalin_fixation, flash_freezing, liquid_nitrogen, dry_ice, otherMethod used to preserve the extracted brain tissue.
fixationDurationFixation durationquantity with unit units s, min, h, ms; default {"unit": "h"}Duration of fixation in hours (if applicable).
storageConditionsStorage Conditionstext  E.g., ‘Room temp’, ‘4°C’, ‘Protect from light’.

Illustrative payload:

{
    "extractionMethod": "complete_removal",
    "preservationMethod": "fresh",
    "timeToExtraction": {
        "value": 1,
        "unit": "min"
    },
    "brainWeight": {
        "value": 1,
        "unit": "g"
    }
}
  • coordinates_system accepts Coordinates types: External_XYZ_Euler, External_XYZ_Quaternion; other values are refused (400).
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
Medium (Processing medium)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
StorageMedium (Storage medium)  PhysiologicalSolution, HistologyReagentPhysiologicalSolution, HistologyReagentyes 
CollectionContainer (Collection container)  SurgicalDisposable, ConsumableDeviceSurgicalDisposable, ConsumableDeviceyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Brain lesion

  • type code BrainLesion · version 2.0.0 · schema

Deliberate injury or destruction of a defined brain region to investigate its functional contribution.

PropertyTitleShapeRequiredAllowed valuesMeaning
lesionMethodLesion methodtext  Specify the technique used to induce the brain lesion (e.g., surgical, suction, chemical, thermal, etc.).
volumeVolume of brain lesionquantity with unit units µL, mL, L, nL; default {"unit": "µL"}Enter the estimated or calculated volume of the brain lesion.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "lesionMethod": "text",
    "volume": {
        "value": 1,
        "unit": "µL"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
LesionAgent (Lesion agent)  PharmacologicalAgent, ChemicalReagentPharmacologicalAgent, ChemicalReagentyes 
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
StainDye (Stain or dye)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyes 
NeuralTracer (Neural tracer)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyesApplied concentration, dilution, or mass, Applied volume
ParticleSuspension (Particle suspension)  TracerDye, ChemicalReagentTracerDye, ChemicalReagentyesApplied particle count or concentration, Applied volume
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Brain perfusion fixation

  • type code PerfusionFixation · version 3.0.1 · schema

Perfusion of fixative through the circulatory system to preserve the brain and other tissues. This remains a Procedure because it is performed on the subject.

PropertyTitleShapeRequiredAllowed valuesMeaning
routeVascular access routechoice one of intracardiac, carotid, intra_aortic, intracranial, otherWhere the perfusate entered the circulation.
perfusionScopePerfusion scopechoice one of whole_body, head_only, otherHow far the perfusate was carried through the animal.
perfusionDrivePerfusion drivechoice one of gravity_feed, peristaltic_pump, syringe_pump, pressurized_line, manual_syringe, otherWhat pushed the perfusate through the circulation.
pressurePerfusion pressurequantity with unit units mmHg, cmH₂O, kPa; default {"unit": "mmHg"}Pressure the perfusate was delivered at, read from the regulator or the height of the reservoir.
heartBeatingAtStartHeart beating at startyes/no  Check this if the heart was still beating when the perfusate first entered the circulation.
phasesPerfusion phasestable of rows format tableEach phase of the perfusion, one row per phase, in the order they were delivered. The wash and the fixative make different claims about volume, rate, duration, and temperature, so each states its own.
phases[].phasePhasechoiceyesone of wash, fixative, otherWhat this row delivered: the wash that clears blood from the circulation (a rinse and a flush are the same step under one name), the fixative that follows it, or another step.
phases[].volumeVolumequantity with unit units L, mL, µL, nL, pL; default {"unit": "mL"}Volume delivered in this phase, as it was actually run rather than as planned.
phases[].flowRateRatequantity with unit units L/min, mL/min, µL/min; default {"unit": "mL/min"}Rate at which this phase’s solution moved through the circulation.
phases[].durationDurationquantity with unit units h, min, s; default {"unit": "min"}How long this phase ran. Fixative contact time is what over- and under-fixation are compared on, and it is normally not the same as the wash duration.
phases[].temperatureTemperaturequantity with unit units °C; default {"unit": "°C"}Temperature of the solution delivered in this phase.
completionSignsSigns of completionmulti-select one of liver_blanching, clear_effluent, fixation_tremor, tissue_rigidity, pale_brain; format select2Which conventional signs that the perfusion was working were actually seen.
failureModeFailure modesmulti-select one of clotting, cannula_misplaced, atrium_not_opened, oedema, circuit_leak, air_embolism, residual_blood, other; format select2What went wrong, if anything; tick every fault that applied. Leave empty if nothing went wrong.
confirmationOfDeathConfirmation of deathmulti-select one of absence_of_heartbeat, absence_of_breathing, absence_of_reflexes, fixed_dilated_pupils, loss_of_corneal_reflex, other; format select2How death was verified at the end of the perfusion. Tick every check that was made; verification normally combines more than one.
fatalOutcomeFatal outcomechoice one of not_fatal, planned_terminal, unintended_deathWhether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal.

Illustrative payload:

{
    "route": "intracardiac",
    "perfusionScope": "whole_body"
}

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
WashSolution (Rinse or flush solution)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
Buffer (Perfusion buffer)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
Fixative (Fixative)yes HistologyReagent, ChemicalReagentHistologyReagent, ChemicalReagentyes 
Anticoagulant (Anticoagulant)  PharmacologicalAgent, PhysiologicalSolution, ChemicalReagentPharmacologicalAgent, PhysiologicalSolution, ChemicalReagentyes 
SurgicalSupply (Perfusion supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other perfusion material)    yes 

Stages:

  • flush (Flush), no detail schema; repeatable
  • fixation (Fixation), no detail schema; repeatable

Endpoint Procedures (Euthanasia)

Barbiturate injection

  • type code BarbiturateInjection · version 5.0.0 · schema

Euthanasia by administration of a barbiturate solution using an appropriate route.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationConcentrationquantity with unit units mg/mL, µg/mL, g/L, mg/L, µg/L; default {"unit": "mg/mL"}Concentration of the barbiturate solution.
doseDosagequantity with unit units mg/kg, µg/kg, g/kg; default {"unit": "mg/kg"}Dosage administered per kilogram of body weight.
routeAdministration routechoiceyesone of ip, iv, intracardiac, sc, otherRoute of barbiturate administration.
volumeVolume administeredquantity with unit units mL, L, µL, nL; default {"unit": "mL"}Total volume of barbiturate solution administered.
timeToUnconsciousnessTime to unconsciousnessquantity with unit units s, min, h, ms; default {"unit": "s"}Observed time to loss of consciousness.
confirmationOfDeathConfirmation of deathmulti-selectyesone of heartbeat_absent, breathing_absent, reflexes_absent, pupils_fixed_dilated, corneal_reflex_absent, additional_dose, other; format select2Methods used to confirm death.

Illustrative payload:

{
    "route": "ip",
    "confirmationOfDeath": [
        "heartbeat_absent"
    ],
    "concentration": {
        "value": 1,
        "unit": "mg/mL"
    },
    "dose": {
        "value": 1,
        "unit": "mg/kg"
    }
}
  • coordinates_system accepts Coordinates types: External_XYZ_Euler, External_XYZ_Quaternion; other values are refused (400).
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
InjectedEuthanasiaAgent (Injected euthanasia agent)yes PharmacologicalAgentPharmacologicalAgentyesApplied dose or concentration
PharmacologicalAdjuvant (Pharmacological adjunct)  PharmacologicalAgentPharmacologicalAgentyes 
Vehicle (Vehicle)  PhysiologicalSolution, ChemicalReagentPhysiologicalSolution, ChemicalReagentyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Cervical dislocation

  • type code CervicalDislocation · version 2.0.3 · schema

A physical method involving separation of the cervical vertebrae.

PropertyTitleShapeRequiredAllowed valuesMeaning
dislocationMethodMethod of dislocationchoiceyesone of manual, mechanical_device, scissor_method, otherMethod used for cervical dislocation.
confirmationOfDeathConfirmation of deathmulti-selectyesone of absence_of_heartbeat, absence_of_breathing, absence_of_reflexes, fixed_dilated_pupils, loss_of_corneal_reflex, other; format select2Methods used to confirm death.

Illustrative payload:

{
    "dislocationMethod": "manual",
    "confirmationOfDeath": [
        "absence_of_heartbeat"
    ]
}
  • coordinates_system accepts Coordinates types: External_XYZ_Euler, External_XYZ_Quaternion; other values are refused (400).
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

CO₂ chamber euthanasia

  • type code Co2ChamberEuthanasia · version 4.0.0 · schema

Euthanasia using controlled exposure to carbon dioxide in a chamber.

PropertyTitleShapeRequiredAllowed valuesMeaning
co2ConcentrationCO₂ concentrationquantity with unityesunits %, ppm, ppb; default {"unit": "%"}Concentration of CO₂ used in the chamber.
rateCO₂ Flow Ratequantity with unit units L/min, mL/min, L/s, mL/s; default {"unit": "L/min"}Rate of CO₂ flow into the chamber.
exposureDurationExposure Durationquantity with unityesunits s, min, h, ms; default {"unit": "min"}Duration of CO₂ exposure.
timeToUnconsciousnessTime to unconsciousnessquantity with unit units s, min, h, ms; default {"unit": "s"}Observed time to loss of consciousness.
prefillingMethodChamber prefillingchoice one of not_prefilled, partially_prefilled, fully_prefilled, otherMethod of chamber prefilling with CO₂.
chamberVolumeChamber volumequantity with unit units L, mL, µL; default {"unit": "L"}Volume of the euthanasia chamber.
gradualIntroductionGradual CO₂ introductionyes/no  Check if CO₂ was introduced gradually (recommended for animal welfare).
confirmationOfDeathConfirmation of deathmulti-selectyesone of absence_of_heartbeat, absence_of_breathing, absence_of_reflexes, fixed_dilated_pupils, loss_of_corneal_reflex, continued_co2_exposure, other; format select2Methods used to confirm death.

Illustrative payload:

{
    "co2Concentration": {
        "value": 1,
        "unit": "%"
    },
    "exposureDuration": {
        "value": 1,
        "unit": "min"
    },
    "confirmationOfDeath": [
        "absence_of_heartbeat"
    ],
    "rate": {
        "value": 1,
        "unit": "L/min"
    },
    "timeToUnconsciousness": {
        "value": 1,
        "unit": "s"
    }
}
  • coordinates_system accepts Coordinates types: External_XYZ_Euler, External_XYZ_Quaternion; other values are refused (400).
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
InhaledEuthanasiaAgent (Inhaled euthanasia agent)yes MedicalGasMedicalGasyes 
CarrierGas (Carrier gas)  MedicalGasMedicalGasyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Decapitation

  • type code Decapitation · version 3.0.1 · schema

A rapid physical endpoint method, including contexts where tissue must be collected immediately.

PropertyTitleShapeRequiredAllowed valuesMeaning
decapitationMethodDecapitation Methodchoiceyesone of guillotine, sharp_scissors, surgical_blade, otherMethod/instrument used for decapitation.

Illustrative payload:

{
    "decapitationMethod": "guillotine"
}
  • coordinates_system accepts Coordinates types: External_XYZ_Euler, External_XYZ_Quaternion; other values are refused (400).
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, equipment, equipment_setup.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes 

Inhalant overdose

  • type code InhalantOverdose · version 5.0.0 · schema

Euthanasia using an overdose of an inhalant anesthetic.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationConcentrationquantity with unit units % v/v; default {"unit": "% v/v"}Concentration of anesthetic agent used.
rateOxygen flow ratequantity with unit units L/min, mL/min, mL/s; default {"unit": "L/min"}Flow rate of oxygen or carrier gas.
deliveryMethodDelivery methodchoice one of anesthesia_chamber, nose_cone, intubation, bell_jar, otherMethod used to deliver the anesthetic agent.
exposureDurationExposure durationquantity with unit units µs, ms, s, min, h; default {"unit": "min"}Duration of anesthetic exposure.
timeToUnconsciousnessTime to unconsciousnessquantity with unit units µs, ms, s, min, h; default {"unit": "s"}Observed time to loss of consciousness.
confirmationOfDeathConfirmation of deathmulti-select one of heartbeat_absent, breathing_absent, reflexes_absent, pupils_fixed_dilated, corneal_reflex_absent, continued_exposure, other; format select2Methods used to confirm death.

Illustrative payload:

{
    "concentration": {
        "value": 1,
        "unit": "% v/v"
    },
    "rate": {
        "value": 1,
        "unit": "L/min"
    }
}
  • coordinates_system accepts Coordinates types: External_XYZ_Euler, External_XYZ_Quaternion; other values are refused (400).
  • Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas.

Materials (material usage rows) allowed on this type:

Role (type)RequiredMaxFrom stock typesFrom catalog typesManualComplete when
InhaledEuthanasiaAgent (Inhaled euthanasia agent)yes PharmacologicalAgent, MedicalGasPharmacologicalAgent, MedicalGasyes 
CarrierGas (Carrier gas)  MedicalGasMedicalGasyes 
SurgicalSupply (Surgical supply)  SurgicalDisposableSurgicalDisposableyes 
Other (Other material)    yes