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

  1. How to use this family
  2. Quick type map
  3. Devices
    1. Blood-pressure sensor
    2. Cannula
    3. Catheter
    4. Cranial window
    5. ECoG array
    6. Electrode assembly
    7. Fluid-delivery line
    8. Other device
    9. GRIN lens
    10. Ground electrode
    11. Headpost
    12. Microdialysis probe
    13. Multi-electrode array
    14. Nerve cuff
    15. Optic fiber
    16. Osmotic pump
    17. Patch pipette
    18. Prism
    19. Reference electrode
    20. Respiratory sensor
    21. Silicon probe
    22. Single-wire electrode
    23. Stimulating electrode
    24. Temperature probe or sensor
  4. Components and supporting materials
    1. Adhesive, cement, or sealant
    2. Baseplate
    3. Coating
    4. Connector component
    5. Anchor screw, pin, or fastener
    6. Fixed implant carrier or shuttle
    7. Headcap assembly
    8. Manual microdrive
    9. Motorized microdrive
    10. Slide, coverslip, or mounting support
    11. Obturator
    12. Other component
    13. Shielding material
  5. Agents and drugs
    1. Active agent
    2. Anesthetic agent
    3. Anticoagulant
    4. Hemostatic agent
    5. Inhaled euthanasia agent
    6. Injected euthanasia agent
    7. Lesion agent
    8. Pharmacological adjunct
    9. Reversal agent
    10. Supportive-care agent
  6. Biological and experimental payloads
    1. Cell suspension
    2. Injected component
    3. Neural tracer
    4. Particle suspension
    5. Viral-vector preparation
  7. Fluids and vehicles
    1. Administered fluid
    2. Carrier gas
    3. Fluid additive
    4. Irrigation solution
    5. Vehicle
  8. Reagents and labels
    1. Blocking reagent
    2. Buffer
    3. Clearing reagent
    4. Dehydration reagent
    5. Detection reagent
    6. Fixative
    7. Hybridization probe
    8. Permeabilization reagent
    9. Primary immunolabeling reagent
    10. Processing reagent
    11. Retrieval reagent
    12. Secondary immunolabeling reagent
    13. Stain or dye
    14. Wash solution
  9. Media and embedding
    1. Cryoprotectant
    2. Embedding medium
    3. Index-matching medium
    4. Processing or collection medium
    5. Mounting medium
    6. Storage medium
  10. Collection and supplies
    1. Collection additive
    2. Collection container
    3. Processing supply
    4. Surgical supply
  11. Other
    1. Other

How to use this family

  • materialusage: set type to a type code below and send its properties in details_json.
  • materialusagetemplate: set type to a type code below and send its properties in details_json.
  • Every version is published at https://www.brainstem.org/schemas/MaterialUsage/<Type>/<version>.json and never changes; https://www.brainstem.org/schemas/MaterialUsage/<Type>.json is the current version and https://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 codeTitleGroupVersionRequired propertiesSchema
ActiveAgentActive agentAgents and drugs1.0.0none1.0.0.json
AdhesiveSealantAdhesive, cement, or sealantComponents and supporting materials1.0.0none1.0.0.json
AdministeredFluidAdministered fluidFluids and vehicles1.0.0none1.0.0.json
AnestheticAgentAnesthetic agentAgents and drugs1.0.0none1.0.0.json
AnticoagulantAnticoagulantAgents and drugs1.0.1none1.0.1.json
BaseplateBaseplateComponents and supporting materials1.0.0none1.0.0.json
BlockingReagentBlocking reagentReagents and labels1.0.1none1.0.1.json
BloodPressureSensorBlood-pressure sensorDevices1.0.1none1.0.1.json
BufferBufferReagents and labels1.0.1none1.0.1.json
CannulaCannulaDevices1.0.1none1.0.1.json
CarrierGasCarrier gasFluids and vehicles1.0.0none1.0.0.json
CatheterCatheterDevices1.0.1none1.0.1.json
CellSuspensionCell suspensionBiological and experimental payloads1.0.1none1.0.1.json
ClearingReagentClearing reagentReagents and labels1.0.1none1.0.1.json
CoatingCoatingComponents and supporting materials1.0.0none1.0.0.json
CollectionAdditiveCollection additiveCollection and supplies1.0.1none1.0.1.json
CollectionContainerCollection containerCollection and supplies1.0.1none1.0.1.json
ConnectorComponentConnector componentComponents and supporting materials1.0.1none1.0.1.json
CranialWindowCranial windowDevices1.0.1none1.0.1.json
CryoprotectantCryoprotectantMedia and embedding1.0.1none1.0.1.json
DehydrationReagentDehydration reagentReagents and labels1.0.1none1.0.1.json
DeliveredComponentInjected componentBiological and experimental payloads1.0.1none1.0.1.json
DetectionReagentDetection reagentReagents and labels1.0.1none1.0.1.json
EcogArrayECoG arrayDevices1.0.0none1.0.0.json
ElectrodeAssemblyElectrode assemblyDevices1.0.0none1.0.0.json
EmbeddingMediumEmbedding mediumMedia and embedding1.0.1none1.0.1.json
FastenerAnchor screw, pin, or fastenerComponents and supporting materials1.0.0none1.0.0.json
FixativeFixativeReagents and labels1.0.1none1.0.1.json
FixedPositioningAssemblyFixed implant carrier or shuttleComponents and supporting materials1.0.0none1.0.0.json
FluidAdditiveFluid additiveFluids and vehicles1.0.0none1.0.0.json
FluidDeliveryLineFluid-delivery lineDevices1.0.1none1.0.1.json
GenericDeviceOther deviceDevices1.0.0none1.0.0.json
GrinLensGRIN lensDevices1.0.1none1.0.1.json
GroundElectrodeGround electrodeDevices1.0.1none1.0.1.json
HeadcapAssemblyHeadcap assemblyComponents and supporting materials1.0.1none1.0.1.json
HeadpostHeadpostDevices1.0.1none1.0.1.json
HemostaticAgentHemostatic agentAgents and drugs1.0.1none1.0.1.json
HybridizationProbeHybridization probeReagents and labels1.0.1none1.0.1.json
IndexMatchingMediumIndex-matching mediumMedia and embedding1.0.1none1.0.1.json
InhaledEuthanasiaAgentInhaled euthanasia agentAgents and drugs1.0.1none1.0.1.json
InjectedEuthanasiaAgentInjected euthanasia agentAgents and drugs1.0.1none1.0.1.json
IrrigationSolutionIrrigation solutionFluids and vehicles1.0.1none1.0.1.json
LesionAgentLesion agentAgents and drugs1.0.1none1.0.1.json
ManualMicrodriveManual microdriveComponents and supporting materials1.0.0none1.0.0.json
MediumProcessing or collection mediumMedia and embedding1.0.1none1.0.1.json
MicrodialysisProbeMicrodialysis probeDevices1.0.1none1.0.1.json
MotorizedMicrodriveMotorized microdriveComponents and supporting materials1.0.0none1.0.0.json
MountingComponentSlide, coverslip, or mounting supportComponents and supporting materials1.0.0none1.0.0.json
MountingMediumMounting mediumMedia and embedding1.0.1none1.0.1.json
MultiElectrodeArrayMulti-electrode arrayDevices1.0.1none1.0.1.json
NerveCuffNerve cuffDevices1.0.1none1.0.1.json
NeuralTracerNeural tracerBiological and experimental payloads1.0.1none1.0.1.json
ObturatorObturatorComponents and supporting materials1.0.1none1.0.1.json
OpticFiberOptic fiberDevices1.0.0none1.0.0.json
OsmoticPumpOsmotic pumpDevices1.0.0none1.0.0.json
OtherOtherOther1.0.1none1.0.1.json
OtherComponentOther componentComponents and supporting materials1.0.1none1.0.1.json
ParticleSuspensionParticle suspensionBiological and experimental payloads1.0.1none1.0.1.json
PatchPipettePatch pipetteDevices1.0.1none1.0.1.json
PermeabilizationReagentPermeabilization reagentReagents and labels1.0.1none1.0.1.json
PharmacologicalAdjuvantPharmacological adjunctAgents and drugs1.0.0none1.0.0.json
PrimaryLabelPrimary immunolabeling reagentReagents and labels1.0.1none1.0.1.json
PrismPrismDevices1.0.1none1.0.1.json
ProcessingReagentProcessing reagentReagents and labels1.0.1none1.0.1.json
ProcessingSupplyProcessing supplyCollection and supplies1.0.1none1.0.1.json
ReferenceElectrodeReference electrodeDevices1.0.1none1.0.1.json
RespiratorySensorRespiratory sensorDevices1.0.1none1.0.1.json
RetrievalReagentRetrieval reagentReagents and labels1.0.1none1.0.1.json
ReversalAgentReversal agentAgents and drugs1.0.0none1.0.0.json
SecondaryLabelSecondary immunolabeling reagentReagents and labels1.0.1none1.0.1.json
ShieldingMaterialShielding materialComponents and supporting materials1.0.1none1.0.1.json
SiliconProbeSilicon probeDevices1.0.1none1.0.1.json
SingleWireElectrodeSingle-wire electrodeDevices1.0.1none1.0.1.json
StainDyeStain or dyeReagents and labels1.0.1none1.0.1.json
StimulatingElectrodeStimulating electrodeDevices1.0.1none1.0.1.json
StorageMediumStorage mediumMedia and embedding1.0.1none1.0.1.json
SupportiveAgentSupportive-care agentAgents and drugs1.0.1none1.0.1.json
SurgicalSupplySurgical supplyCollection and supplies1.0.0none1.0.0.json
TemperatureSensorTemperature probe or sensorDevices1.0.0none1.0.0.json
VehicleVehicleFluids and vehicles1.0.0none1.0.0.json
ViralComponentViral-vector preparationBiological and experimental payloads1.0.0none1.0.0.json
WashSolutionWash solutionReagents and labels1.0.1none1.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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
tipPreparationTip preparationchoice one of factory, cut, beveled, polished, other, unknownFinal 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
endPreparationEnd preparationchoice one of factory, cut, beveled, flared, other, unknownFinal 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
countCount usedinteger ≥ 1Number of arrays used in this record, counted as whole arrays rather than the contacts on them.
preparationPreparationtext  Use-specific preparation of the array before placement, such as trimming the substrate or soaking.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
countCount usedinteger ≥ 1Number of assemblies used in this record, counted as whole assemblies rather than the electrodes on them.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
deadVolumeDead volumequantity with unit units mL, µL, nL; default {"unit": "µL"}Internal volume retained in the configured line.
primingVolumePriming volumequantity with unit units mL, µL, nL; default {"unit": "µL"}Volume used to prime the line before delivery.
flushVolumeFlush volumequantity with unit units mL, µL, nL; default {"unit": "µL"}Volume used to flush the line for this use.
endPreparationEnd preparationtext  Preparation of the delivery end before use.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of the line when used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  Use-specific surface treatment or coating applied to this device or component.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
tipPreparationTip preparationchoice one of factory, cut, polished, other, unknownFinal preparation of the device tip for this use.
tipShapeTip shapetext  Final shape of the lens tip used.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
tipPreparationTip preparationchoice one of factory, cut, stripped, beveled, polished, other, unknownFinal preparation of the device tip for this use.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
primingVolumePriming volumequantity with unit units mL, µL, nL; default {"unit": "µL"}Volume used to prime the probe before use.
membranePreparationMembrane preparationtext  Use-specific conditioning or preparation of the dialysis membrane.
recoveryMeasured relative recoverynumber ≥ 0 and ≤ 100Measured relative analyte recovery for this probe, expressed as a percentage.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of the probe when used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
preparationPreparationtext  Use-specific preparation of the array before placement.
surfaceTreatmentSurface treatment or coatingtext  Use-specific treatment applied to the array or recording contacts.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of the array when used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
lengthPrepared lengthquantity 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.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
tipPreparationTip preparationchoice one of factory, cleaved, polished, tapered, other, unknownFinal preparation of the device tip for this use.
tipShapeTip shapetext  Final shape of the device tip used.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
tipPreparationTip preparationchoice one of factory, pulled, fire_polished, coated, other, unknownFinal preparation of the pipette tip for this use.
surfaceTreatmentSurface treatment or coatingtext  Use-specific treatment applied to the pipette surface.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of the pipette when used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
tipPreparationTip preparationchoice one of factory, cut, stripped, beveled, polished, other, unknownFinal preparation of the device tip for this use.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
tipPreparationTip preparationchoice one of factory, cut, stripped, beveled, polished, other, unknownFinal preparation of the device tip for this use.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
tipPreparationTip preparationchoice one of factory, cut, stripped, beveled, polished, other, unknownFinal preparation of the stimulating surface or tip.
surfaceTreatmentSurface treatment or coatingtext  Use-specific treatment applied to the electrode surface.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of the electrode when used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
mixingRatioMixing ratioratio format ratioComponent ratio used to prepare a multi-part material.
mixingRatio.numeratornumeratornumberyes> 0 
mixingRatio.denominatordenominatornumberyes> 0 
applicationMethodApplication methodtext  How this material was applied in this usage.
areaApplied areatext  Location or surface where this material was applied.
curingMethodCuring methodchoice one of self_cured, air_dried, heat_cured, uv_cured, chemical_cure, none, otherCuring, drying, rinsing, or other post-application treatment.
curingDurationCuring durationquantity with unit units d, h, min, s; default {"unit": "min"}Duration allowed for curing, drying, or another post-treatment.
curingTemperatureCuring temperaturequantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
applicationMethodApplication methodtext  How this material was applied in this usage.
areaCoated areatext  Part of the device or component that was coated.
concentrationApplied concentrationquantity 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.
numberOfCoatsNumber of coatsinteger ≥ 1Number 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sizeSize usedtext  Use-specific size or gauge when it is not already part of the selected catalog or stock identity.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
deviceRecoverableDevice can be recoveredyes/no  Whether the positioned device can be removed from the carrier for recovery or reuse.
deviceAttachmentMethodDevice attachment to carrierchoice one of clamp, screw, adhesive, friction_fit, shuttle_carrier, socket, otherHow the positioned device is attached to the carrier or shuttle.
fixationMethodCarrier fixation methodchoice one of dental_cement, skull_screws, headcap, bone_anchor, adhesive, mechanical_clamp, otherHow the carrier or shuttle is secured in its used configuration.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
actuationMechanismDrive mechanismtext  Manual mechanism used to advance or retract the implanted device.
travelRangeMicrodrive travel rangequantity with unit units nm, µm, mm; default {"unit": "mm"}Usable range over which the microdrive can move the positioned device.
movementResolutionMicrodrive step size or resolutionquantity with unit units nm, µm, mm; default {"unit": "µm"}Smallest position increment reliably achievable by the microdrive.
travelPerTurnTravel per full turnquantity with unit units nm, µm, mm; default {"unit": "µm"}Distance the positioned device travels per full turn of the drive screw.
retractableDevice can be retractedyes/no  Whether the microdrive permits the positioned device to be retracted.
deviceRecoverableDevice can be recoveredyes/no  Whether the positioned device can be removed from the microdrive for recovery or reuse.
deviceAttachmentMethodDevice attachment to microdrivechoice one of clamp, screw, adhesive, friction_fit, shuttle_carrier, socket, otherHow the positioned device is attached to the microdrive.
fixationMethodMicrodrive fixation methodchoice one of dental_cement, skull_screws, headcap, bone_anchor, adhesive, mechanical_clamp, otherHow the microdrive is secured in its used configuration.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
controlModeControl modetext  How movement of the motorized microdrive is controlled.
travelRangeMicrodrive travel rangequantity with unit units nm, µm, mm; default {"unit": "mm"}Usable range over which the microdrive can move the positioned device.
movementResolutionMicrodrive step size or resolutionquantity with unit units nm, µm, mm; default {"unit": "µm"}Smallest position increment reliably achievable by the microdrive.
rateMicrodrive movement ratequantity 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.
travelPerTurnTravel per full turnquantity with unit units nm, µm, mm; default {"unit": "µm"}Distance the positioned device travels per full turn of the drive screw.
retractableDevice can be retractedyes/no  Whether the microdrive permits the positioned device to be retracted.
deviceRecoverableDevice can be recoveredyes/no  Whether the positioned device can be removed from the microdrive for recovery or reuse.
deviceAttachmentMethodDevice attachment to microdrivechoice one of clamp, screw, adhesive, friction_fit, shuttle_carrier, socket, otherHow the positioned device is attached to the microdrive.
fixationMethodMicrodrive fixation methodchoice one of dental_cement, skull_screws, headcap, bone_anchor, adhesive, mechanical_clamp, otherHow the microdrive is secured in its used configuration.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
surfaceTreatmentSurface treatment or coatingtext  Use-specific surface treatment or coating applied to this device or component.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
countCount usedinteger ≥ 1Number of items of this material used in this record.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
doseApplied dosequantity 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.
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioRatio by which this agent’s own source material was diluted to prepare it for this use.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
massApplied massquantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
doseApplied dosequantity 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.
concentrationApplied concentrationquantity 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.
volumeApplied volumequantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
countCount usedinteger ≥ 1Number of items of this material used in this record.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity with unit units % v/v, ppm; default {"unit": "% v/v"}Concentration of this material in the formulation or mixture actually applied.
rateApplied flow ratequantity 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.
durationApplication durationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
doseApplied dosequantity 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.
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
doseApplied dosequantity 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.
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
doseApplied dosequantity 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.
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioHow far the source material was diluted to prepare what was applied here.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity with unit units L, mL, µL, nL; default {"unit": "mL"}Volume of this substance itself that was added, not of the whole mixture.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this substance itself that was added, not of the whole mixture.
activityConcentrationApplied activity concentrationquantity 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.
purposePurposechoice one of vasoconstriction, ph_buffering, block_prolongation, tissue_spread, irritation_reduction, autonomic_counteraction, sedation_deepening, otherWhy 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
doseApplied dosequantity 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.
concentrationApplied concentrationquantity 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.
volumeApplied volumequantity with unit units L, mL, µL, nL; default {"unit": "mL"}Volume of this substance itself that was administered, not of the whole mixture.
relativeDoseBasisRelative dose basischoice one of agonist_mass, agonist_volume, fixed_per_animal, titrated_to_effect, otherWhat this reversal dose was chosen against.
purposePurposechoice one of full, partial, otherWhether 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
doseApplied dosequantity 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.
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
cellCountApplied cell countinteger ≥ 0Total number of cells applied in this usage.
cellConcentrationApplied cell concentrationquantity with unit units cells/mL, cells/µL; default {"unit": "cells/µL"}Cell concentration in the suspension actually applied.
viabilityCell viabilitynumber ≥ 0 and ≤ 100Measured viable-cell percentage immediately before application.
volumeApplied volumequantity with unit units mL, µL, nL; default {"unit": "µL"}Volume of cell suspension applied.
passageNumberPassage number at useinteger ≥ 0Passage number of cultured cells at the time the suspension was prepared.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
doseApplied dosequantity 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.
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
countCount usedinteger ≥ 1Number of items of this material used in this record.
fractionFraction of applied formulationnumber ≥ 0 and ≤ 1Fraction of the final applied formulation contributed by this component, entered from 0 to 1 (for example, 0.5 for 50%).
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the tracer stock used in the applied formulation.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity with unit units mL, µL, nL; default {"unit": "nL"}Volume of this tracer preparation applied.
massApplied massquantity with unit units mg, µg, ng; default {"unit": "µg"}Mass of tracer applied when that is the reported quantity.
preparationPreparationtext  Use-specific preparation of the tracer.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied particle concentrationquantity 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.
particleCountApplied particle countinteger ≥ 0Total particle count applied when known.
particleSizeParticle sizequantity with unit units nm, µm, mm; default {"unit": "µm"}Nominal or measured particle diameter for this suspension.
volumeApplied volumequantity with unit units mL, µL, nL; default {"unit": "µL"}Volume of particle suspension applied.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity with unit units L, mL, µL, nL; default {"unit": "nL"}Applied volume of this component of the delivered formulation.
titerEffective delivered titerquantity 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.
dilutionApplied dilutionratio format ratioDilution used to prepare the delivered formulation.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
rateApplied flow ratequantity 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.
concentrationApplied concentrationquantity 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
volumeApplied volumequantity 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.
massApplied massquantity 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.
replacementMethodReplacement methodchoice one of replaced, added, not_recordedWhether 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material weighed out for the formulation applied in this record.
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioRatio by which this material’s own source fluid was diluted to prepare it for this use.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
pHpH as preparednumber ≥ 0 and ≤ 14pH of this material as prepared for this use, measured or set by the lab.
osmolalityOsmolality as preparedquantity with unit units mOsm/kg; default {"unit": "mOsm/kg"}Osmolality of this material as prepared for this use, read on an osmometer.
sterilizationMethodSterilization method as preparedchoice one of filter_sterilized, autoclaved, aseptic_handling_only, none, otherHow the lab sterilized this material as prepared for this use.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
volumeApplied volumequantity 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.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity 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.
concentrationApplied concentrationquantity 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.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationApplied concentrationquantity 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.
dilutionApplied dilutionratio format ratioDilution of the source material used to prepare the applied formulation, expressed as a ratio.
dilution.numeratornumeratornumberyes> 0 
dilution.denominatordenominatornumberyes> 0 
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
preparationPreparationtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number of items of this material used in this record.
sterilityStatusSterility statuschoice one of sterile, non_sterile, unknownSterility status of this material when it was used.
sterilizationMethodSterilization methodchoice one of autoclave, ethylene_oxide, gamma_irradiation, other, none, unknownMethod used to sterilize this material.
disinfectionMethodDisinfection methodchoice one of alcohol, chlorhexidine, povidone_iodine, other, none, unknownMethod used to disinfect this material.
sizeSize usedtext  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.

PropertyTitleShapeRequiredAllowed valuesMeaning
countCount usedinteger ≥ 1Number 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.

PropertyTitleShapeRequiredAllowed valuesMeaning
volumeApplied volumequantity 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.
massApplied massquantity with unit units kg, g, mg, µg, ng; default {"unit": "mg"}Mass of this material used in this record.
countCount usedinteger ≥ 1Number of items of this material used in this record.
preparationPreparationtext  Use-specific preparation of this material, such as mixing, dilution, trimming, or another treatment.
applicationMethodApplication methodtext  How this material was applied in this usage.

Illustrative payload:

{
    "volume": {
        "value": 1,
        "unit": "mL"
    },
    "mass": {
        "value": 1,
        "unit": "mg"
    }
}