Consumable schemas
Type-specific details of consumables in the shared catalog, such as probe designs and virus constructs.
Table of contents
- How to use this family
- Quick type map
- Reagents and Solutions
- Device-Linked Consumables
- Surgical Consumables
- External Identifiers
How to use this family
consumable: settypeto a type code below and send its properties indetails.consumableapproval:typeselects the type; each log entry added through the entry actions is validated against it.- Every version is published at
https://www.brainstem.org/schemas/Consumable/<Type>/<version>.jsonand never changes;https://www.brainstem.org/schemas/Consumable/<Type>.jsonis the current version andhttps://www.brainstem.org/schemas/Consumable/<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 |
|---|---|---|---|---|---|
AdhesiveCement | Adhesive or cement | Surgical Consumables | 1.0.3 | subtype | 1.0.3.json |
BiologicalMaterial | Biological material | Reagents and Solutions | 1.0.0 | materialClass | 1.0.0.json |
ChemicalReagent | Chemical reagent | Reagents and Solutions | 3.0.2 | chemicalType | 3.0.2.json |
ConnectorComponent | Connector component | Device-Linked Consumables | 1.0.3 | connectorClass | 1.0.3.json |
ConsumableDevice | Consumable device | Device-Linked Consumables | 4.0.3 | deviceClass | 4.0.3.json |
EcogArrayDesign | ECoG array design | Device-Linked Consumables | 1.0.0 | nPhysicalSites, nChannels | 1.0.0.json |
ElectrodeComponent | Electrode component | Device-Linked Consumables | 1.0.2 | electrodeRole | 1.0.2.json |
ExternalIdentifiers | External Identifiers (form only) | 1.0.0 | source, id | 1.0.0.json | |
FastenerAnchor | Fastener or anchor | Surgical Consumables | 1.0.2 | subtype | 1.0.2.json |
HistologyReagent | Histology reagent | Reagents and Solutions | 1.0.2 | reagentRole | 1.0.2.json |
ImmunoReagent | Antibody or immunoreagent | Reagents and Solutions | 2.0.4 | targetAntigen, reagentType | 2.0.4.json |
ImplantMaterial | Implant or fixation material | Surgical Consumables | 3.0.2 | subtype | 3.0.2.json |
MedicalGas | Medical or carrier gas | Reagents and Solutions | 1.0.2 | gasType | 1.0.2.json |
OpticFiberDesign | Optic fiber design | Device-Linked Consumables | 1.1.1 | fiberType, coreDiameter | 1.1.1.json |
OpticalComponent | Optical component | Device-Linked Consumables | 2.0.4 | componentType | 2.0.4.json |
PharmacologicalAgent | Pharmacological agent | Reagents and Solutions | 3.0.4 | activeIngredient, pharmacologicalCategory | 3.0.4.json |
PhysiologicalSolution | Physiological solution | Reagents and Solutions | 2.0.4 | composition | 2.0.4.json |
SiliconProbeDesign | Silicon probe design | Device-Linked Consumables | 3.0.1 | nShanks, nChannels | 3.0.1.json |
SingleWireElectrode | Single wire electrode | Device-Linked Consumables | 1.1.1 | none | 1.1.1.json |
SurgicalDisposable | Surgical disposable | Surgical Consumables | 3.0.2 | subtype | 3.0.2.json |
TracerDye | Tracer or dye | Reagents and Solutions | 3.0.4 | dyeType | 3.0.4.json |
VirusConstruct | Virus construct | Reagents and Solutions | 2.0.0 | none | 2.0.0.json |
Reagents and Solutions
Biological material
- type code
BiologicalMaterial· version 1.0.0 · schema
A cell line, pluripotent stem cell line, primary-cell product, organoid line, hybridoma or tissue product, as the supplier or repository describes it. Sera, matrices and purified proteins are reagents; viral vectors are Virus constructs.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number of the line or product as the supplier or repository writes it. | ||
materialClass | Kind of material | choice | yes | one of cell_line, induced_pluripotent_stem_cell, embryonic_stem_cell, primary_cells, organoid_line, hybridoma, tissue, other | What the material is, as the repository classes it. |
speciesOfOrigin | Species of origin | text | Species the material derives from, as the repository names it. | ||
strainOfOrigin | Strain of origin | text | Strain or genetic background of the donor animal, as the supplier names it. | ||
tissueOfOrigin | Tissue of origin | text | Tissue the cells were taken from, as the repository names it. | ||
cellType | Cell type | text | Cell type the product consists of, as the supplier states it. | ||
donorAge | Donor age at sampling | text | Age of the donor at sampling as the repository codes it, reference point included (E18, P7, 16FW, 48Y). | ||
donorSex | Donor sex | choice | one of male, female, mixed, unknown | Sex of the donor as declared; mixed for pooled preparations. | |
disease | Disease | text | Disease the donor carries or the line models, named with the registry’s term. | ||
reprogrammingMethod | Reprogramming method | choice | one of sendai_virus, episomal, lentivirus, retrovirus, mrna, protein, other, not_applicable | How an induced pluripotent line was reprogrammed; not applicable for other kinds. | |
geneticModification | Genetic modification | text | Engineered modification the line carries, including any reporter or selection marker, as the generator states it. | ||
growthMode | Growth mode | choice | one of adherent, suspension, semi_adherent, three_dimensional | How the line grows in culture, as the repository declares it. | |
biosafetyLevel | Biosafety level | choice | one of bsl_1, bsl_2, bsl_3, unknown | Biosafety level the material requires, as the repository declares it. | |
cellsPerUnit | Viable cells per vial or unit (nominal) | integer | ≥ 0 | Viable cells per vial or unit as sold, taken from the supplier’s datasheet (nominal). |
Illustrative payload:
{
"materialClass": "cell_line",
"productId": "text",
"speciesOfOrigin": "text"
}
Chemical reagent
- type code
ChemicalReagent· version 3.0.2 · schema
A defined laboratory chemical bought as a compound, such as a salt, detergent, buffer component or solvent. Use Pharmacological agent for a drug made to act on a subject, and Histology reagent for fixatives, clearing agents and mounting media.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog or supplier product code (e.g., ‘T8787’, ‘P6148’). | ||
compoundName | Compound Name | text | Name of the chemical (e.g., ‘Triton X-100’, ‘Paraformaldehyde’). | ||
chemicalType | Chemical Type | choice | yes | one of detergent, enzyme, indicator_ph_adjuster, salt_buffer, solvent, stain_dye, other | General laboratory chemicals. Tissue-processing reagents (fixatives, clearing, embedding and mounting media) belong to the Histology reagent type. |
concentration | Concentration / Strength | text | If supplied in solution (e.g., ‘4%’, ‘1 M’, ‘10X’). | ||
molecularWeight | Molecular Weight | quantity with unit | units g/mol, kg/mol, Da, kDa; default {"unit": "g/mol"} | Molecular weight of the chemical compound. | |
purity | Purity / Grade | text | E.g., ‘≥99%’, ‘Analytical grade’, ‘ACS reagent’. | ||
storageConditions | Storage Conditions | text | E.g., ‘Room temp’, ‘4°C’, ‘Protect from light’. | ||
hazardInfo | Hazard Information | text | Optional summary of safety hazards or GHS classification. | ||
experimentalUse | Experimental Use Context | text (multi-line) | Typical use cases for the reagent in experimental workflows (e.g. Perfusion, Fixation, Staining, Buffering) |
Illustrative payload:
{
"chemicalType": "detergent",
"productId": "text",
"compoundName": "text"
}
Histology reagent
- type code
HistologyReagent· version 1.0.2 · schema
A reagent made for processing tissue after it leaves the subject, such as a fixative, permeabilization or clearing agent, or an embedding or mounting medium. Antibodies are Antibody or immunoreagent, and stains and dyes are Tracer or dye.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference. | ||
reagentRole | Processing Role | choice | yes | one of fixative, cryoprotectant, dehydration_reagent, clearing_reagent, index_matching_medium, permeabilization_reagent, antigen_retrieval_reagent, blocking_reagent, embedding_medium, mounting_medium, decalcification_reagent, other | Where this reagent sits in the tissue-processing chain. |
composition | Composition | text (multi-line) | Active constituents and their concentrations as supplied. | ||
concentration | Concentration | text | Concentration as supplied, before any working dilution. | ||
refractiveIndex | Refractive Index | number | ≥ 0 | Refractive index, for clearing, index-matching, and mounting media. | |
pH | pH | number | ≥ 0 and ≤ 14 | pH as supplied. | |
antifade | Contains Antifade | yes/no | Whether a mounting medium contains an antifade agent. | ||
storageConditions | Storage Conditions | text | Recommended storage conditions. | ||
hazardInfo | Hazard Information | text (multi-line) | Safety and handling information. Many fixatives and clearing reagents are toxic. |
Illustrative payload:
{
"reagentRole": "fixative",
"productId": "text",
"composition": "text"
}
Antibody or immunoreagent
- type code
ImmunoReagent· version 2.0.4 · schema
An antibody or other binding reagent bought to detect a target, such as a primary antibody, a conjugated secondary, a nanobody or a streptavidin conjugate. Dyes and tracers that label without binding a specific target are Tracer or dye.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Supplier product code or catalog number. | ||
targetAntigen | Target Antigen | text | yes | What the reagent binds to (e.g., ‘GFAP’, ‘c-Fos’, ‘NeuN’). | |
reagentType | Reagent Type | choice | yes | one of primary_antibody, secondary_antibody, fluorescent_label, dna_counterstain, other | General classification of the reagent. |
hostSpecies | Host Species | text | Host in which the antibody was raised (e.g., ‘Rabbit’, ‘Mouse’). | ||
reactivity | Reactivity Species | text | Species the antibody is reactive against (e.g., ‘Rat’, ‘Mouse’, ‘Human’). | ||
clonality | Clonality | choice | one of monoclonal, polyclonal, recombinant, unknown | Whether the antibody is monoclonal or polyclonal. | |
conjugate | Conjugated Fluorophore or Enzyme | text | E.g., ‘Alexa Fluor 488’, ‘HRP’, ‘None’. | ||
application | Validated Applications | multi-select | one of ihc, icc, western_blot, flow_cytometry, immunoprecipitation, other; format select2 | Supported or validated experimental applications. | |
dilution | Recommended Dilution | text | Recommended dilution (e.g., ‘1:500’, ‘2 µg/mL’). | ||
storageConditions | Storage Conditions | text | E.g., ‘4°C’, ‘-20°C’, ‘Avoid repeated freeze/thaw cycles’. |
Illustrative payload:
{
"targetAntigen": "text",
"reagentType": "primary_antibody",
"productId": "text",
"hostSpecies": "text"
}
Medical or carrier gas
- type code
MedicalGas· version 1.0.2 · schema
A gas bought for use on subjects or in the rig, such as oxygen, medical air, carbogen, CO₂ or a premixed blend, whether as anesthetic carrier, for euthanasia or to gas a bath. Volatile anesthetics such as isoflurane are Pharmacological agents.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference. | ||
gasType | Gas | choice | yes | one of oxygen, medical_air, carbogen, carbon_dioxide, nitrogen, nitrous_oxide, argon, helium, other | Gas or gas mixture supplied. |
composition | Composition | text | Exact mixture, for blended or custom gases. | ||
purityGrade | Purity Grade | text | Supplier purity or regulatory grade. | ||
supplyForm | Supply Form | choice | one of cylinder, house_line, concentrator, generator, other | How the gas is delivered to the rig. |
Illustrative payload:
{
"gasType": "oxygen",
"productId": "text",
"composition": "text"
}
Pharmacological agent
- type code
PharmacologicalAgent· version 3.0.4 · schema
A drug made to act on a subject or tissue, such as an anesthetic, analgesic, antibiotic or receptor agonist or antagonist. File by what the product is made for: a compound bought for lab chemistry is a Chemical reagent even when it is pharmacologically active.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog or supplier ID (e.g., ‘C2128’). | ||
activeIngredient | Active Ingredient | text | yes | Primary pharmacologically active substance (e.g., ‘Ketamine’, ‘Buprenorphine’, ‘Isoflurane’). | |
concentration | Concentration | text | Stated strength of the active ingredient (e.g., ‘10 mg/mL’, ‘0.1%’, ‘50 µg/tablet’). | ||
dosageForm | Dosage Form | choice | one of solution, suspension, tablet, capsule, injection, topical, patch, other | Physical form in which the drug is supplied. | |
routeOfAdministration | Route of Administration | choice | one of ip, iv, sc, oral, topical, inhalation, intracerebral, other | Typical method of administration in experiments. | |
pharmacologicalCategory | Pharmacological Category | choice | yes | one of analgesic, anesthetic, antibiotic, neuroactive, recreational, vehicle, experimental, other | Broad category of action or use. |
pharmacologicalClass | Pharmacological Class | text | Mechanistic or therapeutic class (e.g., ‘NSAID’, ‘GABA agonist’, ‘NMDA antagonist’). | ||
formulation | Formulation | text | List of excipients, solvents, or carriers (e.g., ‘in 10% DMSO + saline’). | ||
storageConditions | Storage Conditions | text | E.g., ‘4°C’, ‘-20°C’, or ‘Protect from light’. | ||
purity | Purity / Grade | text | E.g., ‘≥98%’, ‘USP’, ‘Analytical grade’. | ||
experimentalUse | Experimental Use Context | multi-select | one of surgical, behavioral, electrophysiology, histology, imaging, other; format select2 | Contexts in which this agent is typically used. |
Illustrative payload:
{
"activeIngredient": "text",
"pharmacologicalCategory": "analgesic",
"productId": "text",
"concentration": "text"
}
Physiological solution
- type code
PhysiologicalSolution· version 2.0.4 · schema
A solution that living tissue or a subject is kept in or given, such as saline, PBS, Ringer’s or aCSF. Use Histology reagent for solutions that fix or process tissue, and Pharmacological agent when the solution is itself a drug.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
composition | Composition | text (multi-line) | yes | Full recipe or formula (e.g., ‘0.9% NaCl in H2O’, ‘aCSF with 10 mM HEPES’). | |
pH | Target pH value | number | ≥ 0 | Target pH value as numeric value (e.g., ‘7.4’). | |
osmolality | Osmolality | text | In mOsm/kg, if known (e.g., ‘300 mOsm’). | ||
storageConditions | Storage Conditions | text | E.g., ‘Room temperature’, ‘4°C’, ‘Frozen’. | ||
preparationInstructions | Preparation Instructions | text (multi-line) | Steps for preparing or dissolving the solution (e.g., buffer components, filter sterilization). | ||
sterile | Sterile | yes/no | Is the solution sterile? | ||
purpose | Purpose / Use | multi-select | one of vehicle, perfusion, fixation, dissection, buffering, storage, slice_preparation, other; format select2 | What is the primary use case for this solution? |
Illustrative payload:
{
"composition": "text",
"pH": 1.0,
"osmolality": "text"
}
Tracer or dye
- type code
TracerDye· version 3.0.4 · schema
A dye or tracer that labels structures or reveals connections without binding a specific antigen, such as a retrograde tracer, a lipophilic dye, a histological stain or an injection marker. Labels delivered genetically by a virus are Virus constructs.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference (e.g., ‘D282’, ‘F347’). | ||
dyeType | Type of Dye or Tracer | choice | yes | one of fluorescent_tracer, lipophilic_dye, retrograde_tracer, anterograde_tracer, histological_dye, vital_stain, injection_marker, other | Function or classification of the dye/tracer. |
fluorophore | Fluorophore | text | Fluorophore or spectral tag used (e.g., ‘Alexa Fluor 555’, ‘FITC’). | ||
routeOfApplication | Route of Application | choice | one of injection, perfusion, topical, incubation, other | How the dye is typically applied. | |
excitationPeak | Excitation Peak | quantity with unit | units nm, µm, mm, m; default {"unit": "nm"} | Peak wavelength for excitation (e.g., 550 nm). | |
emissionPeak | Emission Peak | quantity with unit | units nm, µm, mm, m; default {"unit": "nm"} | Peak wavelength for emission (e.g., 665 nm). | |
solvent | Solvent / Vehicle | text | Solvent used for preparation (e.g., ‘DMSO’, ‘Saline’, ‘Ethanol’). | ||
storageConditions | Storage Conditions | text | E.g., ‘4°C, dark’, ‘-20°C’. | ||
preparationInstructions | Preparation Instructions | text (multi-line) | Preparation or dilution steps before application. | ||
experimentalUse | Experimental Use Context | multi-select | one of circuit_tracing, histology, injection_visualization, vital_staining, other; format select2 | Typical applications of this tracer or dye. |
Illustrative payload:
{
"dyeType": "fluorescent_tracer",
"productId": "text",
"fluorophore": "text"
}
Virus construct
- type code
VirusConstruct· version 2.0.0 · schema
A viral vector as designed, such as an AAV carrying a calcium indicator or an opsin under a cell-type promoter, identified by its plasmid or repository entry. The titered preparation in your freezer is Virus solution stock pointing at this entry.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | A unique identifier for the virus construct as defined by the supplier. | ||
virusType | Virus type | choice | one of adenovirus, lentivirus, aav, retrovirus, hsv, baculovirus | The type of virus used as the vector for gene delivery. | |
capsid | Capsid | text | The protein shell of the virus that encloses its genetic material. Capsid modifications can affect the virus’s targeting and delivery efficiency. | ||
promoter | Promoter | text | The DNA sequence that initiates the transcription of the inserted gene. Different promoters can control the level and location of gene expression. | ||
gene | Gene | text | The gene of interest that is being delivered by the virus. This could be a therapeutic gene, a reporter gene, or any other gene used in research. | ||
reporter | Reporter | text | A reporter gene included in the virus construct that produces an easily observable phenotype for monitoring the expression of the gene of interest. | ||
otherElement | Other element | text | Any additional genetic elements included in the construct such as regulatory sequences, enhancers, or other genes that assist or modify the primary gene’s expression. |
Illustrative payload:
{
"productId": "text",
"virusType": "adenovirus"
}
Device-Linked Consumables
Connector component
- type code
ConnectorComponent· version 1.0.3 · schema
A part that joins an implant to recording or stimulation hardware, such as an electrode interface board, a connector, an adapter, a tether or a commutator. Subject-mounted assemblies such as fiber cannulas are Consumable devices.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference. | ||
connectorClass | Class | choice | yes | one of electrode_interface_board, connector, adapter, cable_assembly, commutator, pin_header, protective_cap, other | Category of interconnect hardware. |
connectorFamily | Connector Family | text | Manufacturer connector series, which determines what it mates with. | ||
contactCount | Contact Count | integer | ≥ 0 | Number of electrical contacts. | |
gender | Gender | choice | one of male, female, hermaphroditic, not_applicable | Mating gender of the connector. | |
compatibleWith | Compatible With | text | Devices or headstages this component mates with. | ||
mass | Mass | quantity with unit | units mg, g; default {"unit": "g"} | Mass of the component, which matters for chronic headcap load. |
Illustrative payload:
{
"connectorClass": "electrode_interface_board",
"productId": "text",
"connectorFamily": "text"
}
Consumable device
- type code
ConsumableDevice· version 4.0.3 · schema
A manufactured device dedicated to or used up on one subject that no more specific type covers, such as a headstage, a microdrive, a drive mount, a fiber-optic cannula assembly or a miniscope baseplate. Probes, arrays and fibers have their own design types.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Supplier or catalog identifier (e.g., ‘DORIC_MFC_2x200’). | ||
deviceClass | Device Class | choice | yes | one of headstage, headstage_adapter, miniscope_baseplate, microdrive, drive_mount, fiber_cannula_assembly, thermal_interface_board, custom_fixture, other | Subject-mounted assemblies. Interconnect hardware (EIBs, connectors, adapters, commutators) belongs to the Connector component type. |
compatibleWith | Compatible Systems | text | E.g., ‘Neuropixels’, ‘Inscopix’, ‘Open Ephys’, ‘Doric’. | ||
dimensions | Physical Dimensions | text | Key geometry (e.g., ‘1.25 mm ferrule, 5 mm length’). | ||
material | Material | text | Main material (e.g., stainless steel, zirconia, PEEK, plastic). | ||
connectivity | Connectivity | text | Connector/interface type (e.g., ‘LC/PC’, ‘Omnetics’, ‘pin header’). | ||
storageConditions | Storage Conditions | text | E.g., ‘Room temperature’, ‘Dry box’, ‘Protect from dust’. | ||
experimentalUse | Experimental Use Context | multi-select | one of chronic_implantation, acute_recording, optogenetics, imaging, behavioral_interface, other; format select2 | Intended or validated experimental uses. |
Illustrative payload:
{
"deviceClass": "headstage",
"productId": "text",
"compatibleWith": "text"
}
ECoG array design
- type code
EcogArrayDesign· version 1.0.0 · schema
A surface electrode array design for electrocorticography: a grid or strip of contacts on a flexible substrate that lies on the dura, the brain surface or the skull. Penetrating probes are Silicon probe designs; the arrays you hold are ECoG array stock.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | A unique identifier for the ECoG array design as defined by the supplier. | ||
layout | Contact layout | choice | one of unknown, linear, grid, other; default "unknown" | Arrangement family of the contacts on the array; rows, columns and pitch are recorded separately. | |
nRows | Contact rows | integer | ≥ 1 | Number of contact rows in a regular grid or strip; omit for irregular layouts. | |
nColumns | Contact columns | integer | ≥ 1 | Number of contact columns in a regular grid or strip; omit for irregular layouts. | |
customDesign | Custom-manufactured design | choice | one of unknown, custom, standard; default "unknown"; format select | Whether the manufacturer made this as a custom design; excludes later modifications to individual arrays. | |
nChannels | Simultaneous recording channels | integer | yes | ≥ 1 | Maximum number of independent recording signals supported simultaneously; this can be lower than the total contact count. |
nPhysicalSites | Contacts (total) | integer | yes | ≥ 1 | Total recording contacts on the array, including selectable contacts not recorded simultaneously; excludes dedicated reference contacts. |
material | Contact material | text | Exposed contact material when uniform across the array. | ||
shape | Contact shape | choice | one of unknown, circle, square, rectangle, other; default "unknown" | Source-specified shape shared by all recording contacts. | |
siteDiameter | Contact diameter | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Exposed diameter of a circular contact; give the area instead for other shapes. | |
siteArea | Contact area | quantity with unit | units nm², µm², mm², m²; default {"unit": "µm²"} | Nominal exposed area of one contact when uniform; this does not specify contact shape. | |
siteHorizontalPitch | Pitch along a row | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Center-to-center contact spacing along a row of the array; equal to the column pitch on a square grid. | |
siteVerticalPitch | Pitch along a column | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Center-to-center contact spacing along a column of the array; omit on a single-row strip. | |
substrateMaterial | Substrate material | text | Flexible carrier material the contacts are embedded in, as the supplier names it. | ||
substrateThickness | Array thickness | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Nominal overall thickness of the array body, as the source prints it. | |
arrayLength | Array length | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Overall extent of the array body along its rows (x); excludes tails and cables. | |
arrayWidth | Array width | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Overall extent of the array body along its columns (y); excludes tails and cables. | |
siteGroups | Contact groups | table of rows | format table | Groups of contacts that differ in shape, size or material, such as stimulation pads among recording contacts. | |
siteGroups[].groupId | Contact group ID | text | Identifier for a group of contacts sharing these specifications. | ||
siteGroups[].siteIds | Contact IDs | list of integers | format comma-separated-integers | Numeric IDs of the contacts in this group, as used in the contact coordinates. Omit when unknown. | |
siteGroups[].shape | Contact shape | choice | one of unknown, circle, square, rectangle, other; default "unknown" | Shape explicitly specified for these contacts; never inferred from area alone. | |
siteGroups[].area | Area | quantity with unit | units nm², µm², mm², m²; default {"unit": "µm²"} | Exposed area of each contact in this group, as specified by the source. | |
siteGroups[].width | Width | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-specified extent of each contact in this group along a row. | |
siteGroups[].height | Height | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-specified extent of each contact in this group along a column. | |
siteGroups[].material | Contact material | text | Exposed contact material for the contacts in this group. | ||
siteCoordinates | Contact coordinates | object | Center of every recording contact as parallel lists, in the supplier’s drawing frame: x along the rows, y along the columns. | ||
siteCoordinates.x | X coordinates | multi-select | yes | format comma-separated-numbers | Position of each contact along the row direction, one value per contact, in the shared frame. |
siteCoordinates.y | Y coordinates | multi-select | yes | format comma-separated-numbers | Position of each contact along the column direction, one value per contact; the cable side is recorded under Tails. |
siteCoordinates.siteIds | Contact IDs | list of integers | yes | format comma-separated-integers | Numeric contact IDs, one per coordinate: the source’s numbering where it numbers contacts, otherwise diagram numbering. |
siteCoordinates.unit | Coordinate unit | choice | yes | one of nm, µm, mm, m; default "µm" | Length unit shared by every coordinate below. |
referenceSites | Reference contacts | table of rows | format table | Dedicated reference or ground contacts on the array, one row each; they are not counted among the recording contacts. Coordinates share the contact frame. | |
referenceSites[].referenceId | Reference ID | text | yes | The source’s name for this contact, for example ref or gnd. | |
referenceSites[].role | Role | choice | one of unknown, reference, ground; default "unknown" | Whether the source designates this contact as a reference or a ground. | |
referenceSites[].coordinateUnit | Coordinate unit | choice | one of nm, µm, mm, m; default "µm" | Length unit of the x and y position below. | |
referenceSites[].x | X coordinate | number | Position of the contact along the row direction, in the frame shared with the contact coordinates. | ||
referenceSites[].y | Y coordinate | number | Position of the contact along the column direction, in the shared frame. | ||
referenceSites[].shape | Contact shape | choice | one of unknown, circle, square, rectangle, other; default "unknown" | Shape explicitly specified for this contact; never inferred from area alone. | |
referenceSites[].area | Area | quantity with unit | units nm², µm², mm², m²; default {"unit": "µm²"} | Exposed area of this contact, as specified by the source. | |
referenceSites[].width | Width | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-specified extent of this contact along a row. | |
referenceSites[].height | Height | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-specified extent of this contact along a column. | |
referenceSites[].material | Material | text | Exposed material of this contact when it differs from the recording contacts. | ||
outlines | Body outlines | table of rows | format table | Outline of each separately drawn piece of the array body as a polygon in the contact frame, closed across the tail roots; one row per piece. | |
outlines[].unit | Outline unit | choice | yes | one of nm, µm, mm, m; default "µm" | Length unit shared by the outline x and y lists of this piece. |
outlines[].x | Outline x | multi-select | yes | format comma-separated-numbers | Vertex x positions of this piece’s outline in drawing order. |
outlines[].y | Outline y | multi-select | yes | format comma-separated-numbers | Vertex y positions paired with outline x, in the frame shared with the contact coordinates. |
tails | Tails | table of rows | format table | Ribbons or cables leaving the array body, one row each, in the supplier’s order; the first row is the rotation reference. | |
tails[].direction | Direction | choice | one of unknown, left, right, up, down, other; default "unknown" | Which way the tail leaves the body on the supplier’s drawing, as the contacts are stored. | |
tails[].coordinateUnit | Coordinate unit | choice | one of nm, µm, mm, m; default "µm" | Length unit of the exit point below. | |
tails[].x | Exit x | number | Where the tail’s center line crosses the body outline, along the row direction, in the contact frame. | ||
tails[].y | Exit y | number | Where the tail’s center line crosses the body outline, along the column direction. | ||
tails[].width | Width | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Nominal width of the tail across its run, at its widest where the source gives a maximum. | |
tails[].length | Length | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Nominal length from the body outline to the connector end, unfolded. | |
openings | Openings | table of rows | format table | Holes, slots and windows through the array body, one row per group of identical openings, with their centers when known. | |
openings[].shape | Shape | choice | one of unknown, circle, rectangle, slot, other; default "unknown" | Shape of each opening in this group. | |
openings[].diameter | Diameter | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Diameter of each circular opening in this group. | |
openings[].width | Width | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Extent of each non-circular opening along a row (x). | |
openings[].height | Height | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Extent of each non-circular opening along a column (y). | |
openings[].unit | Coordinate unit | choice | one of nm, µm, mm, m; default "µm" | Length unit shared by the center lists of this group. | |
openings[].x | Center x | multi-select | format comma-separated-numbers | Center of each opening along the row direction, in the contact frame; omit when positions are unknown. | |
openings[].y | Center y | multi-select | format comma-separated-numbers | Center of each opening along the column direction, paired with center x. | |
packageOptions | Package options | table of rows | format table | Published compatible connector, cable and accessory options for this design, one row each. | |
packageOptions[].productId | Part number | text | Supplier’s orderable identifier for this package, when it has one. Each row needs a part number or a name. | ||
packageOptions[].name | Package name | text | What the package is in words, including its connector when the source states one; omit when the part number says it all. |
Illustrative payload:
{
"nChannels": 1,
"nPhysicalSites": 1,
"productId": "text",
"layout": "unknown"
}
Electrode component
- type code
ElectrodeComponent· version 1.0.2 · schema
A loose part from which an electrode is built or completed, such as a reference or ground wire, a screw electrode, a silver chloride pellet or contact foil. Use Single wire electrode for wire meant to record or stimulate on its own.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference. | ||
electrodeRole | Role | choice | yes | one of reference, ground, recording, stimulating, reference_and_ground, other | What this contact is supplied for. The material role recorded on a procedure remains authoritative for a given use. |
physicalForm | Physical form | choice | one of wire, screw, pellet, foil, mesh, pin, other | Physical form of the contact. | |
material | Conductor Material | choice | one of silver, silver_silver_chloride, platinum, platinum_iridium, gold, stainless_steel, tungsten, nichrome, carbon, other | Conductor material, which sets the electrochemical properties of the contact. | |
insulation | Insulation | text | Insulation material, or ‘bare’ if uninsulated. | ||
diameter | Diameter | quantity with unit | units µm, mm; default {"unit": "µm"} | Conductor diameter. | |
impedance | Nominal Impedance | text | Manufacturer-quoted impedance, with the test frequency. |
Illustrative payload:
{
"electrodeRole": "reference",
"productId": "text",
"physicalForm": "wire"
}
Optic fiber design
- type code
OpticFiberDesign· version 1.1.1 · schema
An optical fiber or fiber implant design used to deliver or collect light, as in optogenetics or fiber photometry. Lenses, prisms and windows are Optical components; the fibers you cut, build or buy are Optic fiber stock.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | A unique product identifier for the optic fiber design as defined by the supplier. | ||
numericalAperture | Numerical aperture | number | ≥ 0 | The numerical aperture (NA) of the optic fiber. | |
wavelengthMin | Wavelength minimum | quantity with unit | units nm, µm, mm, m; default {"unit": "nm"} | The minimum wavelength the optic fiber transmits efficiently without significant loss. | |
wavelengthMax | Wavelength maximum | quantity with unit | units nm, µm, mm, m; default {"unit": "nm"} | The maximum wavelength the optic fiber can handle. | |
fiberType | Fiber type | text | yes | Type of fiber used in the optic fiber design, influencing how light propagates. | |
coreDiameter | Core diameter | quantity with unit | yes | units nm, µm, mm, m; default {"unit": "µm"} | Diameter of the fiber core affecting transmission properties like attenuation and bandwidth. |
claddingDiameter | Cladding diameter | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Diameter of cladding layer around the fiber core, crucial for keeping the light signals within the core by reflection. | |
coatingDiameter | Coating diameter | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Diameter of the external protective coating of the optic fiber, protecting it from physical damage and environmental factors. | |
core | Core material | text | Material or composition of the optic fiber core impacting its refractive index and transmission characteristics. | ||
cladding | Cladding material | text | Material or composition of the cladding layer, having a lower refractive index than the core for reflection within the fiber. | ||
coating | Coating material | text | Material or composition of the outer coating providing durability and protection. |
Illustrative payload:
{
"fiberType": "text",
"coreDiameter": {
"value": 1,
"unit": "µm"
},
"productId": "text",
"numericalAperture": 1.0
}
Optical component
- type code
OpticalComponent· version 2.0.4 · schema
A passive optical element other than a fiber, such as a GRIN lens, cranial window glass, a coverslip, a microprism, a filter or a relay lens. Use Optic fiber design for fibers, and Consumable device when the optics come built into a mounted assembly.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Supplier or catalog ID (e.g., ‘GRIN1234’, ‘MP-0.5mm’). | ||
componentType | Optical Component Type | choice | yes | one of grin_lens, cranial_window, cover_glass, microprism, beamsplitter, optical_filter, relay_lens, other | General class of optical element. |
material | Material | text | E.g., glass, quartz, sapphire, polymer. | ||
dimensions | Physical Dimensions | text | E.g., ‘1.0 mm diameter × 4 mm length’, ‘3×3×1 mm prism’. | ||
coating | Surface Coating | text | E.g., anti-reflective, hydrophobic, no coating. | ||
wavelengthMin | Wavelength minimum | quantity with unit | units nm, µm, mm, m; default {"unit": "nm"} | The minimum wavelength of light that the optic component is designed to handle. | |
wavelengthMax | Wavelength maximum | quantity with unit | units nm, µm, mm, m; default {"unit": "nm"} | The maximum wavelength of light that the optic component can handle. | |
sterile | Sterile | yes/no | Is this item provided sterile by the manufacturer? | ||
storageConditions | Storage Conditions | text | E.g., ‘Room temperature’, ‘Dry box’, ‘Avoid moisture’. | ||
experimentalUse | Experimental Use Context | multi-select | one of chronic_imaging, widefield_imaging, two_photon_imaging, optogenetics, histology, other; format select2 | Contexts in which this component is typically used. |
Illustrative payload:
{
"componentType": "grin_lens",
"productId": "text",
"material": "text"
}
Silicon probe design
- type code
SiliconProbeDesign· version 3.0.1 · schema
A silicon probe design for extracellular recording, such as a Neuropixels or a multishank probe, defined by its shanks and recording-site layout. Surface arrays are ECoG array designs; the probes you hold are Silicon probe stock.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | A unique identifier for the silicon probe design as defined by the supplier. | ||
layout | Recording-site layout | choice | one of unknown, linear, edge, tetrode, stereotrode, poly2, poly3, poly4, poly5, buzsaki, grid, mixed, other; default "unknown" | Arrangement family of the recording sites; column alignment and coordinates are recorded separately. | |
columnAlignment | Site column alignment | choice | one of unknown, aligned, shifted; default "unknown" | Whether adjacent site columns sit at the same heights or are shifted against each other. | |
customDesign | Custom-manufactured design | choice | one of unknown, custom, standard; default "unknown"; format select | Whether the manufacturer made this as a custom design; excludes later modifications to individual probes. | |
nChannels | Simultaneous recording channels | integer | yes | ≥ 1 | Maximum number of independent recording signals supported simultaneously; this can be lower than the total site count. |
nPhysicalSites | Recording sites (total) | integer | ≥ 1 | Total physical recording sites, including selectable sites not recorded simultaneously; excludes dedicated reference contacts. | |
nShanks | Number of shanks | integer | yes | ≥ 1 | Number of separate penetrating shanks in this probe design. |
shankLength | Shank length | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | Nominal tip-to-base length shared by all shanks; use individual dimensions when shanks differ. | |
shankPitch | Shank pitch | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Center-to-center distance between adjacent shanks in a uniform array. | |
shankWidth | Shank width | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Nominal width at the widest point of the shank, shared by all shanks; tapers narrow towards the tip. | |
shankWidthAtSites | Shank width at the sites | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Width of the shank alongside the recording sites; a tapered shank is narrower here than at its widest point. | |
shankThickness | Shank thickness | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Nominal thickness shared by all shanks; use individual dimensions when shanks differ. | |
material | Recording-site material | text | Exposed recording-site material when uniform; use site groups when materials differ. | ||
shape | Recording-site shape | choice | one of unknown, circle, square, rectangle, other; default "unknown" | Source-specified shape shared by all recording sites; use site groups when shapes differ. | |
siteVerticalPitch | Vertical column pitch | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Center-to-center spacing along one site column; excludes offsets between shifted columns. | |
siteHorizontalPitch | Horizontal site pitch | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-defined center-to-center site pitch across the shank. | |
siteArea | Recording-site area | quantity with unit | units nm², µm², mm², m²; default {"unit": "µm²"} | Nominal exposed recording-site area when uniform; this does not specify site shape. | |
shanks | Individual shanks | table of rows | format table | Identified shanks: their sites, nominal dimensions when not uniform, and outline when known. A shank row takes precedence over the shared scalars. | |
shanks[].shankId | Shank ID | text | yes | Identifier of the shank in the source drawing. | |
shanks[].siteIds | Site IDs | list of integers | format comma-separated-integers | Numeric IDs of the recording sites on this shank, in source numbering; omit when unknown. | |
shanks[].length | Length | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Nominal length from the shank tip to its base. | |
shanks[].width | Width | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Nominal width of this shank at its widest point. | |
shanks[].thickness | Thickness | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Nominal thickness of this shank. | |
shanks[].outlineUnit | Outline unit | choice | one of nm, µm, mm, m; default "µm" | Length unit shared by the outline x and y lists of this shank. | |
shanks[].outlineX | Outline x | multi-select | format comma-separated-numbers | Polygon vertex x positions of this shank’s outline, tip included, in drawing order. | |
shanks[].outlineY | Outline y | multi-select | format comma-separated-numbers | Polygon vertex y positions paired with outline x, increasing away from the tip, in the frame shared with the site coordinates. | |
siteGroups | Recording-site groups | table of rows | format table | Groups of sites sharing shape, size or material; a group takes precedence over the shared site scalars. List site IDs only when the source establishes them. | |
siteGroups[].groupId | Site group ID | text | Identifier for a group of sites sharing these specifications. | ||
siteGroups[].siteIds | Site IDs | list of integers | format comma-separated-integers | Numeric site IDs in source numbering (zero- or one-based); do not renumber. Omit when unknown. | |
siteGroups[].shape | Site shape | choice | one of unknown, circle, square, rectangle, other; default "unknown" | Shape explicitly specified for these sites; never inferred from area alone. | |
siteGroups[].area | Area | quantity with unit | units nm², µm², mm², m²; default {"unit": "µm²"} | Exposed area of each recording site in this group, as specified by the source. | |
siteGroups[].width | Width | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-specified horizontal extent of each recording site in this group. | |
siteGroups[].height | Height | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-specified vertical extent of each recording site in this group. | |
siteGroups[].material | Recording-site material | text | Exposed recording-site material for the sites in this group. | ||
siteCoordinates | Recording-site coordinates | object | Center of every recording site as parallel lists; any origin, shared with the shank outlines. | ||
siteCoordinates.x | X coordinates | multi-select | yes | format comma-separated-numbers | Position of each site across the shank width, one value per site, in the shared frame. |
siteCoordinates.y | Y coordinates | multi-select | yes | format comma-separated-numbers | Position of each site along the shank, increasing away from the tip, one value per site. |
siteCoordinates.siteIds | Site IDs | list of integers | yes | format comma-separated-integers | Numeric site IDs in source numbering, one per coordinate; never renumbered. |
siteCoordinates.unit | Coordinate unit | choice | yes | one of nm, µm, mm, m; default "µm" | Length unit shared by every coordinate below. |
referenceSites | Reference contacts | table of rows | format table | Dedicated reference or ground contacts on the probe, one row each; they are not counted among the recording sites. Coordinates share the recording-site frame. | |
referenceSites[].referenceId | Reference ID | text | yes | The source’s name for this contact, for example ref, gnd or tip. | |
referenceSites[].role | Role | choice | one of unknown, reference, ground; default "unknown" | Whether the source designates this contact as a reference or a ground. | |
referenceSites[].shankId | Shank ID | text | Shank carrying this contact, matching a row of the shanks table; omit on single-shank designs. | ||
referenceSites[].coordinateUnit | Coordinate unit | choice | one of nm, µm, mm, m; default "µm" | Length unit of the x and y position below. | |
referenceSites[].x | X coordinate | number | Position of the contact across the shank width, in the frame shared with the recording-site coordinates. | ||
referenceSites[].y | Y coordinate | number | Position of the contact along the shank, increasing away from the tip, in the shared frame. | ||
referenceSites[].shape | Shape | choice | one of unknown, circle, square, rectangle, other; default "unknown" | Shape explicitly specified for this contact; never inferred from area alone. | |
referenceSites[].area | Area | quantity with unit | units nm², µm², mm², m²; default {"unit": "µm²"} | Exposed area of this contact as specified by the source. | |
referenceSites[].width | Width | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-specified horizontal extent of this contact. | |
referenceSites[].height | Height | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | Source-specified vertical extent of this contact. | |
referenceSites[].material | Material | text | Exposed material of this contact when it differs from the recording sites. | ||
packageOptions | Package options | table of rows | format table | Published compatible assembly, connector and accessory options for this design, one row each. | |
packageOptions[].productId | Part number | text | Supplier’s orderable identifier for this package, when it has one. Each row needs a part number or a name. | ||
packageOptions[].name | Package name | text | What the package is in words, including its connector when the source states one; omit when the part number says it all. |
Illustrative payload:
{
"nChannels": 1,
"nShanks": 1,
"productId": "text",
"layout": "unknown"
}
Single wire electrode
- type code
SingleWireElectrode· version 1.1.1 · schema
A single insulated wire used as an electrode, such as a tungsten, stainless steel or platinum-iridium microwire, bought to record, stimulate or build tetrodes. Reference and ground parts that are not plain wire are Electrode components.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | A unique identifier for the wire electrode as defined by the supplier. | ||
material | Material | text | The type of material used for the conductive part of the electrode. Common materials include stainless steel, platinum, and gold, each providing different levels of conductivity and biocompatibility. | ||
insulation | Insulation/Coating | text | The type of insulation or coating used for electrical insulation. | ||
diameter | Diameter | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | The diameter of the wire, which affects its flexibility, impedance, and recording surface area. | |
insulationDiameter | Insulation diameter | quantity with unit | units nm, µm, mm, m; default {"unit": "µm"} | The outer diameter of the insulation or coating. |
Illustrative payload:
{
"productId": "text",
"material": "text"
}
Surgical Consumables
Adhesive or cement
- type code
AdhesiveCement· version 1.0.3 · schema
A material that bonds or seals during surgery, such as dental acrylic, light-cured cement, cyanoacrylate glue or silicone elastomer. Use Implant or fixation material for structural parts, and Fastener or anchor for screws and pins.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference. | ||
subtype | Type | choice | yes | one of dental_cement, acrylic_polymer, cyanoacrylate_glue, silicone_elastomer, epoxy, uv_curing_adhesive, bone_wax, tissue_adhesive, other | Category of adhesive, cement, or sealant. |
componentCount | Number of Components | integer | ≥ 1 | Number of parts that must be mixed before use (1 for single-component products). | |
mixingRatio | Mixing Ratio | text | Manufacturer-recommended ratio for multi-component products. | ||
curingMethod | Curing Method | choice | one of air_cure, uv_cure, chemical_cure, thermal_cure, other | How the product is cured after application. | |
workingTime | Working Time | text | Time available for positioning before the product sets. | ||
storageConditions | Storage Conditions | text | Recommended storage conditions. | ||
biocompatible | Biocompatible | yes/no | Whether the product is biocompatible for in vivo use. |
Illustrative payload:
{
"subtype": "dental_cement",
"productId": "text",
"componentCount": 1
}
Fastener or anchor
- type code
FastenerAnchor· version 1.0.2 · schema
A screw, pin or anchor that holds an implant or headcap to bone, including skull screws that also serve as ground or reference. Use Adhesive or cement for what bonds them, and Implant or fixation material for the parts they hold.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference. | ||
subtype | Type | choice | yes | one of bone_screw, skull_anchor, machine_screw, nut, washer, pin, clamp, other | Category of fastener or anchor. |
threadSize | Thread Size | text | Thread designation or gauge. | ||
length | Length | quantity with unit | units mm, µm, inch; default {"unit": "mm"} | Overall length of the fastener. | |
headType | Head Type | text | Head or drive geometry. | ||
material | Material | choice | one of stainless_steel, titanium, brass, nylon, peek, gold_plated, other | Material the fastener is made from. Non-magnetic and non-conductive options matter for imaging and recording. | |
conductive | Conductive | yes/no | Whether the fastener conducts, which matters when it doubles as a reference or ground contact. | ||
biocompatible | Biocompatible | yes/no | Whether the fastener is biocompatible for in vivo use. |
Illustrative payload:
{
"subtype": "bone_screw",
"productId": "text",
"threadSize": "text"
}
Implant or fixation material
- type code
ImplantMaterial· version 3.0.2 · schema
Structural hardware or material an implant is built from or fixed with, such as a headpost, a recording chamber, a baseplate or shielding mesh. Bonding materials are Adhesive or cement; manufactured assemblies are Consumable devices.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference. | ||
subtype | Type | choice | yes | one of headpost, chamber, baseplate, shielding_mesh, other | Structural implant hardware. Adhesives and cements belong to the Adhesive or cement type; screws and anchors to Fastener or anchor. |
preparationInstructions | Preparation Instructions | text (multi-line) | Preparation steps before application. | ||
storageConditions | Storage Conditions | text | Recommended storage conditions. | ||
biocompatible | Biocompatible | yes/no | Whether the material is biocompatible for in vivo use. |
Illustrative payload:
{
"subtype": "headpost",
"productId": "text",
"preparationInstructions": "text"
}
Surgical disposable
- type code
SurgicalDisposable· version 3.0.2 · schema
A single-use item consumed during surgery or handling, such as a suture, a needle, a blade, a swab, a drape or gloves. Anything that becomes part of an implant is Implant or fixation material.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
productId | Product ID | text | Catalog number or supplier reference. | ||
subtype | Type | choice | yes | one of scalpel_blade, needle, syringe, suture, gauze_swab, surgical_drape, catheter, other | Category of surgical disposable. |
material | Material | text | Primary material (e.g., stainless steel, plastic, absorbable). | ||
specification | Specification | text | Short free-text detail to disambiguate similar items (size, gauge, blade number, etc.). | ||
sterile | Sterile | yes/no | Whether the item is sterile. |
Illustrative payload:
{
"subtype": "scalpel_blade",
"productId": "text",
"material": "text"
}
External Identifiers
- type code
ExternalIdentifiers· version 1.0.0 · schema
Add external identifiers from databases like NCBI, JAX, DOI, etc. Include URLs when available.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
source | Source | choice | yes | one of NCBI, JAX, DOI, UniProt, PubMed, Addgene, Sigma-Aldrich, Thermo Fisher, Abcam, Cell Signaling, Custom, Other; default "NCBI" | |
id | Identifier | text | yes | ||
url | URL (optional) | text |
Illustrative payload:
[
{
"source": "NCBI",
"id": "text",
"url": "text"
}
]