ConsumableStock schemas
Type-specific details of a lab’s own stock of a consumable.
Table of contents
- How to use this family
- Quick type map
- Reagents and Solutions
- Device-Linked Consumables
- Surgical Consumables
How to use this family
consumablestock: settypeto a type code below and send its properties indetails.- Every version is published at
https://www.brainstem.org/schemas/ConsumableStock/<Type>/<version>.jsonand never changes;https://www.brainstem.org/schemas/ConsumableStock/<Type>.jsonis the current version andhttps://www.brainstem.org/schemas/ConsumableStock/<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.2 | none | 1.0.2.json |
BiologicalMaterial | Biological material | Reagents and Solutions | 1.0.0 | none | 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.2 | none | 1.0.2.json |
ConsumableDevice | Consumable device | Device-Linked Consumables | 4.0.3 | deviceClass | 4.0.3.json |
EcogArray | ECoG array | Device-Linked Consumables | 1.0.0 | none | 1.0.0.json |
ElectrodeComponent | Electrode component | Device-Linked Consumables | 1.0.2 | none | 1.0.2.json |
FastenerAnchor | Fastener or anchor | Surgical Consumables | 1.0.2 | none | 1.0.2.json |
HistologyReagent | Histology reagent | Reagents and Solutions | 1.1.2 | none | 1.1.2.json |
ImmunoReagent | Antibody or immunoreagent | Reagents and Solutions | 2.0.4 | reagentType | 2.0.4.json |
ImplantMaterial | Implant or fixation material | Surgical Consumables | 1.0.1 | none | 1.0.1.json |
MedicalGas | Medical or carrier gas | Reagents and Solutions | 1.0.2 | none | 1.0.2.json |
OpticFiber | Optic fiber | Device-Linked Consumables | 1.0.0 | none | 1.0.0.json |
OpticalComponent | Optical component | Device-Linked Consumables | 2.0.4 | componentType | 2.0.4.json |
PharmacologicalAgent | Pharmacological agent | Reagents and Solutions | 3.0.4 | pharmacologicalCategory | 3.0.4.json |
PhysiologicalSolution | Physiological solution | Reagents and Solutions | 2.0.4 | none | 2.0.4.json |
SiliconProbe | Silicon probe | Device-Linked Consumables | 1.0.0 | none | 1.0.0.json |
SingleWireElectrode | Single wire electrode | Device-Linked Consumables | 1.1.1 | none | 1.1.1.json |
SurgicalDisposable | Surgical disposable | Surgical Consumables | 1.0.0 | none | 1.0.0.json |
TracerDye | Tracer or dye | Reagents and Solutions | 3.0.4 | dyeType | 3.0.4.json |
VirusSolution | Virus solution | Reagents and Solutions | 1.2.2 | none | 1.2.2.json |
Reagents and Solutions
Biological material
- type code
BiologicalMaterial· version 1.0.0 · schema
Vials or a lot of cells, a cell line, primary cells, organoids or tissue held in the lab, bought or banked from your own culture. Choose it for the material a culture or injection is started from; virus preparations are Virus solutions.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | Supplier lot number from the certificate, or the lab’s own bank identifier for a freeze-down. | ||
unitCount | Vials or units in the lot | integer | ≥ 0 | Number of vials or units as received or as banked, not the number left today. | |
cellsPerUnit | Viable cells per vial or unit (as received or banked) | integer | ≥ 0 | Viable cells per vial or unit as counted on the lot certificate, or as frozen per unit at a lab freeze-down. | |
viability | Viability | quantity with unit | units % of cells; default {"unit": "% of cells"} | Viable cells as a percentage of all cells counted, from the lot certificate or counted at the freeze-down. | |
passageAtFreeze | Passage at freeze | integer | ≥ 0 | Passage number of the cells when this lot was frozen, as declared by the supplier or counted at the freeze-down. | |
cryopreservationMedium | Cryopreservation medium | text | Medium the cells of this lot are frozen in, as a named product or the lab’s own mix. |
Illustrative payload:
{
"batchId": "text",
"unitCount": 1
}
consumableaccepts Consumable types:BiologicalMaterial; other values are refused (400).
Chemical reagent
- type code
ChemicalReagent· version 3.0.2 · schema
A container or lot of a laboratory chemical held in the lab, as bought or made up as a stock solution. Solutions tissue is kept in are Physiological solutions, and fixatives and processing reagents are Histology reagents, even when made from these chemicals.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the batch or lot number. | ||
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 belong to the Histology reagent type. |
molecularWeight | Molecular Weight | quantity with unit | units g/mol, kDa, Da; default {"unit": "g/mol"} | Molecular weight of the chemical compound. | |
amount | Amount | text | Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’). | ||
concentration | Concentration / Strength | text | If supplied in solution (e.g., ‘4%’, ‘1 M’, ‘10X’). | ||
purity | Purity / Grade | text | E.g., ‘≥99%’, ‘Analytical grade’, ‘ACS reagent’. | ||
hazardInfo | Hazard Information | text (multi-line) | Optional summary of safety hazards or GHS classification. |
Illustrative payload:
{
"chemicalType": "detergent",
"batchId": "text",
"compoundName": "text"
}
consumableaccepts Consumable types:ChemicalReagent; other values are refused (400).
Histology reagent
- type code
HistologyReagent· version 1.1.2 · schema
A lot of fixative, clearing agent, embedding or mounting medium, bought or made up in the lab. Keep each freshly prepared batch as its own stock, since the age and pH of a fixative change the result.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the reagent batch or lot number. | ||
amount | Amount | text | Amount held in this lot. | ||
concentration | Concentration | text | Concentration of this lot, when it differs from the catalog product. | ||
pH | pH | number | ≥ 0 and ≤ 14 | Measured pH of this lot. | |
preparationDate | Preparation Date | text | When this lot was made up. Fixatives and retrieval buffers are commonly prepared fresh. | ||
preparationInstructions | Preparation Instructions | text (multi-line) | How this lot was prepared, including any dilution from a stock solution. |
Illustrative payload:
{
"batchId": "text",
"amount": "text"
}
consumableaccepts Consumable types:HistologyReagent; other values are refused (400).
Antibody or immunoreagent
- type code
ImmunoReagent· version 2.0.4 · schema
A vial or lot of an antibody or other binding reagent held in the lab, pointing at its catalog entry. Keep each lot as its own stock: staining quality and the working dilution often differ between lots of the same antibody.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the material batch or lot number. | ||
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’). | ||
targetAntigen | Target Antigen | text | What the reagent binds to (e.g., ‘GFAP’, ‘c-Fos’, ‘NeuN’). | ||
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’. | ||
amount | Amount | text | Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’). | ||
dilution | Dilution | text | Dilution (e.g., ‘1:500’, ‘2 µg/mL’). | ||
application | Validated Applications | multi-select | one of ihc, icc, western_blot, flow_cytometry, immunoprecipitation, other; format select2 | Supported or validated experimental applications. |
Illustrative payload:
{
"reagentType": "primary_antibody",
"batchId": "text",
"hostSpecies": "text"
}
consumableaccepts Consumable types:ImmunoReagent; other values are refused (400).
Medical or carrier gas
- type code
MedicalGas· version 1.0.2 · schema
A gas cylinder or delivered supply held in the lab, such as oxygen, carbogen or CO₂, pointing at its catalog gas. Keep each cylinder as a stock so a procedure can name the supply it drew on.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Cylinder or Batch ID | text | Cylinder serial number, or batch identifier for the delivered gas. | ||
amount | Amount | text | Cylinder size or remaining contents. | ||
regulatorSetting | Regulator Setting | text | Delivery pressure or flow the regulator is set to. |
Illustrative payload:
{
"batchId": "text",
"amount": "text"
}
consumableaccepts Consumable types:MedicalGas; other values are refused (400).
Pharmacological agent
- type code
PharmacologicalAgent· version 3.0.4 · schema
A vial or lot of a drug held in the lab, as bought or diluted to a working stock. Keep a diluted working stock separate from the vial it came from: its concentration differs, and controlled drugs are tracked per container.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the material batch or lot number. | ||
activeIngredient | Active Ingredient | text | Primary pharmacologically active substance (e.g., ‘Ketamine’, ‘Buprenorphine’,’Isoflurane’). | ||
amount | Amount | text | Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’). | ||
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’). | ||
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:
{
"pharmacologicalCategory": "analgesic",
"batchId": "text",
"activeIngredient": "text"
}
consumableaccepts Consumable types:PharmacologicalAgent; other values are refused (400).
Physiological solution
- type code
PhysiologicalSolution· version 2.0.4 · schema
A batch of saline, PBS, Ringer’s, aCSF or another physiological solution, bought or mixed in the lab. Most are mixed in-house, so each batch is its own stock with the composition actually made.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
solutionName | Solution Name | text | Descriptive name of the solution (e.g., ‘PBS’, ‘Saline + Tween 80’). | ||
composition | Composition | text (multi-line) | Full recipe or formula (e.g., ‘0.9% NaCl in H2O’, ‘aCSF with 10 mM HEPES’). | ||
amount | Amount | text | Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’). | ||
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’). | ||
preparationInstructions | Preparation Instructions | text (multi-line) | Steps for preparing or dissolving the solution (e.g., buffer components, filter sterilization). | ||
sterile | Sterile | yes/no | Was the solution prepared or delivered 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:
{
"solutionName": "text",
"composition": "text"
}
consumableaccepts Consumable types:PhysiologicalSolution; other values are refused (400).
Tracer or dye
- type code
TracerDye· version 3.0.4 · schema
A vial or lot of a dye or tracer held in the lab, as bought or dissolved to a working solution. Keep a working solution separate from the powder or concentrate it was made from.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the material batch or lot number. | ||
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). | |
amount | Amount | text | Amount of the agent (e.g., ‘500 mL’, ‘2 gram’). | ||
solvent | Solvent / Vehicle | text | Solvent used for preparation (e.g., ‘DMSO’, ‘Saline’, ‘Ethanol’). | ||
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",
"batchId": "text",
"fluorophore": "text"
}
consumableaccepts Consumable types:TracerDye; other values are refused (400).
Virus solution
- type code
VirusSolution· version 1.2.2 · schema
An aliquoted preparation of a viral vector held in the freezer, from a vector core or made in the lab, pointing at its construct in the catalog. Keep each preparation separate, since the titer differs between batches of the same construct.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the material batch or lot number. | ||
titer | Titer of virus solution | quantity with unit | units vg/mL, gc/mL, TU/mL, IU/mL, pfu/mL, FFU/mL, vp/mL; default {"unit": "vg/mL"} | Lot titer as received or prepared for this stock entry. | |
volume | Available volume | quantity with unit | units nL, µL, mL, L; default {"unit": "mL"} | The volume of the virus solution. | |
aliquotCount | The number of aliquots | integer | ≥ 0 | The number of aliquots. | |
aliquotVolume | The volume per aliquot | quantity with unit | units nL, µL, mL, L; default {"unit": "µL"} | The volume of each aliquot. |
Illustrative payload:
{
"batchId": "text",
"titer": {
"value": 1,
"unit": "vg/mL"
}
}
consumableaccepts Consumable types:VirusConstruct; other values are refused (400).
Device-Linked Consumables
Connector component
- type code
ConnectorComponent· version 1.0.2 · schema
Connectors, interface boards, adapters or tethers held in the lab, bought or assembled in-house. Keep a hand-built batch as its own stock so an implant can be traced to the parts it was built with.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the batch or lot number. | ||
quantity | Quantity | integer | ≥ 0 | Number of items held in this lot. | |
assembledBy | Assembled By | text | Who built this lot, for hand-assembled cables and interface boards. |
Illustrative payload:
{
"batchId": "text",
"quantity": 1
}
consumableaccepts Consumable types:ConnectorComponent; other values are refused (400).
Consumable device
- type code
ConsumableDevice· version 4.0.3 · schema
Devices dedicated to or used up on one subject held in the lab, such as headstages, microdrives or fiber-optic cannula assemblies, pointing at their catalog entry. Probes, arrays and fibers have their own stock 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 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’). | ||
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"
}
consumableaccepts Consumable types:ConsumableDevice; other values are refused (400).
ECoG array
- type code
EcogArray· version 1.0.0 · schema
ECoG arrays of one design held in the lab, each array identified so it can be traced from the shelf into a subject and back out if recovered. Arrays are durable: they can fail or need maintenance, but do not run out or expire.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
arrayIds | Array IDs | text | The identifier of each array in this lot, so a specific array can be traced from the shelf into a subject and back. | ||
quantity | Quantity of arrays | integer | ≥ 0 | The number of arrays in this lot. |
Illustrative payload:
{
"arrayIds": "text",
"quantity": 1
}
consumableaccepts Consumable types:EcogArrayDesign; other values are refused (400).
Electrode component
- type code
ElectrodeComponent· version 1.0.2 · schema
Loose electrode parts or spooled wire held in the lab, such as reference and ground wires or silver chloride pellets, as distinct from a finished probe. Cut wires meant to record or stimulate on their own are Single wire electrodes.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the batch or lot number. | ||
quantity | Quantity | integer | ≥ 0 | Number of items, or length of spooled wire, held in this lot. | |
length | Length | quantity with unit | units mm, cm, m; default {"unit": "mm"} | Length supplied, for wire and lead stock. | |
measuredImpedance | Measured Impedance | text | Impedance measured for this lot, with the test frequency. | ||
sterile | Sterile | yes/no | Whether this stock has been sterilized or is pre-sterilized. |
Illustrative payload:
{
"batchId": "text",
"quantity": 1
}
consumableaccepts Consumable types:ElectrodeComponent; other values are refused (400).
Optic fiber
- type code
OpticFiber· version 1.0.0 · schema
Optic fibers or assembled fiber implants of one design held in the lab, bought or built in-house, each identified so a specific fiber can be traced into an implantation. The design itself is the Optic fiber design catalog entry.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
fiberIds | Fiber IDs | text | A unique identifier for each optic fiber. | ||
quantity | Quantity of optic fibers | integer | ≥ 0 | The quantity of optic fibers in the batch. |
Illustrative payload:
{
"fiberIds": "text",
"quantity": 1
}
consumableaccepts Consumable types:OpticFiberDesign; other values are refused (400).
Optical component
- type code
OpticalComponent· version 2.0.4 · schema
Lenses, prisms, windows, coverslips or filters held in the lab, pointing at their catalog entry. A GRIN lens or window that will be implanted is held here until the implant procedure uses it.
| 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 | Whether this stock is sterile or pre-sterilized. | ||
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"
}
consumableaccepts Consumable types:OpticalComponent; other values are refused (400).
Silicon probe
- type code
SiliconProbe· version 1.0.0 · schema
Silicon probes of one design held in the lab, each identified so a specific probe can be traced from the shelf into a subject and back out if it is recovered and reused. The design itself is the Silicon probe design catalog entry.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
probeIds | Probe IDs | text | A unique identifier for each silicon probe. | ||
quantity | Quantity of probes | integer | ≥ 0 | The quantity of probes in the batch. |
Illustrative payload:
{
"probeIds": "text",
"quantity": 1
}
consumableaccepts Consumable types:SiliconProbeDesign; other values are refused (400).
Single wire electrode
- type code
SingleWireElectrode· version 1.1.1 · schema
Single-wire electrodes or cut lengths of electrode wire held in the lab, ready to record, stimulate or build into tetrodes. Reference and ground parts that are not plain wire are Electrode components.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
wireIds | Wire IDs | text | A unique identifier for the wire electrode as defined by the supplier. | ||
quantity | Quantity of electrodes | integer | ≥ 0 | The quantity of electrodes. | |
length | Length | quantity with unit | units nm, µm, mm, m; default {"unit": "mm"} | The length of the wire. |
Illustrative payload:
{
"wireIds": "text",
"quantity": 1
}
consumableaccepts Consumable types:SingleWireElectrode; other values are refused (400).
Surgical Consumables
Adhesive or cement
- type code
AdhesiveCement· version 1.0.2 · schema
A lot of cement, glue or sealant held in the lab, pointing at its catalog product. Two-part products are only reproducible with the mixing ratio actually used, so record it here when it differs from the product’s default.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the product batch or lot number. | ||
amount | Amount | text | Amount held in this lot. | ||
mixingRatio | Mixing Ratio | text | Ratio actually used for this lot, when it differs from the catalog default. | ||
preparationInstructions | Preparation Instructions | text (multi-line) | Preparation or mixing steps before application. | ||
sterile | Sterile | yes/no | Whether this stock has been sterilized or is pre-sterilized. |
Illustrative payload:
{
"batchId": "text",
"amount": "text"
}
consumableaccepts Consumable types:AdhesiveCement; other values are refused (400).
Fastener or anchor
- type code
FastenerAnchor· version 1.0.2 · schema
A lot of bone screws, pins or anchors held in the lab, pointing at their catalog entry, so an implant can name the batch of screws it was secured with.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the batch or lot number. | ||
quantity | Quantity | integer | ≥ 0 | Number of items held in this lot. | |
sterile | Sterile | yes/no | Whether this stock has been sterilized or is pre-sterilized. |
Illustrative payload:
{
"batchId": "text",
"quantity": 1
}
consumableaccepts Consumable types:FastenerAnchor; other values are refused (400).
Implant or fixation material
- type code
ImplantMaterial· version 1.0.1 · schema
Headposts, chambers, baseplates, shielding mesh or other structural implant material held in the lab, bought or machined in-house. Keep a machined batch as its own stock so implants can be traced to it.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the material batch or lot number. | ||
amount | Amount | text | Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’). | ||
preparationInstructions | Preparation Instructions | text (multi-line) | Preparation steps before application. | ||
sterile | Sterile | yes/no | Whether this stock has been sterilized or is pre-sterilized. |
Illustrative payload:
{
"batchId": "text",
"amount": "text"
}
Surgical disposable
- type code
SurgicalDisposable· version 1.0.0 · schema
A box or lot of sutures, needles, blades, swabs or other single-use surgical items held in the lab, so a procedure can name the supplies it used.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
batchId | Batch ID | text | A unique identifier for the material batch or lot number. | ||
quantity | Quantity | integer | ≥ 0 | The quantity of items in this stock (e.g., number of blades, needles, or sutures). | |
sterile | Sterile | yes/no | Whether this stock is sterile or pre-sterilized. |
Illustrative payload:
{
"batchId": "text",
"quantity": 1
}