Procedure schemas
Type-specific details of in-vivo procedures performed on a subject.
Table of contents
- How to use this family
- Quick type map
- Anesthesia, Drug and Fluid Administration
- Surgical Procedures
- Implant Procedures
- Blood pressure sensor implant
- Breathing sensor implant
- Cannula implant
- Catheter implant
- ECG implant (Electrocardiography)
- ECoG implant (Electrocorticography)
- EEG implant (Electroencephalography)
- EMG implant (Electromyography)
- Generic implant
- GRIN (Gradient Index) lens implant
- Nerve cuff implant
- Optic fiber implant
- Prism implant
- Reference electrode implant
- Silicon probe implant
- Single wire electrode implant
- Temperature sensor implant
- Tetrode wire electrode implant
- Injection and Infusion Procedures
- Sample Collection Procedures
- Brain and Tissue Procedures
- Endpoint Procedures (Euthanasia)
How to use this family
procedure: settypeto a type code below and send its properties indetails.proceduretemplate: settypeto a type code below and send its properties indetails.- Every version is published at
https://www.brainstem.org/schemas/Procedure/<Type>/<version>.jsonand never changes;https://www.brainstem.org/schemas/Procedure/<Type>.jsonis the current version andhttps://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 code | Title | Group | Version | Required properties | Schema |
|---|---|---|---|---|---|
Analgesic | Analgesic | Anesthesia, Drug and Fluid Administration | 2.0.0 | route | 2.0.0.json |
Anesthesia | Anesthesia | Anesthesia, Drug and Fluid Administration | 8.0.1 | none | 8.0.1.json |
AntiInflammatory | Anti-inflammatory | Anesthesia, Drug and Fluid Administration | 2.0.0 | route | 2.0.0.json |
Antibiotic | Antibiotic | Anesthesia, Drug and Fluid Administration | 2.0.0 | route, indication | 2.0.0.json |
BarbiturateInjection | Barbiturate injection | Endpoint Procedures (Euthanasia) | 5.0.0 | route, confirmationOfDeath | 5.0.0.json |
Baseplating | Baseplating | Surgical Procedures | 1.0.0 | none | 1.0.0.json |
BloodCollection | Blood collection | Sample Collection Procedures | 2.0.0 | collectionSite | 2.0.0.json |
BloodPressureSensorImplant | Blood pressure sensor implant | Implant Procedures | 4.0.0 | sensorType, fixationMethod | 4.0.0.json |
BrainExtraction | Brain extraction | Brain and Tissue Procedures | 3.0.2 | extractionMethod, preservationMethod | 3.0.2.json |
BrainLesion | Brain lesion | Brain and Tissue Procedures | 2.0.0 | none | 2.0.0.json |
BreathingSensorImplant | Breathing sensor implant | Implant Procedures | 5.0.0 | sensorType, fixationMethod | 5.0.0.json |
BurrHole | Burr hole | Surgical Procedures | 2.1.0 | none | 2.1.0.json |
CannulaImplant | Cannula implant | Implant Procedures | 1.1.0 | targetSite | 1.1.0.json |
CatheterImplant | Catheter implant | Implant Procedures | 4.0.0 | targetSite | 4.0.0.json |
CervicalDislocation | Cervical dislocation | Endpoint Procedures (Euthanasia) | 2.0.3 | dislocationMethod, confirmationOfDeath | 2.0.3.json |
Co2ChamberEuthanasia | CO₂ chamber euthanasia | Endpoint Procedures (Euthanasia) | 4.0.0 | co2Concentration, exposureDuration, confirmationOfDeath | 4.0.0.json |
CranialWindow | Cranial window | Surgical Procedures | 1.2.1 | none | 1.2.1.json |
Craniectomy | Craniectomy | Surgical Procedures | 2.0.1 | none | 2.0.1.json |
Craniotomy | Craniotomy | Surgical Procedures | 2.0.1 | none | 2.0.1.json |
Decapitation | Decapitation | Endpoint Procedures (Euthanasia) | 3.0.1 | decapitationMethod | 3.0.1.json |
DrugAdministration | Drug administration (other) | Anesthesia, Drug and Fluid Administration | 3.0.0 | purpose, route | 3.0.0.json |
EcgImplant | ECG implant (Electrocardiography) | Implant Procedures | 4.0.0 | fixationMethod | 4.0.0.json |
EcogImplant | ECoG implant (Electrocorticography) | Implant Procedures | 1.0.1 | none | 1.0.1.json |
EegImplant | EEG implant (Electroencephalography) | Implant Procedures | 4.0.0 | wireCount, electrodeType, electrodeMaterial, fixationMethod | 4.0.0.json |
EmgImplant | EMG implant (Electromyography) | Implant Procedures | 3.1.0 | wireCount, implantMethod | 3.1.0.json |
FluidTherapy | Fluid therapy | Anesthesia, Drug and Fluid Administration | 2.0.0 | volume, route | 2.0.0.json |
GenericImplant | Generic implant | Implant Procedures | 2.1.0 | implantType | 2.1.0.json |
GrinLensImplant | GRIN (Gradient Index) lens implant | Implant Procedures | 2.1.0 | none | 2.1.0.json |
HeadFixation | Head fixation | Surgical Procedures | 2.0.3 | none | 2.0.3.json |
Headcap | Headcap | Surgical Procedures | 4.0.1 | none | 4.0.1.json |
Headpost | Headpost | Surgical Procedures | 4.0.1 | none | 4.0.1.json |
InhalantOverdose | Inhalant overdose | Endpoint Procedures (Euthanasia) | 5.0.0 | none | 5.0.0.json |
Injection | Injection | Injection and Infusion Procedures | 3.1.0 | none | 3.1.0.json |
LocalAnesthetic | Local anesthetic | Anesthesia, Drug and Fluid Administration | 2.0.0 | placementTechnique | 2.0.0.json |
NerveCuffImplant | Nerve cuff implant | Implant Procedures | 5.0.0 | cuffType, fixationMethod | 5.0.0.json |
OpticFiberImplant | Optic fiber implant | Implant Procedures | 2.2.1 | none | 2.2.1.json |
PerfusionFixation | Brain perfusion fixation | Brain and Tissue Procedures | 3.0.1 | none | 3.0.1.json |
PrismImplant | Prism implant | Implant Procedures | 3.0.0 | none | 3.0.0.json |
ReferenceElectrodeImplant | Reference electrode implant | Implant Procedures | 2.1.0 | electrodeCount, electrodeMaterial | 2.1.0.json |
Sedative | Sedative | Anesthesia, Drug and Fluid Administration | 2.0.1 | route | 2.0.1.json |
SiliconProbeImplant | Silicon probe implant | Implant Procedures | 2.2.1 | none | 2.2.1.json |
SingleWireElectrodeImplant | Single wire electrode implant | Implant Procedures | 2.1.0 | wireCount | 2.1.0.json |
TemperatureSensorImplant | Temperature sensor implant | Implant Procedures | 5.0.0 | sensorType, fixationMethod | 5.0.0.json |
TetrodeWireElectrodeImplant | Tetrode wire electrode implant | Implant Procedures | 3.0.1 | tetrodeCount | 3.0.1.json |
TissueCollection | Tissue collection | Sample Collection Procedures | 2.0.0 | collectionSite | 2.0.0.json |
VirusInjection | Virus injection | Injection and Infusion Procedures | 3.0.0 | none | 3.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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Volume administered | quantity 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. | |
route | Administration route | choice | yes | one of sc, ip, im, iv, oral, topical, other | Route of analgesic administration. |
indication | Indication | choice | one of prophylactic, therapeutic | Whether the analgesic was given to prevent expected pain or to treat pain already present. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ActiveAgent (Active agent) | yes | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | Applied dose or concentration | |
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
CarrierGas (Carrier gas) | MedicalGas | MedicalGas | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
depth | Anesthetic depth | choice | one of light_sedation, moderate_sedation, deep_sedation, surgical_plane, other | The anesthetic depth reached; deep sedation is not surgical plane. | |
endOfAnesthesia | End of anesthesia | text | Time when anesthesia ended, as HH:MM. | ||
duration | Total duration | quantity with unit | units h, min, s; default {"unit": "min"} | Total time the animal spent under anesthesia, across every phase of it. | |
recoveryTime | Recovery time | quantity with unit | units h, min, s; default {"unit": "min"} | Time from end of anesthesia to return of righting reflex or normal activity. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal. | |
monitoring | Monitoring | table of rows | format table | What was followed during the anesthetic, how it was assessed, and how often. One row per parameter; an empty table means nothing was monitored. | |
monitoring[].parameter | Parameter | choice | yes | one of anesthetic_depth, blood_pressure, heart_rate, oxygen_saturation, respiratory_rate, temperature, other | What 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[].method | Assessment method | multi-select | one of pedal_withdrawal_reflex, palpebral_reflex, corneal_reflex, tail_pinch_reflex, visual_observation, pulse_oximetry, ecg, eeg, capnography, rectal_probe, other; format select2 | How this parameter was assessed; select every check or instrument used. | |
monitoring[].interval | Interval | quantity with unit | units h, min, s; default {"unit": "min"} | How often this parameter was checked. Leave empty for continuous monitoring. | |
supportiveCare | Supportive care | table of rows | format table | Care given alongside the anesthetic. One row per measure; an empty table means none was given. | |
supportiveCare[].measure | Measure | choice | yes | one of eye_lubricant, fluid_therapy, heating_pad, oxygen_supplementation, other | Which supportive measure was given while the animal was under. |
Illustrative payload:
{
"depth": "light_sedation",
"endOfAnesthesia": "text"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
AnestheticAgent (Anesthetic agent) | yes | PharmacologicalAgent | PharmacologicalAgent | yes | Applied dose or concentration | |
CarrierGas (Carrier gas) | MedicalGas | MedicalGas | yes | |||
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
ReversalAgent (Reversal agent) | PharmacologicalAgent | PharmacologicalAgent | yes | |||
SupportiveAgent (Supportive-care agent) | PharmacologicalAgent, PhysiologicalSolution | PharmacologicalAgent, PhysiologicalSolution | yes | |||
SurgicalSupply (Anesthesia supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other anesthesia material) | yes |
Stages:
induction(Induction), no detail schema; repeatablemaintenance(Maintenance), no detail schema; repeatabletop_up(Top-up), no detail schema; repeatablereversal(Reversal), no detail schema; repeatableemergence(Emergence), no detail schema; repeatableother(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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Volume administered | quantity with unit | units mL, µL, L; default {"unit": "mL"} | Total volume of solution physically administered. | |
route | Administration route | choice | yes | one of sc, ip, im, iv, oral, topical, other | Route of administration. |
indication | Indication | choice | one of prophylactic, therapeutic | Whether the anti-inflammatory was given to prevent inflammation or to treat inflammation already present. | |
administrationRole | Administration role | choice | one of clinical_care, experimental_treatment | Whether the agent was given as clinical care or as the experimental treatment itself. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ActiveAgent (Active agent) | yes | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | Applied dose or concentration | |
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Volume administered | quantity with unit | units mL, µL, L; default {"unit": "mL"} | Total volume actually administered, spanning the agent and any vehicle. | |
route | Administration route | choice | yes | one of sc, ip, im, iv, oral, topical, other | Route of antibiotic administration. |
indication | Indication | choice | yes | one of prophylactic, therapeutic, experimental_manipulation, other | Whether the antibiotic was given to prevent a problem, to treat an observed one, or as the experimental manipulation itself. |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ActiveAgent (Active agent) | yes | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | Applied dose or concentration | |
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
purpose | Purpose | choice | yes | one of hormone, reversal_antidote, supplement, other | What the substance was given for. Use a dedicated procedure type wherever one fits. |
administrationRole | Administration role | choice | one of clinical_care, experimental_treatment | Whether the substance was given as supportive care or as the experimental treatment itself. | |
volume | Volume administered | quantity with unit | units mL, µL, L; default {"unit": "mL"} | Total volume of solution delivered to the animal in this administration. | |
route | Administration route | choice | yes | one of sc, ip, im, iv, oral, topical, inhaled, other | Route of administration. |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ActiveAgent (Active agent) | yes | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | Applied dose or concentration | |
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
CarrierGas (Carrier gas) | MedicalGas | MedicalGas | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Total volume administered | quantity with unit | yes | units L, mL, µL; default {"unit": "mL"} | Total volume of fluid administered in this event, summed across every site. |
route | Administration route | choice | yes | one of sc, ip, iv, io, oral, other | Route of fluid administration. |
injectionProfile | Delivery profile | choice | one of bolus_injection, slow_injection, continuous_infusion | The shape the delivery took over time. | |
rate | Infusion rate | quantity 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. | |
numberOfSites | Number of sites | integer | ≥ 1 | How many separate needle placements or entry points the total volume was divided across. | |
temperature | Fluid temperature | quantity with unit | units °C, °F, K; default {"unit": "°C"} | Temperature of the fluid itself when it was given, not the animal’s body temperature. | |
fluidIndication | Fluid indication | choice | one of dehydration, perioperative_support, blood_or_fluid_loss, reduced_intake_or_anorexia, hypoglycaemia, other | Which clinical problem the fluid was given to address. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
AdministeredFluid (Administered fluid) | yes | PhysiologicalSolution, PharmacologicalAgent | PhysiologicalSolution, PharmacologicalAgent | yes | ||
FluidAdditive (Fluid additive) | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Volume administered | quantity with unit | units mL, µL, L; default {"unit": "mL"} | Total volume of anaesthetic solution placed at the site in this administration. | |
placementTechnique | Placement technique | choice | yes | one of infiltration, perineural, splash, instillation, topical_application, other | How the anaesthetic was physically deposited in or on the tissue. |
site | Site | text | Structure or region the anaesthetic was placed at; record the side in the laterality field. | ||
laterality | Laterality | choice | one of left, right, bilateral, midline | Which side of the body the anaesthetic was placed on. | |
guidanceMethod | Guidance method | choice | one of blind_landmark, nerve_locator, ultrasound, direct_vision, other | How the target was located while the anaesthetic was being placed. | |
applicationDwellTime | Application dwell time | quantity 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. | |
blockEffectiveness | Block effectiveness | choice | one of no_response_at_incision, reduced_response, full_response, not_assessed | The operator’s judgement of whether the block worked, from the response seen at the first incision. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ActiveAgent (Active agent) | yes | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | Applied dose or concentration | |
PharmacologicalAdjuvant (Pharmacological adjunct) | PharmacologicalAgent | PharmacologicalAgent | yes | |||
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Volume administered | quantity with unit | units mL, µL, L; default {"unit": "mL"} | Total volume of solution that entered the animal in this event, vehicle included. | |
rate | Infusion rate | quantity 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. | |
route | Administration route | choice | yes | one of sc, ip, im, iv, inhaled, oral, other | Route of sedative administration. |
injectionProfile | Delivery profile | choice | one of bolus_injection, slow_injection, continuous_infusion | Shape the delivery took over time, which an empty rate cannot state. | |
sedationLevel | Sedation level | choice | one of light_sedation, moderate_sedation, deep_sedation, surgical_plane, other | The level the animal actually reached; deep sedation is not surgical plane. | |
duration | Sedation duration | quantity with unit | units h, min, s; default {"unit": "min"} | Time from administration of the agent to the end of the sedation. | |
recoveryTime | Recovery time | quantity with unit | units h, min, s; default {"unit": "min"} | Time from the end of the sedation until the animal rights itself and moves normally. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether the animal died with this procedure, and whether that was intended; record it only on the procedure that actually ended the animal. | |
monitoring | Monitoring | table of rows | format table | What was followed while the animal was sedated, how, and how often. One row per parameter; an empty table means nothing was monitored. | |
monitoring[].parameter | Parameter | choice | yes | one of anesthetic_depth, blood_pressure, heart_rate, oxygen_saturation, respiratory_rate, temperature, other | What this row followed — the parameter itself, never the instrument that read it. Anesthetic depth covers the sedation level. |
monitoring[].method | Assessment method | multi-select | one of pedal_withdrawal_reflex, palpebral_reflex, corneal_reflex, tail_pinch_reflex, visual_observation, pulse_oximetry, ecg, eeg, capnography, rectal_probe, other; format select2 | How this parameter was assessed; select every check or instrument used. | |
monitoring[].interval | Interval | quantity with unit | units h, min, s; default {"unit": "min"} | How often this parameter was checked. Leave empty for continuous monitoring. | |
supportiveCare | Supportive care | table of rows | format table | Care given alongside the sedation. One row per measure; an empty table means none was given. | |
supportiveCare[].measure | Measure | choice | yes | one of eye_lubricant, fluid_therapy, heating_pad, oxygen_supplementation, other | Which 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ActiveAgent (Active agent) | yes | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | Applied dose or concentration | |
PharmacologicalAdjuvant (Pharmacological adjunct) | PharmacologicalAgent | PharmacologicalAgent | yes | |||
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
CarrierGas (Carrier gas) | MedicalGas | MedicalGas | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes |
Stages:
induction(Induction), no detail schema; repeatablemaintenance(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.
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
Baseplate (Baseplate) | yes | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | ||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
ShieldingMaterial (Light-shielding material) | ImplantMaterial, ConsumableDevice | ImplantMaterial, ConsumableDevice | yes | |||
OtherComponent (Other baseplate component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
diameter | Hole diameter | quantity with unit | units mm, µm, cm, m; default {"unit": "mm"} | Diameter of the burr hole. | |
drillSpeed | Drill speed | quantity with unit | units RPM, Hz; default {"unit": "RPM"} | Speed of the drill. | |
purpose | Purpose | text | Primary purpose of creating the burr hole. | ||
coolingMethod | Cooling method | choice | one of saline_irrigation, air_cooling, none, other | Method used to prevent overheating during drilling. | |
duraHandling | Dura handling | choice | one of left_intact, punctured, incised, excised | How the dura was left by this opening; an incidental nick counts as punctured. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
IrrigationSolution (Irrigation solution) | PhysiologicalSolution | PhysiologicalSolution | yes | |||
HemostaticAgent (Hemostatic agent) | PharmacologicalAgent, SurgicalDisposable | PharmacologicalAgent, SurgicalDisposable | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
surgicalMethod | Surgical method | text | 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. | ||
shape | Shape of cranial window | text | 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. | ||
dimensions | Dimensions of cranial window | text | Dimensions of the window: length, width, diameter or thickness. E.g., ‘1.0 mm diameter × 4 mm length’. | ||
orientation | Orientation of cranial window | text | 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. | ||
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
CranialWindow (Cranial window) | yes | ConsumableDevice, ImplantMaterial, OpticalComponent | ConsumableDevice, ImplantMaterial, OpticalComponent | yes | ||
IrrigationSolution (Irrigation solution) | PhysiologicalSolution | PhysiologicalSolution | yes | |||
HemostaticAgent (Hemostatic agent) | PharmacologicalAgent, SurgicalDisposable | PharmacologicalAgent, SurgicalDisposable | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
surgicalMethod | Surgical method | text | 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. | ||
shape | Shape of craniectomy | text | Describe the shape of the craniectomy, such as square, circular, oval, or irregular. | ||
dimensions | Dimensions of craniectomy | text | Dimensions of the craniectomy: length, width, or diameter. E.g., ‘1.0 mm diameter × 4 mm length’. | ||
orientation | Orientation of craniectomy | text | Indicate the orientation of the craniectomy relative to major anatomical landmarks. | ||
duraHandling | Dura handling | choice | one of left_intact, punctured, incised, excised | How the dura was left by this opening; an incidental nick counts as punctured. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
IrrigationSolution (Irrigation solution) | PhysiologicalSolution | PhysiologicalSolution | yes | |||
HemostaticAgent (Hemostatic agent) | PharmacologicalAgent, SurgicalDisposable | PharmacologicalAgent, SurgicalDisposable | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
surgicalMethod | Surgical method | text | 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. | ||
shape | Shape of craniotomy | text | Shape of the craniotomy, such as square, circular, or elliptical. | ||
dimensions | Dimensions of craniotomy | text | Dimensions of the craniotomy: length, width, or diameter. E.g., ‘1.0 mm diameter × 4 mm length’. | ||
orientation | Orientation of craniotomy | text | 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. | ||
duraHandling | Dura handling | choice | one of left_intact, punctured, incised, excised | How the dura was left by this opening; an incidental nick counts as punctured. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
IrrigationSolution (Irrigation solution) | PhysiologicalSolution | PhysiologicalSolution | yes | |||
HemostaticAgent (Hemostatic agent) | PharmacologicalAgent, SurgicalDisposable | PharmacologicalAgent, SurgicalDisposable | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
fixationMethod | Fixation methods | multi-select | one of ear_bars, nose_clamp, tooth_bar, headpost_clamp, custom_holder, other; format select2 | Methods used to the fixate head, typically using a stereotaxic frame or custom apparatus. | |
alignment | Alignment | text | The alignment achieved in the fixation procedure (e.g. bregma and lambda aligned; slight ML tilt to the left) | ||
fixationDetails | Fixation details | text | 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
Headpost (Headpost) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
material | Material | text | hidden legacy field | Material used to build the headcap, e.g., dental cement, acrylic, epoxy, UV-cured resin, titanium, stainless steel, or plastic. | |
shape | Shape | text | hidden legacy field | Geometrical shape or design (e.g. hexagonal, square, oval, cylinder). | |
constructionMethod | Construction Method | choice | one of manually_built, custom_built, 3d_printed, milled, molded, other | How the headcap was constructed. | |
fixationMethod | Attachment Method | choice | one of dental_cement, uv_cured_resin, super_glue, epoxy, screws, other | Method used to affix the headcap to the skull. | |
shielding | Faraday Shielding | choice | one of none, conductive_paint, copper_mesh, aluminum_foil, custom, unknown; hidden legacy field | Whether and how the headcap was shielded to reduce electrical noise. | |
skullPreparation | Skull preparation | multi-select | one of cleaned, periosteum_removed, roughened, dried, etched, primed, none; format select2 | How the skull was prepared before attachment; select every step that was carried out. | |
deviceIdentifier | Device identifier | text | 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. | ||
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
HeadcapAssembly (Headcap assembly) | yes | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | ||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
ShieldingMaterial (Shielding material) | ImplantMaterial, ConsumableDevice | ImplantMaterial, ConsumableDevice | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
material | Material | text | Material of the headpost, e.g., titanium, stainless steel, or plastic. | ||
shape | Shape | text | Geometrical shape or design (e.g., flat bar, U-frame, circular post). | ||
constructionMethod | Construction method | choice | one of manually_built, custom_built, 3d_printed, milled, other | How the headpost was constructed prior to implantation. | |
fixationMethod | Attachment method | choice | one of dental_cement, super_glue, epoxy, screws, other | Method used to affix the headpost to the skull. | |
skullPreparation | Skull preparation | multi-select | one of cleaned, periosteum_removed, roughened, dried, etched, primed, none; format select2 | How the skull was prepared before attachment; select every step that was carried out. | |
deviceIdentifier | Device identifier | text | 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. | ||
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
Headpost (Headpost) | yes | ImplantMaterial, ConsumableDevice | ImplantMaterial, ConsumableDevice | yes | ||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sensorType | Sensor type | choice | yes | one of telemetric, catheter_based, fluid_filled, fiber_optic, other | Type of blood pressure sensor used. |
implantSite | Implant site | text | Vascular or body location where the pressure sensor was implanted — e.g., ‘Femoral artery’,’Carotid artery’,’Aorta’,’Ventral tail artery’,’Left ventricle’. | ||
catheterMaterial | Catheter material | text | Material used for the catheter or tubing connecting the pressure sensor to vasculature. | ||
fixationMethod | Anchoring method | choice | yes | one of sutured, subcutaneous_tunnel, tissue_glue, headcap, cemented_to_skull, other | How the sensor or catheter were secured in place to prevent movement. |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | Sterilization technique used before implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
BloodPressureSensor (Blood-pressure sensor) | yes | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | ||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
Breathing sensor implant
- type code
BreathingSensorImplant· version 5.0.0 · schema
Placement of a sensor used to monitor respiratory patterns or rate.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sensorType | Sensor type | choice | yes | one of piezoelectric, chest_wall_emg, intranasal_thermocouple, intranasal_pressure, tracheal_airflow, thoracic_pressure, plethysmography_cannula, other | Type of breathing sensor used. |
implantSite | Implant site | text | Anatomical location where the breathing sensor was implanted or attached — e.g., ‘Chest wall’, ‘Diaphragm’, ‘Nasal cavity’, ‘Trachea’, ‘Pleural cavity’, ‘Subcutaneous (telemetry)’, ‘Other’. | ||
wireMaterial | Wire or lead material | text | Material used for connecting wires or leads (e.g., stainless steel, silver, silver chloride, platinum, tungsten). | ||
fixationMethod | Anchoring method | choice | yes | one of sutured, tissue_glue, subcutaneous_tunnel, cemented_to_skull, headcap, custom_mount, other | How the sensor or wires were fixed in place during implantation. |
signalTransmission | Signal transmission | choice | one of tethered, wireless, telemetric, inductive, optical, other | Mode of signal transmission from the sensor to the acquisition device. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | Sterilization technique applied before implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
RespiratorySensor (Respiratory sensor) | yes | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | ||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
targetSite | Target site | choice | yes | one of lateral_ventricle, third_ventricle, cisterna_magna, intrathecal_spinal_cord, other | CSF or ventricular compartment targeted by the cannula. For a parenchymal target, use the structured brain region field. |
cannulaType | Cannula type | choice | one of guide_cannula, infusion_cannula, icv_cannula, osmotic_pump_cannula, microdialysis_guide, other | Functional type of cannula implanted. | |
cannulaGauge | Cannula gauge | integer | ≥ 0 | Gauge of the cannula, if applicable. | |
cannulaLength | Cannula length | quantity with unit | units mm, cm, µm; default {"unit": "mm"} | Length of the implanted cannula. | |
insertionRate | Insertion rate | quantity 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. | |
laterality | Laterality | choice | one of left, right, bilateral, midline, unknown | Side of the brain or body targeted by the cannula. | |
implantPurpose | Implant purpose | choice | one of drug_delivery, infusion, sampling, microdialysis, cerebrospinal_fluid_access, other | Primary purpose of the implanted cannula. | |
fixationMethod | Fixation method | choice | one of dental_cement, screws_and_cement, adhesive, suture, other | How the cannula was secured. | |
obturatorUsed | Obturator used | yes/no | Whether an obturator or dummy cannula was inserted after implantation. | ||
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | Sterilization technique used prior to implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
Cannula (Cannula) | yes | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | ||
Obturator (Obturator) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
targetSite | Target site | choice | yes | one of jugular_vein, femoral_vein, carotid_artery, lateral_ventricle, third_ventricle, intrathecal_spinal_cord, cisterna_magna, peritoneal_cavity, other | Anatomical target of the catheter. |
catheterType | Catheter type | text | Model or description of the catheter (e.g., PE-10, Silastic). | ||
material | Material | text | Material of the catheter tubing. | ||
purpose | Purpose | choice | one of infusion, sampling, pressure_monitoring, drug_delivery, other | Primary purpose of the catheter implant. | |
fixationMethod | Fixation method | choice | one of sutures, dental_cement, epoxy, tissue_glue, subcutaneous_tunnel, other | How the catheter was secured to the body or skull. | |
externalPort | External port | choice | one of head_mounted, back_mounted, tail_mounted, subcutaneous, none | Where the external port or connector was positioned. | |
deviceIdentifier | Device identifier | text | 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. | ||
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
Catheter (Catheter) | yes | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | ||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
ECG implant (Electrocardiography)
- type code
EcgImplant· version 4.0.0 · schema
Placement of electrodes used to record the electrical activity of the heart.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
wireCount | Wire count | integer | ≥ 1 | Number of ECG wires implanted. | |
wireMaterial | Wire material | text | Material used for ECG wire leads. | ||
wireInsulation | Wire insulation type | choice | one of teflon, polyimide, silicone, none, other | Insulation material covering the wire shaft, excluding the exposed recording tip. | |
implantSite | Implant site | text | Where the ECG electrodes were implanted — e.g., ‘chest wall’, ‘right shoulder’, ‘left hindlimb’, or ‘subcutaneous over heart’. | ||
fixationMethod | Anchoring method | choice | yes | one of sutured, subcutaneous_tunnel, tissue_glue, headcap, cemented_to_skull, other | How the ECG wires were fixed in place to prevent movement. |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | Sterilization technique used for ECG components. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ElectrodeAssembly (ECG electrode assembly) | yes | ElectrodeComponent, SingleWireElectrode, ConsumableDevice | ElectrodeComponent, SingleWireElectrode, ConsumableDevice | yes | ||
GroundElectrode (Ground electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
placementLayer | Placement layer | choice | one of epidural, subdural, epicranial | Which tissue layer the array was laid on: the dura, the brain surface after opening the dura, or the bone. | |
duraHandling | Dura handling | choice | one of left_intact, punctured, incised, excised | How 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. | |
skullPreparation | Skull preparation | multi-select | one of cleaned, periosteum_removed, roughened, dried, etched, primed, none; format select2 | How the skull was prepared before attachment; select every step that was carried out. | |
arrayAdhesion | Array adhesion | choice | one of none, tissue_adhesive, cement_at_margin, sutured_to_dura, other | How the array itself was held on the surface; how the connector was anchored goes under fixation method. | |
groundPlacement | Ground placement | choice | one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, none, other | Where the ground screw or wire was placed on the animal in this surgery. | |
referencePlacement | Reference placement | choice | one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, on_array, none, other | Where the reference was placed in this surgery; on the array means a dedicated contact of the array itself. | |
groundReferenceTied | Ground and reference tied | yes/no | Check this if the ground and the reference were joined together on the animal. | ||
fixationMethod | Fixation method | multi-select | one of dental_cement, acrylic, uv_cured_resin, super_glue, epoxy, screws, headcap, custom_holder, none, other; format select2 | How the skull-borne assembly (connector and ribbon root) was held to the skull; select every method that contributed. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
EcogArray (ECoG array) | yes | EcogArray | EcogArrayDesign | yes | ||
ReferenceElectrode (Reference electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
GroundElectrode (Ground electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
ShieldingMaterial (Shielding material) | ImplantMaterial, ConsumableDevice | ImplantMaterial, ConsumableDevice | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
wireCount | Wire count | integer | yes | ≥ 1; default 1 | Number of electrodes used for EEG recording. |
electrodeType | Electrode type | choice | yes | one of skull_screw, flat_wire, disc, custom, other | Form factor of the EEG electrode, e.g., skull screws or flat metal contacts. |
electrodeMaterial | Electrode material | text | yes | Material used in the electrode. Common choices include stainless steel and Ag/AgCl. | |
fixationMethod | Anchoring method | choice | yes | one of dental_cement, screws, acrylic, uv_cured_resin, headcap, other | How the EEG electrodes were secured in place. |
shielding | Faraday shielding | choice | one of none, copper_mesh, conductive_paint, aluminum_foil, headcap_integrated, other | Whether and how the EEG implant was shielded from external noise. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | How the EEG components were sterilized before implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ElectrodeAssembly (EEG electrode assembly) | yes | ElectrodeComponent, SingleWireElectrode, ConsumableDevice | ElectrodeComponent, SingleWireElectrode, ConsumableDevice | yes | ||
ReferenceElectrode (Reference electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
GroundElectrode (Ground electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
ShieldingMaterial (Shielding material) | ImplantMaterial, ConsumableDevice | ImplantMaterial, ConsumableDevice | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
EMG implant (Electromyography)
- type code
EmgImplant· version 3.1.0 · schema
Placement of electrodes in or on muscles to record muscle electrical activity.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
wireCount | Wire count | integer | yes | ≥ 1; default 1 | Number of implanted EMG wires (typically one or two per muscle). |
wireMaterial | Wire material | text | Material used for the EMG wires. Stainless steel is common in rodents. | ||
wireInsulation | Wire insulation type | choice | one of teflon, polyimide, silicone, none, other | Type of insulation around the wire shaft, except at exposed recording tip. | |
muscleTargets | Target muscles | text | List of muscles where EMG wires were implanted (e.g., neck, diaphragm, masseter, forelimb biceps). | ||
implantMethod | Implant method | choice | yes | one of direct_insertion, needle_guided, subcutaneous_tunnel, sutured, other | How the wire was placed into the muscle. |
fixationMethod | Anchoring method | choice | one of sutured_to_muscle, cemented_to_skull, subcutaneous_tunnel, tissue_glue, headcap, other | How the wires were fixed to prevent displacement during recovery or recording. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | Sterilization technique applied before implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).- Fields hidden by the web form for this type (leave empty):
coordinates,coordinates_json.
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ElectrodeAssembly (EMG electrode assembly) | yes | ElectrodeComponent, SingleWireElectrode, ConsumableDevice | ElectrodeComponent, SingleWireElectrode, ConsumableDevice | yes | ||
ReferenceElectrode (Reference electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
GroundElectrode (Ground electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
implantType | Implant type | choice | yes | one of sensor, electrode, optical_device, mechanical_device, fluidic_device, structural_support, other | General category or function of the implant. This helps classify the implant for downstream filtering and interpretation. |
implantName | Implant name or description | text | A short name or description of the implant (e.g., ‘custom probe’, ‘prototype sensor’, ‘flex circuit’). | ||
insertionRate | Insertion rate | quantity 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. | |
fixationMethod | Anchoring method | choice | one of sutured, tissue_glue, subcutaneous_tunnel, dental_cement, headcap, custom_mount, none, other | How the implant was secured in place. | |
signalTransmission | Signal transmission | choice | one of tethered, wireless, telemetric, optical, none, other | How the implant communicates data (if applicable). | |
powerSource | Power source | choice | one of battery, inductive, wired, passive, none, other | How the implant is powered, if relevant. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | Sterilization technique used prior to implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
GenericDevice (Other implanted device) | yes | ConsumableDevice, EcogArray, ElectrodeComponent, ImplantMaterial, OpticFiber, OpticalComponent, SiliconProbe, SingleWireElectrode | ConsumableDevice, EcogArrayDesign, ElectrodeComponent, ImplantMaterial, OpticFiberDesign, OpticalComponent, SiliconProbeDesign, SingleWireElectrode | yes | ||
FixedPositioningAssembly (Fixed implant carrier or shuttle) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ManualMicrodrive (Manual microdrive) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
MotorizedMicrodrive (Motorized microdrive) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ReferenceElectrode (Reference electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
GroundElectrode (Ground electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
Obturator (Obturator) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ShieldingMaterial (Shielding material) | ImplantMaterial, ConsumableDevice | ImplantMaterial, ConsumableDevice | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
insertionRate | Insertion rate | quantity 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. | |
fixationMethod | Mounting method | choice | one of cement_only, cement_baseplate, headcap_integrated, custom_holder, other | How the GRIN lens was secured in place after implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
GrinLens (GRIN lens) | yes | OpticalComponent, ConsumableDevice | OpticalComponent, ConsumableDevice | yes | ||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
Nerve cuff implant
- type code
NerveCuffImplant· version 5.0.0 · schema
Placement of a cuff electrode around a peripheral nerve for recording or stimulation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
cuffType | Cuff type | choice | yes | one of monopolar, bipolar, tripolar, multi_contact, split_ring, spiral, other | Configuration and geometry of the cuff. Common types include bipolar and tripolar configurations. |
targetNerve | Target nerve | text | Name or anatomical label of the nerve the cuff was implanted on (e.g., ‘sciatic’, ‘vagus’, ‘median’, ‘hypoglossal’). | ||
cuffMaterial | Cuff material | text | Base material used for the body of the nerve cuff (e.g., silicone tubing or flexible polymer). | ||
electrodeMaterial | Electrode material | text | Material of the embedded electrode contacts inside the nerve cuff. | ||
fixationMethod | Anchoring method | choice | yes | one of suture_surrounding_tissue, tissue_glue, self_closing_cuff, loose_fit, subcutaneous_tunnel, other | How the cuff was fixed around or near the nerve to prevent displacement. |
wireExitRoute | Wire exit route | choice | one of subcutaneous_tunnel_headcap, abdominal_connector, dorsal_skin_exit, wireless_inductive, other | How the lead wires exited the body or were routed for connection to recording/stimulation equipment. | |
signalTransmission | Signal transmission | choice | one of tethered, wireless, telemetric, optical, none, other | How the signal was transmitted to external devices (e.g., via headstage cable, telemetry). | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | Sterilization technique used prior to implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).- Fields hidden by the web form for this type (leave empty):
coordinates,coordinates_json.
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
NerveCuff (Nerve cuff) | yes | ConsumableDevice, ImplantMaterial, ElectrodeComponent | ConsumableDevice, ImplantMaterial, ElectrodeComponent | yes | ||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
ReferenceElectrode (Reference electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
GroundElectrode (Ground electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
duraHandling | Dura handling | choice | one of left_intact, punctured, incised, excised | How the dura was handled at the entry site; a device driven through intact dura counts as punctured. | |
insertionRate | Insertion rate | quantity 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. | |
skullPreparation | Skull preparation | multi-select | one of cleaned, periosteum_removed, roughened, dried, etched, primed, none; format select2 | How the skull was prepared before attachment; select every step that was carried out. | |
fixationMethod | Fixation method | multi-select | one of dental_cement, acrylic, uv_cured_resin, super_glue, epoxy, screws, headcap, custom_holder, none, other; format select2 | How the finished assembly was held to the skull; select every method that contributed. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
OpticFiber (Implanted optic fiber) | yes | OpticFiber | OpticFiberDesign | yes | ||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial, OpticalComponent | ConsumableDevice, ImplantMaterial, OpticalComponent | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other optic-fiber material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
deviceIdentifier | Device identifier | text | 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. | ||
insertionRate | Insertion rate | quantity 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. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, alcohol, none | Method used to sterilize the prism before implantation. | |
fixationMethod | Mounting method | choice | one of cement_only, cement_baseplate, headcap_integrated, custom_holder, other | How the prism was secured in place after implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
Prism (Prism) | yes | OpticalComponent, ConsumableDevice | OpticalComponent, ConsumableDevice | yes | ||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
Reference electrode implant
- type code
ReferenceElectrodeImplant· version 2.1.0 · schema
Placement of an electrode that supplies a reference signal for other recording electrodes.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
electrodeCount | Electrode count | integer | yes | ≥ 1; default 1 | Number of electrodes in the reference electrode assembly. Typically 1, but multiple electrodes may be used for redundancy or averaging. |
electrodeMaterial | Electrode material | text | yes | default "stainless steel" | Material of the electrode. |
impedance | Impedance | quantity with unit | units kΩ, Ω, MΩ; default {"unit": "kΩ"} | Approximate impedance of the reference electrode at 1 kHz. Lower is typically preferred for stable referencing. | |
electrodeDiameter | Electrode diameter | quantity with unit | units µm, mm, nm, m; default {"unit": "µm"} | Diameter of electrode. Affects flexibility, durability, and impedance. | |
placementSite | Placement site | text | Where the reference electrode was implanted or placed (e.g., cerebellum, skull surface, contralateral cortex, subcutaneous). | ||
insertionRate | Insertion rate | quantity 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. | |
fixationMethod | Anchoring method | choice | one of dental_cement, tissue_glue, bone_screw, subcutaneous_tunnel, other | How the reference electrode was secured in place. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ElectrodeAssembly (Electrode assembly) | ElectrodeComponent, SingleWireElectrode, ConsumableDevice | ElectrodeComponent, SingleWireElectrode, ConsumableDevice | yes | |||
ReferenceElectrode (Reference electrode) | yes | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | ||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
duraHandling | Dura handling | choice | one of left_intact, punctured, incised, excised | How the dura was handled at the entry site; a device driven through intact dura counts as punctured. | |
insertionRate | Insertion rate | quantity 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. | |
groundPlacement | Ground placement | choice | one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, none, other | Where the ground screw or wire was placed on the animal in this surgery. | |
referencePlacement | Reference placement | choice | one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, none, other | Where the reference screw or wire was placed on the animal in this surgery. | |
groundReferenceTied | Ground and reference tied | yes/no | Check this if the ground and the reference were joined together on the animal. | ||
fixationMethod | Fixation method | multi-select | one of dental_cement, acrylic, uv_cured_resin, super_glue, epoxy, screws, headcap, custom_holder, none, other; format select2 | How the finished assembly was held to the skull; select every method that contributed. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
SiliconProbe (Silicon probe) | yes | SiliconProbe | SiliconProbeDesign | yes | ||
FixedPositioningAssembly (Fixed probe carrier or shuttle) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ManualMicrodrive (Manual probe microdrive) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
MotorizedMicrodrive (Motorized probe microdrive) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial, SingleWireElectrode | ConsumableDevice, ImplantMaterial, SingleWireElectrode | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
wireCount | Wire count | integer | yes | ≥ 0; default 1 | Number of wires used in the electrode assembly. |
wireDiameter | Wire Diameter | quantity 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. | |
wireMaterial | Wire material | text | Common materials include stainless steel, platinum-iridium, and gold. Material choice affects biocompatibility, conductivity, and overall performance of the electrode. | ||
impedance | Impedance | quantity 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. | |
insertionRate | Insertion rate | quantity 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. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, alcohol, none | Sterilization technique used prior to implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
SingleWireElectrode (Single-wire electrode) | yes | SingleWireElectrode, ConsumableDevice | SingleWireElectrode, ConsumableDevice | yes | ||
FixedPositioningAssembly (Fixed electrode carrier or shuttle) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ManualMicrodrive (Manual electrode microdrive) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
MotorizedMicrodrive (Motorized electrode microdrive) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
Temperature sensor implant
- type code
TemperatureSensorImplant· version 5.0.0 · schema
Placement of a sensor used to monitor body or tissue temperature.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sensorType | Sensor type | choice | yes | one of thermocouple, thermistor, digital_ic, telemetric, passive_logger, fiber_optic, other | Type of temperature sensor implanted. Examples include thermocouples, telemetry sensors, or passive loggers. |
wireMaterial | Wire or lead material | text | Material of the sensor leads, if applicable. Thermocouples often use copper or constantan. | ||
fixationMethod | Anchoring method | choice | yes | one of sutured, tissue_glue, subcutaneous_tunnel, cemented_to_skull, headcap, free_floating, other | How the sensor or wires were secured at the implantation site. |
signalTransmission | Signal transmission | choice | one of tethered, wireless, telemetric, optical, retrieved_logger, none, other | How temperature data is retrieved. ‘Logger (retrieved)’ refers to onboard storage until post hoc download. | |
powerSource | Power source | choice | one of battery, inductive, wired, passive, none, other | How the temperature sensor is powered, if applicable. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, alcohol, gamma_irradiation, none | Sterilization technique used before implantation. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
TemperatureSensor (Temperature probe or sensor) | yes | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | ||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
tetrodeCount | Tetrode count | integer | yes | ≥ 1 | Number of tetrodes loaded on the drive at implant, as built. |
nWiresTetrode | Wires per tetrode | integer | ≥ 1 | Wires twisted into each tetrode as built: 4 for a tetrode, 2 for a stereotrode. | |
duraHandling | Dura handling | choice | one of left_intact, punctured, incised, excised | How the dura was handled at the entry site; a bundle driven through intact dura counts as punctured. | |
insertionRate | Insertion rate | quantity 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. | |
groundPlacement | Ground placement | choice | one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, none, other | Where the ground screw or wire was placed on the animal in this surgery. | |
referencePlacement | Reference placement | choice | one of cerebellum, frontal_bone, parietal_bone, neck_muscle, subcutaneous, in_bundle, none, other | Where the reference was placed: a skull screw or wire, or a reference tetrode within the bundle. | |
groundReferenceTied | Ground and reference tied | yes/no | Check this if the ground and the reference were joined together on the animal. | ||
fixationMethod | Fixation method | multi-select | one of dental_cement, acrylic, uv_cured_resin, super_glue, epoxy, screws, headcap, custom_holder, none, other; format select2 | How the drive was held to the skull; select every method that contributed. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ElectrodeAssembly (Tetrode assembly) | yes | SingleWireElectrode, ElectrodeComponent, ConsumableDevice | SingleWireElectrode, ElectrodeComponent, ConsumableDevice | yes | ||
FixedPositioningAssembly (Fixed electrode carrier or shuttle) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ManualMicrodrive (Manual electrode microdrive) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
MotorizedMicrodrive (Motorized electrode microdrive) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
ReferenceElectrode (Reference electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
GroundElectrode (Ground electrode) | ElectrodeComponent, SingleWireElectrode | ElectrodeComponent, SingleWireElectrode | yes | |||
ConnectorComponent (Connector component) | ConnectorComponent | ConnectorComponent | yes | |||
OtherComponent (Other implant component) | ConsumableDevice, ImplantMaterial | ConsumableDevice, ImplantMaterial | yes | |||
AdhesiveSealant (Adhesive, cement, or sealant) | AdhesiveCement | AdhesiveCement | yes | |||
Fastener (Anchor screw, pin, or fastener) | FastenerAnchor | FastenerAnchor | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes | |||||
Coating (Coating) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes |
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Injection Volume | quantity with unit | units L, mL, µL, nL, pL; default {"unit": "mL"} | The total volume of the solution injected. | |
rate | Injection rate | quantity with unit | units mL/s, µL/s, mL/min, µL/min; default {"unit": "mL/s"} | Rate at which the solution is injected. | |
concentration | Concentration of solution | quantity 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. | |
injectionMethod | Injection Method | choice | one of icv, im, iv, id, sc, ic, ip, it, epidural, retro_orbital, intranasal, intra_articular, intravitreal, intralesional | Defines the injection method. | |
injectionProfile | Injection profile | choice | one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titration | Describes the injection profile. | |
insertionRate | Insertion rate | quantity 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. | |
laterality | Injection side (brain hemisphere or body side) | choice | one of left, right, midline, unknown | Which side of the brain or body the injection targets. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
DeliveredComponent (Injected component) | PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution, TracerDye | PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution, TracerDye | yes | Applied dose, mass, concentration, or dilution, Applied volume | ||
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
StainDye (Stain or dye) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | |||
NeuralTracer (Neural tracer) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | Applied concentration, dilution, or mass, Applied volume | ||
CellSuspension (Cell suspension) | BiologicalMaterial | BiologicalMaterial | yes | Applied cell count or concentration, Applied volume | ||
ParticleSuspension (Particle suspension) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | Applied particle count or concentration, Applied volume | ||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Injection volume | quantity with unit | units nL, µL, mL, L; default {"unit": "nL"} | The total volume of the viral solution injected. | |
rate | Injection rate | quantity 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. | |
injectionProfile | Injection profile | choice | one of bolus_injection, continuous_infusion, intermittent_bolus, ramp_infusion, step_infusion | Shape the delivery took over time, within a single infusion. | |
route | Injection route | choice | one of intraparenchymal, icv, intracisternal, it, iv, retro_orbital, ip, im, subretinal, other | Anatomical route the vector entered by; intraparenchymal is into the tissue itself, while systemic routes reach the brain only through the circulation. | |
insertionRate | Insertion rate | quantity 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. | |
postInfusionDwell | Post-infusion dwell | quantity 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. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
ViralComponent (Viral-vector preparation) | yes | VirusSolution | VirusConstruct | yes | Applied volume, Effective delivered titer | |
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
ActiveAgent (Other active agent) | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | |||
StainDye (Stain or dye) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | |||
NeuralTracer (Neural tracer) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | |||
SurgicalSupply (Injection supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
collectionSite | Collection site | choice | yes | one of tail_vein, saphenous_vein, facial_vein, submandibular_vein, retro_orbital_sinus, jugular_vein, femoral_vein, cardiac_puncture, trunk, other | Anatomical site used for blood collection. |
collectionMethod | Collection method | choice | one of venipuncture, lancet, capillary_tube, catheter, other | Method used to collect the blood sample. | |
volume | Sample volume | quantity with unit | units mL, µL, L; default {"unit": "µL"} | Approximate volume of blood collected. | |
samplePurpose | Sample purpose | choice | one of hematology, plasma_serum, biochemistry, pharmacokinetics, genotyping, other | Primary downstream use of the blood sample. | |
postMortemCollection | Post-mortem collection | yes/no | Whether the sample was taken after the animal was already dead, rather than from a living animal. | ||
storageConditions | Storage conditions | text | Storage or handling conditions before processing. | ||
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
Anticoagulant (Anticoagulant) | PharmacologicalAgent, PhysiologicalSolution, ChemicalReagent | PharmacologicalAgent, PhysiologicalSolution, ChemicalReagent | yes | |||
CollectionAdditive (Collection additive) | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | |||
CollectionContainer (Collection container) | SurgicalDisposable, ConsumableDevice | SurgicalDisposable, ConsumableDevice | yes | |||
StorageMedium (Storage medium) | PhysiologicalSolution, HistologyReagent | PhysiologicalSolution, HistologyReagent | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
collectionSite | Collection site | choice | yes | one of tail_tip, ear_punch, skin_biopsy, muscle_biopsy, organ_biopsy, tumor_biopsy, other | Anatomical source of the collected tissue. |
collectionMethod | Collection method | choice | one of snip, punch, biopsy, excision, scraping, other | Method used to collect the tissue sample. | |
sampleLength | Sample length | quantity with unit | units mm, cm, µm; default {"unit": "mm"} | Approximate sample length, useful for tail-tip or similar samples. | |
sampleMass | Sample mass | quantity with unit | units g, mg, µg; default {"unit": "mg"} | Approximate mass of the tissue collected. | |
samplePurpose | Sample purpose | choice | one of genotyping, histology, molecular_analysis, cell_culture, pathology, other | Primary downstream use of the tissue sample. | |
preservationMethod | Preservation method | choice | one of fresh, ethanol, rnalater, paraformaldehyde_fixation, formalin_fixation, flash_freezing, liquid_nitrogen, dry_ice, other | Method used to preserve the collected tissue. | |
postMortemCollection | Post-mortem collection | yes/no | Whether the sample was taken after the animal was already dead, rather than from a living animal. | ||
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
SurgicalSupply (Collection supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Anticoagulant (Anticoagulant) | PharmacologicalAgent, PhysiologicalSolution, ChemicalReagent | PharmacologicalAgent, PhysiologicalSolution, ChemicalReagent | yes | |||
Medium (Collection medium) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
StorageMedium (Initial storage medium) | PhysiologicalSolution, HistologyReagent | PhysiologicalSolution, HistologyReagent | yes | |||
CollectionContainer (Collection container) | SurgicalDisposable, ConsumableDevice | SurgicalDisposable, ConsumableDevice | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
extractionMethod | Extraction method | choice | yes | one of complete_removal, partial_removal, sectional_removal, other | Method used for brain extraction. |
timeToExtraction | Time to Extraction | quantity with unit | units s, min, h, ms; default {"unit": "min"} | Time from euthanasia to brain extraction. Important for tissue quality. | |
brainWeight | Brain Weight | quantity with unit | units g, kg, mg, µg; default {"unit": "g"} | Weight of the extracted brain in grams. | |
preservationMethod | Preservation method | choice | yes | one of fresh, paraformaldehyde_fixation, formalin_fixation, flash_freezing, liquid_nitrogen, dry_ice, other | Method used to preserve the extracted brain tissue. |
fixationDuration | Fixation duration | quantity with unit | units s, min, h, ms; default {"unit": "h"} | Duration of fixation in hours (if applicable). | |
storageConditions | Storage Conditions | text | 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_systemaccepts 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
Medium (Processing medium) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
StorageMedium (Storage medium) | PhysiologicalSolution, HistologyReagent | PhysiologicalSolution, HistologyReagent | yes | |||
CollectionContainer (Collection container) | SurgicalDisposable, ConsumableDevice | SurgicalDisposable, ConsumableDevice | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
lesionMethod | Lesion method | text | Specify the technique used to induce the brain lesion (e.g., surgical, suction, chemical, thermal, etc.). | ||
volume | Volume of brain lesion | quantity with unit | units µL, mL, L, nL; default {"unit": "µL"} | Enter the estimated or calculated volume of the brain lesion. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; other values are refused (400).
Materials (material usage rows) allowed on this type:
Role (type) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
LesionAgent (Lesion agent) | PharmacologicalAgent, ChemicalReagent | PharmacologicalAgent, ChemicalReagent | yes | |||
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
StainDye (Stain or dye) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | |||
NeuralTracer (Neural tracer) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | Applied concentration, dilution, or mass, Applied volume | ||
ParticleSuspension (Particle suspension) | TracerDye, ChemicalReagent | TracerDye, ChemicalReagent | yes | Applied particle count or concentration, Applied volume | ||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
route | Vascular access route | choice | one of intracardiac, carotid, intra_aortic, intracranial, other | Where the perfusate entered the circulation. | |
perfusionScope | Perfusion scope | choice | one of whole_body, head_only, other | How far the perfusate was carried through the animal. | |
perfusionDrive | Perfusion drive | choice | one of gravity_feed, peristaltic_pump, syringe_pump, pressurized_line, manual_syringe, other | What pushed the perfusate through the circulation. | |
pressure | Perfusion pressure | quantity 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. | |
heartBeatingAtStart | Heart beating at start | yes/no | Check this if the heart was still beating when the perfusate first entered the circulation. | ||
phases | Perfusion phases | table of rows | format table | Each 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[].phase | Phase | choice | yes | one of wash, fixative, other | What 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[].volume | Volume | quantity 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[].flowRate | Rate | quantity 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[].duration | Duration | quantity 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[].temperature | Temperature | quantity with unit | units °C; default {"unit": "°C"} | Temperature of the solution delivered in this phase. | |
completionSigns | Signs of completion | multi-select | one of liver_blanching, clear_effluent, fixation_tremor, tissue_rigidity, pale_brain; format select2 | Which conventional signs that the perfusion was working were actually seen. | |
failureMode | Failure modes | multi-select | one of clotting, cannula_misplaced, atrium_not_opened, oedema, circuit_leak, air_embolism, residual_blood, other; format select2 | What went wrong, if anything; tick every fault that applied. Leave empty if nothing went wrong. | |
confirmationOfDeath | Confirmation of death | multi-select | one of absence_of_heartbeat, absence_of_breathing, absence_of_reflexes, fixed_dilated_pupils, loss_of_corneal_reflex, other; format select2 | How death was verified at the end of the perfusion. Tick every check that was made; verification normally combines more than one. | |
fatalOutcome | Fatal outcome | choice | one of not_fatal, planned_terminal, unintended_death | Whether 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"
}
coordinates_systemaccepts Coordinates types:Stereotaxic_BregmaBrainSurface,Stereotaxic_LambdaBrainSurface,Landmark_APML_SurfaceDepth,Spinal_RCML_SurfaceDepth,CCF_XYZ_Absolute,WHS_XYZ_Absolute,MNI152_XYZ_Absolute,NMT_XYZ_Absolute,MapZebrain_XYZ_Absolute,JRC2018U_XYZ_Absolute,BMA_XYZ_Absolute,Stereotaxic_BregmaAbsolute,Stereotaxic_LambdaAbsolute,Landmark_APMLDV_Absolute,Spinal_RCMLDV_Absolute; 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
WashSolution (Rinse or flush solution) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
Buffer (Perfusion buffer) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
Fixative (Fixative) | yes | HistologyReagent, ChemicalReagent | HistologyReagent, ChemicalReagent | yes | ||
Anticoagulant (Anticoagulant) | PharmacologicalAgent, PhysiologicalSolution, ChemicalReagent | PharmacologicalAgent, PhysiologicalSolution, ChemicalReagent | yes | |||
SurgicalSupply (Perfusion supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other perfusion material) | yes |
Stages:
flush(Flush), no detail schema; repeatablefixation(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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Concentration | quantity with unit | units mg/mL, µg/mL, g/L, mg/L, µg/L; default {"unit": "mg/mL"} | Concentration of the barbiturate solution. | |
dose | Dosage | quantity with unit | units mg/kg, µg/kg, g/kg; default {"unit": "mg/kg"} | Dosage administered per kilogram of body weight. | |
route | Administration route | choice | yes | one of ip, iv, intracardiac, sc, other | Route of barbiturate administration. |
volume | Volume administered | quantity with unit | units mL, L, µL, nL; default {"unit": "mL"} | Total volume of barbiturate solution administered. | |
timeToUnconsciousness | Time to unconsciousness | quantity with unit | units s, min, h, ms; default {"unit": "s"} | Observed time to loss of consciousness. | |
confirmationOfDeath | Confirmation of death | multi-select | yes | one of heartbeat_absent, breathing_absent, reflexes_absent, pupils_fixed_dilated, corneal_reflex_absent, additional_dose, other; format select2 | Methods used to confirm death. |
Illustrative payload:
{
"route": "ip",
"confirmationOfDeath": [
"heartbeat_absent"
],
"concentration": {
"value": 1,
"unit": "mg/mL"
},
"dose": {
"value": 1,
"unit": "mg/kg"
}
}
coordinates_systemaccepts 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
InjectedEuthanasiaAgent (Injected euthanasia agent) | yes | PharmacologicalAgent | PharmacologicalAgent | yes | Applied dose or concentration | |
PharmacologicalAdjuvant (Pharmacological adjunct) | PharmacologicalAgent | PharmacologicalAgent | yes | |||
Vehicle (Vehicle) | PhysiologicalSolution, ChemicalReagent | PhysiologicalSolution, ChemicalReagent | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes |
Cervical dislocation
- type code
CervicalDislocation· version 2.0.3 · schema
A physical method involving separation of the cervical vertebrae.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dislocationMethod | Method of dislocation | choice | yes | one of manual, mechanical_device, scissor_method, other | Method used for cervical dislocation. |
confirmationOfDeath | Confirmation of death | multi-select | yes | one of absence_of_heartbeat, absence_of_breathing, absence_of_reflexes, fixed_dilated_pupils, loss_of_corneal_reflex, other; format select2 | Methods used to confirm death. |
Illustrative payload:
{
"dislocationMethod": "manual",
"confirmationOfDeath": [
"absence_of_heartbeat"
]
}
coordinates_systemaccepts 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
co2Concentration | CO₂ concentration | quantity with unit | yes | units %, ppm, ppb; default {"unit": "%"} | Concentration of CO₂ used in the chamber. |
rate | CO₂ Flow Rate | quantity with unit | units L/min, mL/min, L/s, mL/s; default {"unit": "L/min"} | Rate of CO₂ flow into the chamber. | |
exposureDuration | Exposure Duration | quantity with unit | yes | units s, min, h, ms; default {"unit": "min"} | Duration of CO₂ exposure. |
timeToUnconsciousness | Time to unconsciousness | quantity with unit | units s, min, h, ms; default {"unit": "s"} | Observed time to loss of consciousness. | |
prefillingMethod | Chamber prefilling | choice | one of not_prefilled, partially_prefilled, fully_prefilled, other | Method of chamber prefilling with CO₂. | |
chamberVolume | Chamber volume | quantity with unit | units L, mL, µL; default {"unit": "L"} | Volume of the euthanasia chamber. | |
gradualIntroduction | Gradual CO₂ introduction | yes/no | Check if CO₂ was introduced gradually (recommended for animal welfare). | ||
confirmationOfDeath | Confirmation of death | multi-select | yes | one of absence_of_heartbeat, absence_of_breathing, absence_of_reflexes, fixed_dilated_pupils, loss_of_corneal_reflex, continued_co2_exposure, other; format select2 | Methods 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_systemaccepts 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
InhaledEuthanasiaAgent (Inhaled euthanasia agent) | yes | MedicalGas | MedicalGas | yes | ||
CarrierGas (Carrier gas) | MedicalGas | MedicalGas | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
decapitationMethod | Decapitation Method | choice | yes | one of guillotine, sharp_scissors, surgical_blade, other | Method/instrument used for decapitation. |
Illustrative payload:
{
"decapitationMethod": "guillotine"
}
coordinates_systemaccepts 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes |
Inhalant overdose
- type code
InhalantOverdose· version 5.0.0 · schema
Euthanasia using an overdose of an inhalant anesthetic.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Concentration | quantity with unit | units % v/v; default {"unit": "% v/v"} | Concentration of anesthetic agent used. | |
rate | Oxygen flow rate | quantity with unit | units L/min, mL/min, mL/s; default {"unit": "L/min"} | Flow rate of oxygen or carrier gas. | |
deliveryMethod | Delivery method | choice | one of anesthesia_chamber, nose_cone, intubation, bell_jar, other | Method used to deliver the anesthetic agent. | |
exposureDuration | Exposure duration | quantity with unit | units µs, ms, s, min, h; default {"unit": "min"} | Duration of anesthetic exposure. | |
timeToUnconsciousness | Time to unconsciousness | quantity with unit | units µs, ms, s, min, h; default {"unit": "s"} | Observed time to loss of consciousness. | |
confirmationOfDeath | Confirmation of death | multi-select | one of heartbeat_absent, breathing_absent, reflexes_absent, pupils_fixed_dilated, corneal_reflex_absent, continued_exposure, other; format select2 | Methods used to confirm death. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "% v/v"
},
"rate": {
"value": 1,
"unit": "L/min"
}
}
coordinates_systemaccepts 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) | Required | Max | From stock types | From catalog types | Manual | Complete when |
|---|---|---|---|---|---|---|
InhaledEuthanasiaAgent (Inhaled euthanasia agent) | yes | PharmacologicalAgent, MedicalGas | PharmacologicalAgent, MedicalGas | yes | ||
CarrierGas (Carrier gas) | MedicalGas | MedicalGas | yes | |||
SurgicalSupply (Surgical supply) | SurgicalDisposable | SurgicalDisposable | yes | |||
Other (Other material) | yes |