ConsumableStock schemas

Type-specific details of a lab’s own stock of a consumable.

Table of contents

  1. How to use this family
  2. Quick type map
  3. Reagents and Solutions
    1. Biological material
    2. Chemical reagent
    3. Histology reagent
    4. Antibody or immunoreagent
    5. Medical or carrier gas
    6. Pharmacological agent
    7. Physiological solution
    8. Tracer or dye
    9. Virus solution
  4. Device-Linked Consumables
    1. Connector component
    2. Consumable device
    3. ECoG array
    4. Electrode component
    5. Optic fiber
    6. Optical component
    7. Silicon probe
    8. Single wire electrode
  5. Surgical Consumables
    1. Adhesive or cement
    2. Fastener or anchor
    3. Implant or fixation material
    4. Surgical disposable

How to use this family

  • consumablestock: set type to a type code below and send its properties in details.
  • Every version is published at https://www.brainstem.org/schemas/ConsumableStock/<Type>/<version>.json and never changes; https://www.brainstem.org/schemas/ConsumableStock/<Type>.json is the current version and https://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 codeTitleGroupVersionRequired propertiesSchema
AdhesiveCementAdhesive or cementSurgical Consumables1.0.2none1.0.2.json
BiologicalMaterialBiological materialReagents and Solutions1.0.0none1.0.0.json
ChemicalReagentChemical reagentReagents and Solutions3.0.2chemicalType3.0.2.json
ConnectorComponentConnector componentDevice-Linked Consumables1.0.2none1.0.2.json
ConsumableDeviceConsumable deviceDevice-Linked Consumables4.0.3deviceClass4.0.3.json
EcogArrayECoG arrayDevice-Linked Consumables1.0.0none1.0.0.json
ElectrodeComponentElectrode componentDevice-Linked Consumables1.0.2none1.0.2.json
FastenerAnchorFastener or anchorSurgical Consumables1.0.2none1.0.2.json
HistologyReagentHistology reagentReagents and Solutions1.1.2none1.1.2.json
ImmunoReagentAntibody or immunoreagentReagents and Solutions2.0.4reagentType2.0.4.json
ImplantMaterialImplant or fixation materialSurgical Consumables1.0.1none1.0.1.json
MedicalGasMedical or carrier gasReagents and Solutions1.0.2none1.0.2.json
OpticFiberOptic fiberDevice-Linked Consumables1.0.0none1.0.0.json
OpticalComponentOptical componentDevice-Linked Consumables2.0.4componentType2.0.4.json
PharmacologicalAgentPharmacological agentReagents and Solutions3.0.4pharmacologicalCategory3.0.4.json
PhysiologicalSolutionPhysiological solutionReagents and Solutions2.0.4none2.0.4.json
SiliconProbeSilicon probeDevice-Linked Consumables1.0.0none1.0.0.json
SingleWireElectrodeSingle wire electrodeDevice-Linked Consumables1.1.1none1.1.1.json
SurgicalDisposableSurgical disposableSurgical Consumables1.0.0none1.0.0.json
TracerDyeTracer or dyeReagents and Solutions3.0.4dyeType3.0.4.json
VirusSolutionVirus solutionReagents and Solutions1.2.2none1.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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  Supplier lot number from the certificate, or the lab’s own bank identifier for a freeze-down.
unitCountVials or units in the lotinteger ≥ 0Number of vials or units as received or as banked, not the number left today.
cellsPerUnitViable cells per vial or unit (as received or banked)integer ≥ 0Viable cells per vial or unit as counted on the lot certificate, or as frozen per unit at a lab freeze-down.
viabilityViabilityquantity 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.
passageAtFreezePassage at freezeinteger ≥ 0Passage number of the cells when this lot was frozen, as declared by the supplier or counted at the freeze-down.
cryopreservationMediumCryopreservation mediumtext  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
}

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the batch or lot number.
compoundNameCompound Nametext  Name of the chemical (e.g., ‘Triton X-100’, ‘Paraformaldehyde’).
chemicalTypeChemical Typechoiceyesone of detergent, enzyme, indicator_ph_adjuster, salt_buffer, solvent, stain_dye, otherGeneral laboratory chemicals. Tissue-processing reagents belong to the Histology reagent type.
molecularWeightMolecular Weightquantity with unit units g/mol, kDa, Da; default {"unit": "g/mol"}Molecular weight of the chemical compound.
amountAmounttext  Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’).
concentrationConcentration / Strengthtext  If supplied in solution (e.g., ‘4%’, ‘1 M’, ‘10X’).
purityPurity / Gradetext  E.g., ‘≥99%’, ‘Analytical grade’, ‘ACS reagent’.
hazardInfoHazard Informationtext (multi-line)  Optional summary of safety hazards or GHS classification.

Illustrative payload:

{
    "chemicalType": "detergent",
    "batchId": "text",
    "compoundName": "text"
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the reagent batch or lot number.
amountAmounttext  Amount held in this lot.
concentrationConcentrationtext  Concentration of this lot, when it differs from the catalog product.
pHpHnumber ≥ 0 and ≤ 14Measured pH of this lot.
preparationDatePreparation Datetext  When this lot was made up. Fixatives and retrieval buffers are commonly prepared fresh.
preparationInstructionsPreparation Instructionstext (multi-line)  How this lot was prepared, including any dilution from a stock solution.

Illustrative payload:

{
    "batchId": "text",
    "amount": "text"
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the material batch or lot number.
reagentTypeReagent Typechoiceyesone of primary_antibody, secondary_antibody, fluorescent_label, dna_counterstain, otherGeneral classification of the reagent.
hostSpeciesHost Speciestext  Host in which the antibody was raised (e.g., ‘Rabbit’, ‘Mouse’).
reactivityReactivity Speciestext  Species the antibody is reactive against (e.g., ‘Rat’, ‘Mouse’, ‘Human’).
targetAntigenTarget Antigentext  What the reagent binds to (e.g., ‘GFAP’, ‘c-Fos’, ‘NeuN’).
clonalityClonalitychoice one of monoclonal, polyclonal, recombinant, unknownWhether the antibody is monoclonal or polyclonal.
conjugateConjugated Fluorophore or Enzymetext  E.g., ‘Alexa Fluor 488’, ‘HRP’, ‘None’.
amountAmounttext  Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’).
dilutionDilutiontext  Dilution (e.g., ‘1:500’, ‘2 µg/mL’).
applicationValidated Applicationsmulti-select one of ihc, icc, western_blot, flow_cytometry, immunoprecipitation, other; format select2Supported or validated experimental applications.

Illustrative payload:

{
    "reagentType": "primary_antibody",
    "batchId": "text",
    "hostSpecies": "text"
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdCylinder or Batch IDtext  Cylinder serial number, or batch identifier for the delivered gas.
amountAmounttext  Cylinder size or remaining contents.
regulatorSettingRegulator Settingtext  Delivery pressure or flow the regulator is set to.

Illustrative payload:

{
    "batchId": "text",
    "amount": "text"
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the material batch or lot number.
activeIngredientActive Ingredienttext  Primary pharmacologically active substance (e.g., ‘Ketamine’, ‘Buprenorphine’,’Isoflurane’).
amountAmounttext  Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’).
concentrationConcentrationtext  Stated strength of the active ingredient (e.g., ‘10 mg/mL’, ‘0.1%’, ‘50 µg/tablet’).
dosageFormDosage Formchoice one of solution, suspension, tablet, capsule, injection, topical, patch, otherPhysical form in which the drug is supplied.
routeOfAdministrationRoute of Administrationchoice one of ip, iv, sc, oral, topical, inhalation, intracerebral, otherTypical method of administration in experiments.
pharmacologicalCategoryPharmacological Categorychoiceyesone of analgesic, anesthetic, antibiotic, neuroactive, recreational, vehicle, experimental, otherBroad category of action or use.
pharmacologicalClassPharmacological Classtext  Mechanistic or therapeutic class (e.g., ‘NSAID’, ‘GABA agonist’, ‘NMDA antagonist’).
formulationFormulationtext  List of excipients, solvents, or carriers (e.g., ‘in 10% DMSO + saline’).
purityPurity / Gradetext  E.g., ‘≥98%’, ‘USP’, ‘Analytical grade’.
experimentalUseExperimental Use Contextmulti-select one of surgical, behavioral, electrophysiology, histology, imaging, other; format select2Contexts in which this agent is typically used.

Illustrative payload:

{
    "pharmacologicalCategory": "analgesic",
    "batchId": "text",
    "activeIngredient": "text"
}

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
solutionNameSolution Nametext  Descriptive name of the solution (e.g., ‘PBS’, ‘Saline + Tween 80’).
compositionCompositiontext (multi-line)  Full recipe or formula (e.g., ‘0.9% NaCl in H2O’, ‘aCSF with 10 mM HEPES’).
amountAmounttext  Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’).
pHTarget pH valuenumber ≥ 0Target pH value as numeric value (e.g., ‘7.4’).
osmolalityOsmolalitytext  In mOsm/kg, if known (e.g., ‘300 mOsm’).
preparationInstructionsPreparation Instructionstext (multi-line)  Steps for preparing or dissolving the solution (e.g., buffer components, filter sterilization).
sterileSterileyes/no  Was the solution prepared or delivered sterile?
purposePurpose / Usemulti-select one of vehicle, perfusion, fixation, dissection, buffering, storage, slice_preparation, other; format select2What is the primary use case for this solution?

Illustrative payload:

{
    "solutionName": "text",
    "composition": "text"
}

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the material batch or lot number.
dyeTypeType of Dye or Tracerchoiceyesone of fluorescent_tracer, lipophilic_dye, retrograde_tracer, anterograde_tracer, histological_dye, vital_stain, injection_marker, otherFunction or classification of the dye/tracer.
fluorophoreFluorophoretext  Fluorophore or spectral tag used (e.g., ‘Alexa Fluor 555’, ‘FITC’).
routeOfApplicationRoute of Applicationchoice one of injection, perfusion, topical, incubation, otherHow the dye is typically applied.
excitationPeakExcitation Peakquantity with unit units nm, µm, mm, m; default {"unit": "nm"}Peak wavelength for excitation (e.g., 550 nm).
emissionPeakEmission Peakquantity with unit units nm, µm, mm, m; default {"unit": "nm"}Peak wavelength for emission (e.g., 665 nm).
amountAmounttext  Amount of the agent (e.g., ‘500 mL’, ‘2 gram’).
solventSolvent / Vehicletext  Solvent used for preparation (e.g., ‘DMSO’, ‘Saline’, ‘Ethanol’).
preparationInstructionsPreparation Instructionstext (multi-line)  Preparation or dilution steps before application.
experimentalUseExperimental Use Contextmulti-select one of circuit_tracing, histology, injection_visualization, vital_staining, other; format select2Typical applications of this tracer or dye.

Illustrative payload:

{
    "dyeType": "fluorescent_tracer",
    "batchId": "text",
    "fluorophore": "text"
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the material batch or lot number.
titerTiter of virus solutionquantity 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.
volumeAvailable volumequantity with unit units nL, µL, mL, L; default {"unit": "mL"}The volume of the virus solution.
aliquotCountThe number of aliquotsinteger ≥ 0The number of aliquots.
aliquotVolumeThe volume per aliquotquantity 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"
    }
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the batch or lot number.
quantityQuantityinteger ≥ 0Number of items held in this lot.
assembledByAssembled Bytext  Who built this lot, for hand-assembled cables and interface boards.

Illustrative payload:

{
    "batchId": "text",
    "quantity": 1
}

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
productIdProduct IDtext  Supplier or catalog identifier (e.g., ‘DORIC_MFC_2x200’).
deviceClassDevice Classchoiceyesone of headstage, headstage_adapter, miniscope_baseplate, microdrive, drive_mount, fiber_cannula_assembly, thermal_interface_board, custom_fixture, otherSubject-mounted assemblies. Interconnect hardware belongs to the Connector component type.
compatibleWithCompatible Systemstext  E.g., ‘Neuropixels’, ‘Inscopix’, ‘Open Ephys’, ‘Doric’.
dimensionsPhysical Dimensionstext  Key geometry (e.g., ‘1.25 mm ferrule, 5 mm length’).
materialMaterialtext  Main material (e.g., stainless steel, zirconia, PEEK, plastic).
connectivityConnectivitytext  Connector/interface type (e.g., ‘LC/PC’, ‘Omnetics’, ‘pin header’).
experimentalUseExperimental Use Contextmulti-select one of chronic_implantation, acute_recording, optogenetics, imaging, behavioral_interface, other; format select2Intended or validated experimental uses.

Illustrative payload:

{
    "deviceClass": "headstage",
    "productId": "text",
    "compatibleWith": "text"
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
arrayIdsArray IDstext  The identifier of each array in this lot, so a specific array can be traced from the shelf into a subject and back.
quantityQuantity of arraysinteger ≥ 0The number of arrays in this lot.

Illustrative payload:

{
    "arrayIds": "text",
    "quantity": 1
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the batch or lot number.
quantityQuantityinteger ≥ 0Number of items, or length of spooled wire, held in this lot.
lengthLengthquantity with unit units mm, cm, m; default {"unit": "mm"}Length supplied, for wire and lead stock.
measuredImpedanceMeasured Impedancetext  Impedance measured for this lot, with the test frequency.
sterileSterileyes/no  Whether this stock has been sterilized or is pre-sterilized.

Illustrative payload:

{
    "batchId": "text",
    "quantity": 1
}

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
fiberIdsFiber IDstext  A unique identifier for each optic fiber.
quantityQuantity of optic fibersinteger ≥ 0The quantity of optic fibers in the batch.

Illustrative payload:

{
    "fiberIds": "text",
    "quantity": 1
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
productIdProduct IDtext  Supplier or catalog ID (e.g., ‘GRIN1234’, ‘MP-0.5mm’).
componentTypeOptical Component Typechoiceyesone of grin_lens, cranial_window, cover_glass, microprism, beamsplitter, optical_filter, relay_lens, otherGeneral class of optical element.
materialMaterialtext  E.g., glass, quartz, sapphire, polymer.
dimensionsPhysical Dimensionstext  E.g., ‘1.0 mm diameter × 4 mm length’, ‘3×3×1 mm prism’.
coatingSurface Coatingtext  E.g., anti-reflective, hydrophobic, no coating.
wavelengthMinWavelength minimumquantity with unit units nm, µm, mm, m; default {"unit": "nm"}The minimum wavelength of light that the optic component is designed to handle.
wavelengthMaxWavelength maximumquantity with unit units nm, µm, mm, m; default {"unit": "nm"}The maximum wavelength of light that the optic component can handle.
sterileSterileyes/no  Whether this stock is sterile or pre-sterilized.
experimentalUseExperimental Use Contextmulti-select one of chronic_imaging, widefield_imaging, two_photon_imaging, optogenetics, histology, other; format select2Contexts in which this component is typically used.

Illustrative payload:

{
    "componentType": "grin_lens",
    "productId": "text",
    "material": "text"
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
probeIdsProbe IDstext  A unique identifier for each silicon probe.
quantityQuantity of probesinteger ≥ 0The quantity of probes in the batch.

Illustrative payload:

{
    "probeIds": "text",
    "quantity": 1
}

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
wireIdsWire IDstext  A unique identifier for the wire electrode as defined by the supplier.
quantityQuantity of electrodesinteger ≥ 0The quantity of electrodes.
lengthLengthquantity with unit units nm, µm, mm, m; default {"unit": "mm"}The length of the wire.

Illustrative payload:

{
    "wireIds": "text",
    "quantity": 1
}

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the product batch or lot number.
amountAmounttext  Amount held in this lot.
mixingRatioMixing Ratiotext  Ratio actually used for this lot, when it differs from the catalog default.
preparationInstructionsPreparation Instructionstext (multi-line)  Preparation or mixing steps before application.
sterileSterileyes/no  Whether this stock has been sterilized or is pre-sterilized.

Illustrative payload:

{
    "batchId": "text",
    "amount": "text"
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the batch or lot number.
quantityQuantityinteger ≥ 0Number of items held in this lot.
sterileSterileyes/no  Whether this stock has been sterilized or is pre-sterilized.

Illustrative payload:

{
    "batchId": "text",
    "quantity": 1
}
  • consumable accepts 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the material batch or lot number.
amountAmounttext  Amount of the agent (e.g., ‘500 mL’, ‘2 gram’, ‘50 tablets’).
preparationInstructionsPreparation Instructionstext (multi-line)  Preparation steps before application.
sterileSterileyes/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.

PropertyTitleShapeRequiredAllowed valuesMeaning
batchIdBatch IDtext  A unique identifier for the material batch or lot number.
quantityQuantityinteger ≥ 0The quantity of items in this stock (e.g., number of blades, needles, or sutures).
sterileSterileyes/no  Whether this stock is sterile or pre-sterilized.

Illustrative payload:

{
    "batchId": "text",
    "quantity": 1
}