There are three main types of biomaterials: BioSourceData
SampleData
ExtractData
BioMaterialData
The BioSourceData
The MeasuredBioMaterialData
All measured biomaterial have at least one event associated with them, the creation event, which holds information about the creation of the biomaterial. A measured biomaterial can be created in three ways:
From a single item of the same type or the parent type. Biosource is the parent type of
samples and sample is the parent type of extracts. The parentType
property must be set to the correct parent type and the parent property
is set to point to the parent item. The parent information
is also always duplicated in the sources collection of the BioMaterialEventData
From multiple items of the same type, i.e pooling. In this case the parentType property is set, but the parent property is null. All source biomaterials are contained in the sources collection. The core is still responsible for keeping everything synchronized and to update remaining quantities.
As a standalone biomaterial without parents. The parentType property should be null, as should the parent property and the sources collection.
Biomaterial (except biosource) may optionally be placed on BioPlateData
PlateGeometryData
BioWellData
The bioplate must be of a specific BioPlateTypeData
Unlocked: Wells are unlocked and the biomaterial may be changed any number of times.
Locked-after-move: The well is locked after it has been used one time and the biomaterial that was put in it has been moved to another plate.
Locked-after-add: The well is locked after biomaterial has been put into it. It is not possible to remove the biomaterial.
Locked-after-create: The well is locked once it has been created. Biomaterial must be put into wells before the plate is saved to the database.
An event represents something that happened to one or more biomaterials, for example
the creation of another biomaterial. The BioMaterialEventData
Creation event: This event represents the creation of a (measured) biomaterial. The sources collection contains information about the biomaterials that were used to create the new biomaterial. All sources must be of the same type. There can only be one source of the parent type. These rules are maintained by the core.
Bioassay event: This event represents the creation
of a bioassay. This event type is needed because we want to keep track
of quantities for extracts. This event has a PhysicalBioAssayData
BioMaterialEventSourceData
TagData
Other event: This event represents some other important information about a single biomaterial that affected the remaining quantity. This event type doesn't have any sources.
It is also possible to register events that applies to one or more
bioplates using the BioPlateEventData
BioPlateEventParticipantData
BioMaterialEventData
to a BioPlateEventParticipantData
.
This will make it easier to keep track of the history of individual biomaterial items.
Biomaterial events that are linked in this way are also automatically updated if the
bioplate event is modified (eg. selecting a protocol, event date, etc.).