MaterialUsage schemas
Detail schemas for material usage rows: one material in one role, as prepared or applied in a procedure, specimen procedure or experimental interface. The role (type) selects the schema.
Table of contents
- How to use this family
- Quick type map
- Devices
- Blood-pressure sensor
- Cannula
- Catheter
- Cranial window
- ECoG array
- Electrode assembly
- Fluid-delivery line
- Other device
- GRIN lens
- Ground electrode
- Headpost
- Microdialysis probe
- Multi-electrode array
- Nerve cuff
- Optic fiber
- Osmotic pump
- Patch pipette
- Prism
- Reference electrode
- Respiratory sensor
- Silicon probe
- Single-wire electrode
- Stimulating electrode
- Temperature probe or sensor
- Components and supporting materials
- Agents and drugs
- Biological and experimental payloads
- Fluids and vehicles
- Reagents and labels
- Media and embedding
- Collection and supplies
- Other
How to use this family
materialusage: settypeto a type code below and send its properties indetails_json.materialusagetemplate: settypeto a type code below and send its properties indetails_json.- Every version is published at
https://www.brainstem.org/schemas/MaterialUsage/<Type>/<version>.jsonand never changes;https://www.brainstem.org/schemas/MaterialUsage/<Type>.jsonis the current version andhttps://www.brainstem.org/schemas/MaterialUsage/<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 |
|---|---|---|---|---|---|
ActiveAgent | Active agent | Agents and drugs | 1.0.0 | none | 1.0.0.json |
AdhesiveSealant | Adhesive, cement, or sealant | Components and supporting materials | 1.0.0 | none | 1.0.0.json |
AdministeredFluid | Administered fluid | Fluids and vehicles | 1.0.0 | none | 1.0.0.json |
AnestheticAgent | Anesthetic agent | Agents and drugs | 1.0.0 | none | 1.0.0.json |
Anticoagulant | Anticoagulant | Agents and drugs | 1.0.1 | none | 1.0.1.json |
Baseplate | Baseplate | Components and supporting materials | 1.0.0 | none | 1.0.0.json |
BlockingReagent | Blocking reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
BloodPressureSensor | Blood-pressure sensor | Devices | 1.0.1 | none | 1.0.1.json |
Buffer | Buffer | Reagents and labels | 1.0.1 | none | 1.0.1.json |
Cannula | Cannula | Devices | 1.0.1 | none | 1.0.1.json |
CarrierGas | Carrier gas | Fluids and vehicles | 1.0.0 | none | 1.0.0.json |
Catheter | Catheter | Devices | 1.0.1 | none | 1.0.1.json |
CellSuspension | Cell suspension | Biological and experimental payloads | 1.0.1 | none | 1.0.1.json |
ClearingReagent | Clearing reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
Coating | Coating | Components and supporting materials | 1.0.0 | none | 1.0.0.json |
CollectionAdditive | Collection additive | Collection and supplies | 1.0.1 | none | 1.0.1.json |
CollectionContainer | Collection container | Collection and supplies | 1.0.1 | none | 1.0.1.json |
ConnectorComponent | Connector component | Components and supporting materials | 1.0.1 | none | 1.0.1.json |
CranialWindow | Cranial window | Devices | 1.0.1 | none | 1.0.1.json |
Cryoprotectant | Cryoprotectant | Media and embedding | 1.0.1 | none | 1.0.1.json |
DehydrationReagent | Dehydration reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
DeliveredComponent | Injected component | Biological and experimental payloads | 1.0.1 | none | 1.0.1.json |
DetectionReagent | Detection reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
EcogArray | ECoG array | Devices | 1.0.0 | none | 1.0.0.json |
ElectrodeAssembly | Electrode assembly | Devices | 1.0.0 | none | 1.0.0.json |
EmbeddingMedium | Embedding medium | Media and embedding | 1.0.1 | none | 1.0.1.json |
Fastener | Anchor screw, pin, or fastener | Components and supporting materials | 1.0.0 | none | 1.0.0.json |
Fixative | Fixative | Reagents and labels | 1.0.1 | none | 1.0.1.json |
FixedPositioningAssembly | Fixed implant carrier or shuttle | Components and supporting materials | 1.0.0 | none | 1.0.0.json |
FluidAdditive | Fluid additive | Fluids and vehicles | 1.0.0 | none | 1.0.0.json |
FluidDeliveryLine | Fluid-delivery line | Devices | 1.0.1 | none | 1.0.1.json |
GenericDevice | Other device | Devices | 1.0.0 | none | 1.0.0.json |
GrinLens | GRIN lens | Devices | 1.0.1 | none | 1.0.1.json |
GroundElectrode | Ground electrode | Devices | 1.0.1 | none | 1.0.1.json |
HeadcapAssembly | Headcap assembly | Components and supporting materials | 1.0.1 | none | 1.0.1.json |
Headpost | Headpost | Devices | 1.0.1 | none | 1.0.1.json |
HemostaticAgent | Hemostatic agent | Agents and drugs | 1.0.1 | none | 1.0.1.json |
HybridizationProbe | Hybridization probe | Reagents and labels | 1.0.1 | none | 1.0.1.json |
IndexMatchingMedium | Index-matching medium | Media and embedding | 1.0.1 | none | 1.0.1.json |
InhaledEuthanasiaAgent | Inhaled euthanasia agent | Agents and drugs | 1.0.1 | none | 1.0.1.json |
InjectedEuthanasiaAgent | Injected euthanasia agent | Agents and drugs | 1.0.1 | none | 1.0.1.json |
IrrigationSolution | Irrigation solution | Fluids and vehicles | 1.0.1 | none | 1.0.1.json |
LesionAgent | Lesion agent | Agents and drugs | 1.0.1 | none | 1.0.1.json |
ManualMicrodrive | Manual microdrive | Components and supporting materials | 1.0.0 | none | 1.0.0.json |
Medium | Processing or collection medium | Media and embedding | 1.0.1 | none | 1.0.1.json |
MicrodialysisProbe | Microdialysis probe | Devices | 1.0.1 | none | 1.0.1.json |
MotorizedMicrodrive | Motorized microdrive | Components and supporting materials | 1.0.0 | none | 1.0.0.json |
MountingComponent | Slide, coverslip, or mounting support | Components and supporting materials | 1.0.0 | none | 1.0.0.json |
MountingMedium | Mounting medium | Media and embedding | 1.0.1 | none | 1.0.1.json |
MultiElectrodeArray | Multi-electrode array | Devices | 1.0.1 | none | 1.0.1.json |
NerveCuff | Nerve cuff | Devices | 1.0.1 | none | 1.0.1.json |
NeuralTracer | Neural tracer | Biological and experimental payloads | 1.0.1 | none | 1.0.1.json |
Obturator | Obturator | Components and supporting materials | 1.0.1 | none | 1.0.1.json |
OpticFiber | Optic fiber | Devices | 1.0.0 | none | 1.0.0.json |
OsmoticPump | Osmotic pump | Devices | 1.0.0 | none | 1.0.0.json |
Other | Other | Other | 1.0.1 | none | 1.0.1.json |
OtherComponent | Other component | Components and supporting materials | 1.0.1 | none | 1.0.1.json |
ParticleSuspension | Particle suspension | Biological and experimental payloads | 1.0.1 | none | 1.0.1.json |
PatchPipette | Patch pipette | Devices | 1.0.1 | none | 1.0.1.json |
PermeabilizationReagent | Permeabilization reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
PharmacologicalAdjuvant | Pharmacological adjunct | Agents and drugs | 1.0.0 | none | 1.0.0.json |
PrimaryLabel | Primary immunolabeling reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
Prism | Prism | Devices | 1.0.1 | none | 1.0.1.json |
ProcessingReagent | Processing reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
ProcessingSupply | Processing supply | Collection and supplies | 1.0.1 | none | 1.0.1.json |
ReferenceElectrode | Reference electrode | Devices | 1.0.1 | none | 1.0.1.json |
RespiratorySensor | Respiratory sensor | Devices | 1.0.1 | none | 1.0.1.json |
RetrievalReagent | Retrieval reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
ReversalAgent | Reversal agent | Agents and drugs | 1.0.0 | none | 1.0.0.json |
SecondaryLabel | Secondary immunolabeling reagent | Reagents and labels | 1.0.1 | none | 1.0.1.json |
ShieldingMaterial | Shielding material | Components and supporting materials | 1.0.1 | none | 1.0.1.json |
SiliconProbe | Silicon probe | Devices | 1.0.1 | none | 1.0.1.json |
SingleWireElectrode | Single-wire electrode | Devices | 1.0.1 | none | 1.0.1.json |
StainDye | Stain or dye | Reagents and labels | 1.0.1 | none | 1.0.1.json |
StimulatingElectrode | Stimulating electrode | Devices | 1.0.1 | none | 1.0.1.json |
StorageMedium | Storage medium | Media and embedding | 1.0.1 | none | 1.0.1.json |
SupportiveAgent | Supportive-care agent | Agents and drugs | 1.0.1 | none | 1.0.1.json |
SurgicalSupply | Surgical supply | Collection and supplies | 1.0.0 | none | 1.0.0.json |
TemperatureSensor | Temperature probe or sensor | Devices | 1.0.0 | none | 1.0.0.json |
Vehicle | Vehicle | Fluids and vehicles | 1.0.0 | none | 1.0.0.json |
ViralComponent | Viral-vector preparation | Biological and experimental payloads | 1.0.0 | none | 1.0.0.json |
WashSolution | Wash solution | Reagents and labels | 1.0.1 | none | 1.0.1.json |
Devices
Blood-pressure sensor
- type code
BloodPressureSensor· version 1.0.1 · schema
A blood-pressure sensor or telemetry transmitter implanted or attached to measure arterial or venous pressure, with its sterility and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Cannula
- type code
Cannula· version 1.0.1 · schema
A guide or infusion cannula implanted or inserted for drug or fluid delivery, with its sterility and tip preparation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
tipPreparation | Tip preparation | choice | one of factory, cut, beveled, polished, other, unknown | Final preparation of the device tip for this use. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Catheter
- type code
Catheter· version 1.0.1 · schema
A vascular or other catheter placed for infusion or sampling, with its sterility and preparation of its ends.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
endPreparation | End preparation | choice | one of factory, cut, beveled, flared, other, unknown | Final physical preparation of the device end for this use. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Cranial window
- type code
CranialWindow· version 1.0.1 · schema
A glass or polymer window placed over a craniotomy for optical access, with its sterility and any surface treatment or coating.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
ECoG array
- type code
EcogArray· version 1.0.0 · schema
An ECoG array placed on the cortical surface for electrocorticography, with the number used, sterility, preparation and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
count | Count used | integer | ≥ 1 | Number of arrays used in this record, counted as whole arrays rather than the contacts on them. | |
preparation | Preparation | text | Use-specific preparation of the array before placement, such as trimming the substrate or soaking. | ||
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to the contacts for this use. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Electrode assembly
- type code
ElectrodeAssembly· version 1.0.0 · schema
An assembled set of electrodes, such as a tetrode bundle or multi-wire array, with the number of whole assemblies used, sterility and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
count | Count used | integer | ≥ 1 | Number of assemblies used in this record, counted as whole assemblies rather than the electrodes on them. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Fluid-delivery line
- type code
FluidDeliveryLine· version 1.0.1 · schema
Tubing or a line connecting a pump or syringe to a cannula or catheter, with its dead, priming and flush volumes, end preparation and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
deadVolume | Dead volume | quantity with unit | units mL, µL, nL; default {"unit": "µL"} | Internal volume retained in the configured line. | |
primingVolume | Priming volume | quantity with unit | units mL, µL, nL; default {"unit": "µL"} | Volume used to prime the line before delivery. | |
flushVolume | Flush volume | quantity with unit | units mL, µL, nL; default {"unit": "µL"} | Volume used to flush the line for this use. | |
endPreparation | End preparation | text | Preparation of the delivery end before use. | ||
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of the line when used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"deadVolume": {
"value": 1,
"unit": "µL"
},
"primingVolume": {
"value": 1,
"unit": "µL"
}
}
Other device
- type code
GenericDevice· version 1.0.0 · schema
A device that does not fit any of the specific device roles, with the number used, sterility, surface treatment and preparation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. | ||
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"count": 1,
"sterilityStatus": "sterile"
}
GRIN lens
- type code
GrinLens· version 1.0.1 · schema
A gradient-index (GRIN) lens implanted for deep-brain imaging, with its sterility, tip preparation and shape, and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
tipPreparation | Tip preparation | choice | one of factory, cut, polished, other, unknown | Final preparation of the device tip for this use. | |
tipShape | Tip shape | text | Final shape of the lens tip used. | ||
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Ground electrode
- type code
GroundElectrode· version 1.0.1 · schema
An electrode, screw or wire used as the electrical ground for a recording or stimulation, with the number used, sterility, tip preparation and surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
tipPreparation | Tip preparation | choice | one of factory, cut, stripped, beveled, polished, other, unknown | Final preparation of the device tip for this use. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"count": 1,
"sterilityStatus": "sterile"
}
Headpost
- type code
Headpost· version 1.0.1 · schema
A headpost or head plate fixed to the skull for head restraint, with its sterility and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Microdialysis probe
- type code
MicrodialysisProbe· version 1.0.1 · schema
A microdialysis probe used to sample or deliver substances in extracellular fluid, with its priming volume, membrane preparation, measured relative recovery and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
primingVolume | Priming volume | quantity with unit | units mL, µL, nL; default {"unit": "µL"} | Volume used to prime the probe before use. | |
membranePreparation | Membrane preparation | text | Use-specific conditioning or preparation of the dialysis membrane. | ||
recovery | Measured relative recovery | number | ≥ 0 and ≤ 100 | Measured relative analyte recovery for this probe, expressed as a percentage. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of the probe when used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"primingVolume": {
"value": 1,
"unit": "µL"
},
"membranePreparation": "text"
}
Multi-electrode array
- type code
MultiElectrodeArray· version 1.0.1 · schema
A planar or penetrating multi-electrode array, such as a Utah array or a culture MEA, with its preparation, treatment of the array or contacts, and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
preparation | Preparation | text | Use-specific preparation of the array before placement. | ||
surfaceTreatment | Surface treatment or coating | text | Use-specific treatment applied to the array or recording contacts. | ||
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of the array when used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"preparation": "text",
"surfaceTreatment": "text"
}
Nerve cuff
- type code
NerveCuff· version 1.0.1 · schema
A cuff electrode placed around a peripheral nerve for recording or stimulation, with its sterility and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Optic fiber
- type code
OpticFiber· version 1.0.0 · schema
An optic fiber implant or patch fiber used for optogenetic stimulation or fiber photometry, with the prepared length, tip preparation and shape, surface treatment and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
length | Prepared length | quantity with unit | units µm, mm, cm; default {"unit": "mm"} | Length of the fiber as prepared for this use, when cut or built in the lab. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
tipPreparation | Tip preparation | choice | one of factory, cleaved, polished, tapered, other, unknown | Final preparation of the device tip for this use. | |
tipShape | Tip shape | text | Final shape of the device tip used. | ||
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"length": {
"value": 1,
"unit": "mm"
},
"sterilityStatus": "sterile"
}
Osmotic pump
- type code
OsmoticPump· version 1.0.0 · schema
An osmotic minipump implanted to deliver a solution continuously over days or weeks.
This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.
Patch pipette
- type code
PatchPipette· version 1.0.1 · schema
A glass pipette used for patch-clamp or juxtacellular recording, with its tip preparation, such as fire polishing, any coating and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
tipPreparation | Tip preparation | choice | one of factory, pulled, fire_polished, coated, other, unknown | Final preparation of the pipette tip for this use. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific treatment applied to the pipette surface. | ||
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of the pipette when used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"tipPreparation": "factory",
"surfaceTreatment": "text"
}
Prism
- type code
Prism· version 1.0.1 · schema
A microprism implanted or placed for optical access to a tissue plane, with its sterility and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Reference electrode
- type code
ReferenceElectrode· version 1.0.1 · schema
An electrode, screw or wire used as the recording reference, with the number used, sterility, tip preparation and surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
tipPreparation | Tip preparation | choice | one of factory, cut, stripped, beveled, polished, other, unknown | Final preparation of the device tip for this use. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"count": 1,
"sterilityStatus": "sterile"
}
Respiratory sensor
- type code
RespiratorySensor· version 1.0.1 · schema
A sensor used to monitor breathing, such as a thermocouple, pressure sensor or chest belt, with its sterility and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Silicon probe
- type code
SiliconProbe· version 1.0.1 · schema
A silicon probe inserted or implanted for extracellular recording, with its sterility and sterilization or disinfection method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Single-wire electrode
- type code
SingleWireElectrode· version 1.0.1 · schema
A single-wire electrode used for recording or stimulation, with its tip preparation, surface treatment and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
tipPreparation | Tip preparation | choice | one of factory, cut, stripped, beveled, polished, other, unknown | Final preparation of the device tip for this use. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Stimulating electrode
- type code
StimulatingElectrode· version 1.0.1 · schema
An electrode used to deliver electrical stimulation, with its tip preparation, surface treatment and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
tipPreparation | Tip preparation | choice | one of factory, cut, stripped, beveled, polished, other, unknown | Final preparation of the stimulating surface or tip. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific treatment applied to the electrode surface. | ||
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of the electrode when used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"tipPreparation": "factory",
"surfaceTreatment": "text"
}
Temperature probe or sensor
- type code
TemperatureSensor· version 1.0.0 · schema
A thermistor, thermocouple or other probe used to measure body or tissue temperature, with its sterility and any surface treatment.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Components and supporting materials
Adhesive, cement, or sealant
- type code
AdhesiveSealant· version 1.0.0 · schema
A glue, dental or bone cement, or sealant used to secure an implant or seal tissue, with the amount used, mixing ratio, application method and area, and curing method, duration and temperature.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "µL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
mixingRatio | Mixing ratio | ratio | format ratio | Component ratio used to prepare a multi-part material. | |
mixingRatio.numerator | numerator | number | yes | > 0 | |
mixingRatio.denominator | denominator | number | yes | > 0 | |
applicationMethod | Application method | text | How this material was applied in this usage. | ||
area | Applied area | text | Location or surface where this material was applied. | ||
curingMethod | Curing method | choice | one of self_cured, air_dried, heat_cured, uv_cured, chemical_cure, none, other | Curing, drying, rinsing, or other post-application treatment. | |
curingDuration | Curing duration | quantity with unit | units d, h, min, s; default {"unit": "min"} | Duration allowed for curing, drying, or another post-treatment. | |
curingTemperature | Curing temperature | quantity with unit | units °C, K; default {"unit": "°C"} | Temperature used during curing or another post-treatment. |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "µL"
},
"mass": {
"value": 1,
"unit": "mg"
}
}
Baseplate
- type code
Baseplate· version 1.0.0 · schema
A baseplate fixed to the skull or headcap to which a removable device, such as a head-mounted miniature microscope, is attached.
This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.
Coating
- type code
Coating· version 1.0.0 · schema
A coating applied to a device or component before use, such as a lipophilic dye on a probe shank, with the coated area, application method, concentration and number of coats.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
applicationMethod | Application method | text | How this material was applied in this usage. | ||
area | Coated area | text | Part of the device or component that was coated. | ||
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mg/mL"} | Concentration of this material in the formulation or mixture actually applied. | |
numberOfCoats | Number of coats | integer | ≥ 1 | Number of coating layers applied. |
Illustrative payload:
{
"applicationMethod": "text",
"area": "text"
}
Connector component
- type code
ConnectorComponent· version 1.0.1 · schema
A connector, interface board, adapter or cable used to link an implanted device to the acquisition system, with the number used and its sterility, sterilization or disinfection method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"count": 1,
"sterilityStatus": "sterile"
}
Anchor screw, pin, or fastener
- type code
Fastener· version 1.0.0 · schema
A bone screw, anchor pin or other fastener used to secure an implant or headcap, with the number and size used, sterility and any preparation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
size | Size used | text | Use-specific size or gauge when it is not already part of the selected catalog or stock identity. | ||
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"count": 1,
"size": "text"
}
Fixed implant carrier or shuttle
- type code
FixedPositioningAssembly· version 1.0.0 · schema
A fixed carrier or shuttle that holds a device at a set position without a movable drive, with how the device is attached, how the carrier is fixed, whether the device can be recovered, and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
deviceRecoverable | Device can be recovered | yes/no | Whether the positioned device can be removed from the carrier for recovery or reuse. | ||
deviceAttachmentMethod | Device attachment to carrier | choice | one of clamp, screw, adhesive, friction_fit, shuttle_carrier, socket, other | How the positioned device is attached to the carrier or shuttle. | |
fixationMethod | Carrier fixation method | choice | one of dental_cement, skull_screws, headcap, bone_anchor, adhesive, mechanical_clamp, other | How the carrier or shuttle is secured in its used configuration. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"deviceRecoverable": true,
"deviceAttachmentMethod": "clamp"
}
Headcap assembly
- type code
HeadcapAssembly· version 1.0.1 · schema
A prefabricated or assembled headcap that protects and holds implants on the skull, with its sterility and any surface treatment or coating.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. |
Illustrative payload:
{
"sterilityStatus": "sterile",
"sterilizationMethod": "autoclave"
}
Manual microdrive
- type code
ManualMicrodrive· version 1.0.0 · schema
A manually adjusted microdrive that advances an implanted device, such as a screw-driven drive for tetrodes or a silicon probe, with drive mechanism, travel range, travel per turn, retractability, recovery, attachment and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
actuationMechanism | Drive mechanism | text | Manual mechanism used to advance or retract the implanted device. | ||
travelRange | Microdrive travel range | quantity with unit | units nm, µm, mm; default {"unit": "mm"} | Usable range over which the microdrive can move the positioned device. | |
movementResolution | Microdrive step size or resolution | quantity with unit | units nm, µm, mm; default {"unit": "µm"} | Smallest position increment reliably achievable by the microdrive. | |
travelPerTurn | Travel per full turn | quantity with unit | units nm, µm, mm; default {"unit": "µm"} | Distance the positioned device travels per full turn of the drive screw. | |
retractable | Device can be retracted | yes/no | Whether the microdrive permits the positioned device to be retracted. | ||
deviceRecoverable | Device can be recovered | yes/no | Whether the positioned device can be removed from the microdrive for recovery or reuse. | ||
deviceAttachmentMethod | Device attachment to microdrive | choice | one of clamp, screw, adhesive, friction_fit, shuttle_carrier, socket, other | How the positioned device is attached to the microdrive. | |
fixationMethod | Microdrive fixation method | choice | one of dental_cement, skull_screws, headcap, bone_anchor, adhesive, mechanical_clamp, other | How the microdrive is secured in its used configuration. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"actuationMechanism": "text",
"travelRange": {
"value": 1,
"unit": "mm"
}
}
Motorized microdrive
- type code
MotorizedMicrodrive· version 1.0.0 · schema
A motor-driven microdrive that advances an implanted device, with its control mode, travel range, step size, movement rate, retractability, recovery, attachment and sterility.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
controlMode | Control mode | text | How movement of the motorized microdrive is controlled. | ||
travelRange | Microdrive travel range | quantity with unit | units nm, µm, mm; default {"unit": "mm"} | Usable range over which the microdrive can move the positioned device. | |
movementResolution | Microdrive step size or resolution | quantity with unit | units nm, µm, mm; default {"unit": "µm"} | Smallest position increment reliably achievable by the microdrive. | |
rate | Microdrive movement rate | quantity with unit | units nm/s, µm/s, mm/s, µm/min, mm/min, µm/h, mm/h; default {"unit": "µm/s"} | Configured movement rate of the motorized microdrive. | |
travelPerTurn | Travel per full turn | quantity with unit | units nm, µm, mm; default {"unit": "µm"} | Distance the positioned device travels per full turn of the drive screw. | |
retractable | Device can be retracted | yes/no | Whether the microdrive permits the positioned device to be retracted. | ||
deviceRecoverable | Device can be recovered | yes/no | Whether the positioned device can be removed from the microdrive for recovery or reuse. | ||
deviceAttachmentMethod | Device attachment to microdrive | choice | one of clamp, screw, adhesive, friction_fit, shuttle_carrier, socket, other | How the positioned device is attached to the microdrive. | |
fixationMethod | Microdrive fixation method | choice | one of dental_cement, skull_screws, headcap, bone_anchor, adhesive, mechanical_clamp, other | How the microdrive is secured in its used configuration. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. |
Illustrative payload:
{
"controlMode": "text",
"travelRange": {
"value": 1,
"unit": "mm"
}
}
Slide, coverslip, or mounting support
- type code
MountingComponent· version 1.0.0 · schema
A glass slide, coverslip or other support used to mount a tissue section or specimen, with the number used, preparation and application method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"count": 1,
"preparation": "text"
}
Obturator
- type code
Obturator· version 1.0.1 · schema
A removable insert, such as a dummy cannula or stylet, that keeps a guide cannula or port patent between uses, with the number used, sterility and preparation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"count": 1,
"sterilityStatus": "sterile"
}
Other component
- type code
OtherComponent· version 1.0.1 · schema
A supporting component that does not fit any of the specific component roles, with the number used, sterility, surface treatment and preparation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
surfaceTreatment | Surface treatment or coating | text | Use-specific surface treatment or coating applied to this device or component. | ||
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"count": 1,
"sterilityStatus": "sterile"
}
Shielding material
- type code
ShieldingMaterial· version 1.0.1 · schema
A material used to shield an implant electrically or optically, such as conductive paint, copper mesh or light-blocking material, with the amount or number of pieces used and how it was applied.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "mL"
},
"mass": {
"value": 1,
"unit": "mg"
}
}
Agents and drugs
Active agent
- type code
ActiveAgent· version 1.0.0 · schema
The pharmacologically active substance of a formulation given or applied in a procedure, when no more specific drug role fits, with this agent’s own dose, concentration, dilution, volume or mass.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dose | Applied dose | quantity with unit | units g/kg, mg/kg, µg/kg, ng/kg; default {"unit": "mg/kg"} | This agent’s own dose in this record, normalized to body mass; never the mixture’s combined dose. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mg/mL"} | This agent’s own strength in the formulation as prepared, not the formulation’s overall strength. | |
dilution | Applied dilution | ratio | format ratio | Ratio by which this agent’s own source material was diluted to prepare it for this use. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume this agent itself contributed here — its own share of any total the parent records. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Absolute amount of this agent contributed here: weighed or fixed, not calculated per body mass. | |
preparation | Preparation | text | Prose about preparing this agent here. Row order already records addition order, and a recipe that must be followed belongs in a linked protocol. |
Illustrative payload:
{
"dose": {
"value": 1,
"unit": "mg/kg"
},
"concentration": {
"value": 1,
"unit": "mg/mL"
}
}
Anesthetic agent
- type code
AnestheticAgent· version 1.0.0 · schema
An anesthetic drug given for induction or maintenance, with this agent’s own dose, concentration and volume, also when it is one component of a cocktail. A vaporizer setting for an inhaled agent belongs on the event, not here.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dose | Applied dose | quantity with unit | units g/kg, mg/kg, µg/kg, ng/kg; default {"unit": "mg/kg"} | This agent’s own dose in this anesthetic, normalized to body mass; never the cocktail’s total. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mg/mL"} | This agent’s own strength in the solution as drawn up; a vaporizer setting belongs on the event. | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume this agent itself contributed to the mixture; an inhaled agent has no volume here. |
Illustrative payload:
{
"dose": {
"value": 1,
"unit": "mg/kg"
},
"concentration": {
"value": 1,
"unit": "mg/mL"
}
}
Anticoagulant
- type code
Anticoagulant· version 1.0.1 · schema
An anticoagulant such as heparin used to keep blood, catheters or delivery lines from clotting, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Hemostatic agent
- type code
HemostaticAgent· version 1.0.1 · schema
A material or agent applied to control bleeding, such as a gelatin sponge, bone wax or topical hemostat, with the amount or number of pieces used and how it was applied.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "mL"
},
"mass": {
"value": 1,
"unit": "mg"
}
}
Inhaled euthanasia agent
- type code
InhaledEuthanasiaAgent· version 1.0.1 · schema
A gas or inhalant used for euthanasia, such as CO2 or an overdose of isoflurane, with the applied concentration, flow rate and duration of exposure.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units % v/v, ppm; default {"unit": "% v/v"} | Concentration of this material in the formulation or mixture actually applied. | |
rate | Applied flow rate | quantity with unit | units L/min, mL/min, µL/min, nL/min; default {"unit": "mL/min"} | Flow rate at which this gas was applied or delivered. | |
duration | Application duration | quantity with unit | units d, h, min, s; default {"unit": "min"} | Duration for which this material was actively applied or delivered. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "% v/v"
},
"rate": {
"value": 1,
"unit": "mL/min"
}
}
Injected euthanasia agent
- type code
InjectedEuthanasiaAgent· version 1.0.1 · schema
An injectable drug used for euthanasia, such as a pentobarbital solution, with the applied dose, concentration, dilution, volume or mass.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dose | Applied dose | quantity with unit | units g/kg, mg/kg, µg/kg, ng/kg; default {"unit": "mg/kg"} | Dose of this material administered or applied in this usage. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"dose": {
"value": 1,
"unit": "mg/kg"
},
"concentration": {
"value": 1,
"unit": "mM"
}
}
Lesion agent
- type code
LesionAgent· version 1.0.1 · schema
A substance used to produce a chemical or excitotoxic lesion, such as ibotenic acid or 6-OHDA, with the applied dose, concentration, volume and application method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dose | Applied dose | quantity with unit | units g/kg, mg/kg, µg/kg, ng/kg; default {"unit": "mg/kg"} | Dose of this material administered or applied in this usage. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"dose": {
"value": 1,
"unit": "mg/kg"
},
"concentration": {
"value": 1,
"unit": "mM"
}
}
Pharmacological adjunct
- type code
PharmacologicalAdjuvant· version 1.0.0 · schema
A substance added alongside the main agent to modify its effect or delivery, such as a vasoconstrictor or an enzyme, with its own dose, concentration or activity units per volume and the reason it was added.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dose | Applied dose | quantity with unit | units g/kg, mg/kg, µg/kg, ng/kg; default {"unit": "mg/kg"} | Dose of this substance itself, per unit body mass, not of the mixture it was part of. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration this substance reached in the mixture as applied, after any dilution. | |
dilution | Applied dilution | ratio | format ratio | How far the source material was diluted to prepare what was applied here. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this substance itself that was added, not of the whole mixture. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this substance itself that was added, not of the whole mixture. | |
activityConcentration | Applied activity concentration | quantity with unit | units IU/mL, U/mL, USP units/mL; default {"unit": "IU/mL"} | Biological activity units of this substance per volume of the mixture as applied, not an infectious titer. | |
purpose | Purpose | choice | one of vasoconstriction, ph_buffering, block_prolongation, tissue_spread, irritation_reduction, autonomic_counteraction, sedation_deepening, other | Why this substance was added alongside the main agent. |
Illustrative payload:
{
"dose": {
"value": 1,
"unit": "mg/kg"
},
"concentration": {
"value": 1,
"unit": "mM"
}
}
Reversal agent
- type code
ReversalAgent· version 1.0.0 · schema
A drug given to reverse an anesthetic or sedative, such as atipamezole after medetomidine, with the applied dose, concentration and volume, the dose it was chosen against, and whether reversal was meant to be full or partial.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dose | Applied dose | quantity with unit | units g/kg, mg/kg, µg/kg, ng/kg; default {"unit": "mg/kg"} | Dose of this substance itself, per unit body mass, not of the mixture it was part of. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration this substance reached in the mixture as applied, after any dilution. | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this substance itself that was administered, not of the whole mixture. | |
relativeDoseBasis | Relative dose basis | choice | one of agonist_mass, agonist_volume, fixed_per_animal, titrated_to_effect, other | What this reversal dose was chosen against. | |
purpose | Purpose | choice | one of full, partial, other | Whether reversal was intended to be full or deliberately partial. |
Illustrative payload:
{
"dose": {
"value": 1,
"unit": "mg/kg"
},
"concentration": {
"value": 1,
"unit": "mM"
}
}
Supportive-care agent
- type code
SupportiveAgent· version 1.0.1 · schema
A drug given for supportive or perioperative care, such as an analgesic, anti-inflammatory, antibiotic or ophthalmic ointment, with the applied dose, concentration, dilution, volume or mass.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dose | Applied dose | quantity with unit | units g/kg, mg/kg, µg/kg, ng/kg; default {"unit": "mg/kg"} | Dose of this material administered or applied in this usage. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"dose": {
"value": 1,
"unit": "mg/kg"
},
"concentration": {
"value": 1,
"unit": "mM"
}
}
Biological and experimental payloads
Cell suspension
- type code
CellSuspension· version 1.0.1 · schema
A suspension of cells delivered into tissue, for example for transplantation, with the applied cell count and concentration, viability before application, volume and passage number of cultured cells.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
cellCount | Applied cell count | integer | ≥ 0 | Total number of cells applied in this usage. | |
cellConcentration | Applied cell concentration | quantity with unit | units cells/mL, cells/µL; default {"unit": "cells/µL"} | Cell concentration in the suspension actually applied. | |
viability | Cell viability | number | ≥ 0 and ≤ 100 | Measured viable-cell percentage immediately before application. | |
volume | Applied volume | quantity with unit | units mL, µL, nL; default {"unit": "µL"} | Volume of cell suspension applied. | |
passageNumber | Passage number at use | integer | ≥ 0 | Passage number of cultured cells at the time the suspension was prepared. | |
preparation | Preparation | text | Use-specific preparation of the cell suspension. |
Illustrative payload:
{
"cellCount": 1,
"cellConcentration": {
"value": 1,
"unit": "cells/µL"
}
}
Injected component
- type code
DeliveredComponent· version 1.0.1 · schema
One component of an injected or infused formulation when no more specific payload role fits, with its applied dose, concentration, volume, mass or count and its fraction of the final formulation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
dose | Applied dose | quantity with unit | units g/kg, mg/kg, µg/kg, ng/kg; default {"unit": "mg/kg"} | Dose of this material administered or applied in this usage. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
fraction | Fraction of applied formulation | number | ≥ 0 and ≤ 1 | Fraction of the final applied formulation contributed by this component, entered from 0 to 1 (for example, 0.5 for 50%). | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"dose": {
"value": 1,
"unit": "mg/kg"
},
"concentration": {
"value": 1,
"unit": "mM"
}
}
Neural tracer
- type code
NeuralTracer· version 1.0.1 · schema
An anterograde or retrograde tracer delivered into tissue to label neuronal projections, with the applied concentration, dilution, volume or mass and the application method, such as pressure injection or iontophoresis.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, mg/mL, µg/mL, % w/v, % v/v; default {"unit": "µg/mL"} | Concentration of the tracer in the applied formulation. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the tracer stock used in the applied formulation. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units mL, µL, nL; default {"unit": "nL"} | Volume of this tracer preparation applied. | |
mass | Applied mass | quantity with unit | units mg, µg, ng; default {"unit": "µg"} | Mass of tracer applied when that is the reported quantity. | |
preparation | Preparation | text | Use-specific preparation of the tracer. | ||
applicationMethod | Application method | text | How the tracer was applied in this usage. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "µg/mL"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Particle suspension
- type code
ParticleSuspension· version 1.0.1 · schema
A suspension of particles, such as fluorescent microspheres or nanoparticles, delivered into tissue, with the applied particle concentration or count, particle size and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied particle concentration | quantity with unit | units particles/mL, particles/µL, mg/mL, µg/mL, % w/v, % v/v; default {"unit": "particles/µL"} | Particle concentration in the suspension actually applied. | |
particleCount | Applied particle count | integer | ≥ 0 | Total particle count applied when known. | |
particleSize | Particle size | quantity with unit | units nm, µm, mm; default {"unit": "µm"} | Nominal or measured particle diameter for this suspension. | |
volume | Applied volume | quantity with unit | units mL, µL, nL; default {"unit": "µL"} | Volume of particle suspension applied. | |
preparation | Preparation | text | Use-specific preparation of the particle suspension. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "particles/µL"
},
"particleCount": 1
}
Viral-vector preparation
- type code
ViralComponent· version 1.0.0 · schema
A viral vector in the formulation actually injected, with the applied volume, dilution and the effective titer delivered, which can differ from the stock titer.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "nL"} | Applied volume of this component of the delivered formulation. | |
titer | Effective delivered titer | quantity with unit | units vg/mL, gc/mL, TU/mL, IU/mL, pfu/mL, FFU/mL, vp/mL; default {"unit": "vg/mL"} | Titer of this vector in the formulation actually delivered. | |
dilution | Applied dilution | ratio | format ratio | Dilution used to prepare the delivered formulation. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "nL"
},
"titer": {
"value": 1,
"unit": "vg/mL"
}
}
Fluids and vehicles
Administered fluid
- type code
AdministeredFluid· version 1.0.0 · schema
A fluid given to a subject, such as saline or lactated Ringer’s for fluid support, with the volume of this fluid given.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL; default {"unit": "mL"} | How much of this fluid was given, as its own share. It is not the event’s combined total, even when this is the only fluid and the numbers match. |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "mL"
}
}
Carrier gas
- type code
CarrierGas· version 1.0.0 · schema
The gas that carries an inhaled anesthetic or is supplied for breathing, such as oxygen or medical air, with the applied flow rate and concentration.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
rate | Applied flow rate | quantity with unit | units L/min, mL/min, µL/min, nL/min; default {"unit": "mL/min"} | Flow rate at which this gas was applied or delivered. | |
concentration | Applied concentration | quantity with unit | units % v/v, ppm; default {"unit": "% v/v"} | Concentration of this material in the formulation or mixture actually applied. |
Illustrative payload:
{
"rate": {
"value": 1,
"unit": "mL/min"
},
"concentration": {
"value": 1,
"unit": "% v/v"
}
}
Fluid additive
- type code
FluidAdditive· version 1.0.0 · schema
A substance added to a fluid, such as drinking water or a perfusion reservoir, with the concentration reached after mixing, the amount added, and whether an equal volume was withdrawn first.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "% w/v"} | Concentration this additive reached in the fluid that was delivered, after mixing. Not the strength of the concentrate or stock it was drawn from. | |
volume | Applied volume | quantity with unit | units L, mL, µL; default {"unit": "mL"} | Volume of this additive alone that was put into the fluid. Not the volume of the fluid it went into. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this additive alone that was put into the fluid, when mass rather than volume was the quantity actually measured. | |
replacementMethod | Replacement method | choice | one of replaced, added, not_recorded | Whether an equal volume was withdrawn before this additive went in, which decides whether the stated concentration was actually reached. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "% w/v"
},
"volume": {
"value": 1,
"unit": "mL"
}
}
Irrigation solution
- type code
IrrigationSolution· version 1.0.1 · schema
A solution used to rinse or keep tissue moist during a procedure, such as sterile saline or aCSF, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Vehicle
- type code
Vehicle· version 1.0.0 · schema
The solvent or carrier in which an active agent is dissolved or suspended, such as saline, DMSO or cyclodextrin, with the amount used and its pH, osmolality and sterilization as prepared.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material weighed out for the formulation applied in this record. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "% v/v"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Ratio by which this material’s own source fluid was diluted to prepare it for this use. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
pH | pH as prepared | number | ≥ 0 and ≤ 14 | pH of this material as prepared for this use, measured or set by the lab. | |
osmolality | Osmolality as prepared | quantity with unit | units mOsm/kg; default {"unit": "mOsm/kg"} | Osmolality of this material as prepared for this use, read on an osmometer. | |
sterilizationMethod | Sterilization method as prepared | choice | one of filter_sterilized, autoclaved, aseptic_handling_only, none, other | How the lab sterilized this material as prepared for this use. | |
preparation | Preparation | text | How this material was made up for this use. Row order already gives the addition order, and a recipe to be followed belongs in a linked protocol. |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "mL"
},
"mass": {
"value": 1,
"unit": "mg"
}
}
Reagents and labels
Blocking reagent
- type code
BlockingReagent· version 1.0.1 · schema
A reagent used to block nonspecific binding before labeling, such as normal serum or BSA, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Buffer
- type code
Buffer· version 1.0.1 · schema
A buffer used during specimen processing, such as PBS or Tris-buffered saline, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Clearing reagent
- type code
ClearingReagent· version 1.0.1 · schema
A reagent used to render tissue optically transparent, as in CLARITY, iDISCO or CUBIC protocols, with the applied concentration, dilution, volume and application method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Dehydration reagent
- type code
DehydrationReagent· version 1.0.1 · schema
A reagent used to dehydrate tissue, such as a graded ethanol or methanol series, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Detection reagent
- type code
DetectionReagent· version 1.0.1 · schema
A reagent used to detect or amplify a label, such as an avidin-biotin complex, DAB substrate or tyramide amplification reagent, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Fixative
- type code
Fixative· version 1.0.1 · schema
A fixative used to preserve tissue, such as paraformaldehyde for perfusion or immersion fixation, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Hybridization probe
- type code
HybridizationProbe· version 1.0.1 · schema
A nucleic acid probe used for in situ hybridization, such as an RNAscope or FISH probe, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Permeabilization reagent
- type code
PermeabilizationReagent· version 1.0.1 · schema
A reagent used to permeabilize tissue or cell membranes for labeling, such as Triton X-100 or saponin, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Primary immunolabeling reagent
- type code
PrimaryLabel· version 1.0.1 · schema
A primary antibody or other immunolabeling reagent that binds the target directly, with the working concentration or dilution and volume applied.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Processing reagent
- type code
ProcessingReagent· version 1.0.1 · schema
A reagent used in specimen processing when no more specific reagent role fits, with the applied concentration, dilution, volume or mass and application method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Retrieval reagent
- type code
RetrievalReagent· version 1.0.1 · schema
A reagent used for antigen or epitope retrieval, such as citrate buffer for heat-induced retrieval, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Secondary immunolabeling reagent
- type code
SecondaryLabel· version 1.0.1 · schema
A secondary antibody or other reagent that binds the primary label, typically conjugated to a fluorophore or enzyme, with the working concentration or dilution and volume applied.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Stain or dye
- type code
StainDye· version 1.0.1 · schema
A histological stain or dye, such as Nissl, DAPI or hematoxylin, with the applied concentration, dilution, volume or mass and application method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Wash solution
- type code
WashSolution· version 1.0.1 · schema
A solution used to rinse tissue between processing steps, such as PBS or PBS with Tween, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Media and embedding
Cryoprotectant
- type code
Cryoprotectant· version 1.0.1 · schema
A cryoprotective solution, such as sucrose or glycerol, used to protect tissue before freezing or sectioning, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Embedding medium
- type code
EmbeddingMedium· version 1.0.1 · schema
A medium in which tissue is embedded for sectioning, such as paraffin, agarose or OCT, with the amount used, preparation and application method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "mL"
},
"mass": {
"value": 1,
"unit": "mg"
}
}
Index-matching medium
- type code
IndexMatchingMedium· version 1.0.1 · schema
A medium matched to the refractive index of cleared tissue or of the objective for imaging, with the applied concentration, volume, preparation and application method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"volume": {
"value": 1,
"unit": "mL"
}
}
Processing or collection medium
- type code
Medium· version 1.0.1 · schema
A medium used to collect or process tissue or cells when no more specific media role fits, such as culture medium or ice-cold cutting solution, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Mounting medium
- type code
MountingMedium· version 1.0.1 · schema
A medium used to mount sections under a coverslip, with or without antifade or a nuclear counterstain, with the applied volume, concentration, preparation and application method.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "mL"
},
"concentration": {
"value": 1,
"unit": "mM"
}
}
Storage medium
- type code
StorageMedium· version 1.0.1 · schema
A medium in which tissue or specimens are stored, such as PBS with sodium azide or an antifreeze solution, with the applied concentration, dilution and volume.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Collection and supplies
Collection additive
- type code
CollectionAdditive· version 1.0.1 · schema
A substance added to a collection tube or medium at collection, such as an anticoagulant or protease inhibitor, with the applied concentration, dilution, volume or mass.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Applied concentration | quantity with unit | units M, mM, µM, nM, g/L, mg/mL, µg/mL, ng/mL, mg/L, µg/L, ng/L, % w/v, % v/v; default {"unit": "mM"} | Concentration of this material in the formulation or mixture actually applied. | |
dilution | Applied dilution | ratio | format ratio | Dilution of the source material used to prepare the applied formulation, expressed as a ratio. | |
dilution.numerator | numerator | number | yes | > 0 | |
dilution.denominator | denominator | number | yes | > 0 | |
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"concentration": {
"value": 1,
"unit": "mM"
},
"dilution": {
"numerator": 1,
"denominator": 10
}
}
Collection container
- type code
CollectionContainer· version 1.0.1 · schema
A tube, vial, cassette or other container used to collect or hold a specimen, with the number used, sterility and any preparation.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. |
Illustrative payload:
{
"count": 1,
"sterilityStatus": "sterile"
}
Processing supply
- type code
ProcessingSupply· version 1.0.1 · schema
A disposable item used in specimen processing, such as a filter, needle or blade, with the number used, sterility, sterilization or disinfection method and size or gauge.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
sterilityStatus | Sterility status | choice | one of sterile, non_sterile, unknown | Sterility status of this material when it was used. | |
sterilizationMethod | Sterilization method | choice | one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknown | Method used to sterilize this material. | |
disinfectionMethod | Disinfection method | choice | one of alcohol, chlorhexidine, povidone_iodine, other, none, unknown | Method used to disinfect this material. | |
size | Size used | text | Use-specific size or gauge when it is not already part of the selected catalog or stock identity. |
Illustrative payload:
{
"count": 1,
"sterilityStatus": "sterile"
}
Surgical supply
- type code
SurgicalSupply· version 1.0.0 · schema
A disposable item used during surgery, such as a suture, swab or drape, recorded with the number used.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. |
Illustrative payload:
{
"count": 1
}
Other
Other
- type code
Other· version 1.0.1 · schema
A material that fits none of the specific roles, with the amount or number used, preparation and application method. Choose a specific role whenever one applies.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
volume | Applied volume | quantity with unit | units L, mL, µL, nL; default {"unit": "mL"} | Volume of this material used in this record. When the parent records a total volume, this is this material’s share of that total. | |
mass | Applied mass | quantity with unit | units kg, g, mg, µg, ng; default {"unit": "mg"} | Mass of this material used in this record. | |
count | Count used | integer | ≥ 1 | Number of items of this material used in this record. | |
preparation | Preparation | text | Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment. | ||
applicationMethod | Application method | text | How this material was applied in this usage. |
Illustrative payload:
{
"volume": {
"value": 1,
"unit": "mL"
},
"mass": {
"value": 1,
"unit": "mg"
}
}