BiospecimenRetention
Whether biological samples are kept after their first use, and whether the retained samples include DNA.
- Kind
- Concrete class
- Group
- Study design
- Attributes
- 8, 4 required
- NCI code
- C215505
Official definition
The continued possession, cataloging, and storage of collected biological specimens beyond their initial use.
In practice
In a protocol document: The sections on future use of samples and on genetics.
Attributes
8 attributes, 4 of them required by the USDM API schema.
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the biospecimen retention. |
| label | string | cardinality 0..1 | The short descriptive designation for the biospecimen retention. |
| description | string | cardinality 0..1 | A narrative representation of the biospecimen retention. |
| isRetainedrequired | boolean | cardinality 1 | An indication as to whether biospecimens were retained. |
| includesDNA | boolean | cardinality 0..1 | An indication as to whether retained biospecimens contain DNA. |
| extensionAttributes | ExtensionAttribute | cardinality 0..* | Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model. |
| instanceTyperequired | string | cardinality 1 | The name of the class, carried by every object in a USDM JSON file. Added by the API; not part of the logical model. |
Smallest valid BiospecimenRetention
The attributes a JSON file must carry for a BiospecimenRetention, and the kind of value each takes. This is the shape, with types named in place of values. Everything else in the table above is optional.
BiospecimenRetention, required attributes only
{
"id": "BiospecimenRetention_1",
"name": string,
"isRetained": boolean,
"instanceType": "BiospecimenRetention"
}
Where BiospecimenRetention is used
These classes hold or point to a BiospecimenRetention.
- StudyDesign.biospecimenRetentionsnested
Related classes
Other classes in study design: