Specimen

Represents a sample used for analysis. This object is available in API version 64.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

BodySiteId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The body site code set bundle associated with a specimen that represents the anatomical collection site. This field is a relationship field.
Relationship Name: BodySite
Refers To: CodeSet

CaseId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The case associated with the specimen. This field is a relationship field.
Relationship Name: Case
Refers To: Case

CollectionDeviceCodeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The device code set bundle associated with a specimen that represents the device used to collect the specimen. For example, SST tube, red top tube, or 100-mL sterile polycup. This field is a relationship field.
Relationship Name: CollectionDeviceCode
Refers To: CodeSet

CollectionDuration

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total time period over which the specimen was collected.

CollectionDurationUomId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measure of the collection duration. This field is a relationship field.
Relationship Name: CollectionDurationUom
Refers To: UnitOfMeasure

CollectionEndDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date and time of the collection from the specimen.

CollectionMethodCodeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The method code set bundle associated with a specimen that represents the method used to collect the specimen. For example, Biopsy. This field is a relationship field.
Relationship Name: CollectionMethodCode
Refers To: CodeSet

CollectionQuantity

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The quantity of specimen collected. For example, the volume of a blood sample, or the physical measurement of an anatomic pathology sample.

CollectionQuantityUomId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measure for collected quantity. This field is a relationship field.
Relationship Name: CollectionQuantityUom
Refers To: UnitOfMeasure

CollectionStartDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The start date and time of the collection from the specimen.

CollectorId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The account of the healthcare provider that collected the specimen. This field is a polymorphic relationship field.
Relationship Name: Collector
Refers To: Account, HealthcareProvider

ConditionCodeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The condition code set bundle associated with a specimen that represents the state of the specimen. This field is a relationship field.
Relationship Name: ConditionCode
Refers To: CodeSetBundle

FastingDuration

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: The total time period over which the individual fasted before sample collection.

FastingDurationUomId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Represents the unit of measure for the fasting duration. This field is a relationship field.
Relationship Name: FastingDurationUom
Refers To: UnitOfMeasure

FastingStatusCodeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The fasting status code set bundle associated with specimen that represents the fasting status of the individual from whom the specimen was collected. This field is a relationship field.
Relationship Name: FastingStatusCode
Refers To: CodeSet

FeatureCodeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The feature code set bundle associated with a specimen that represents the type of physical feature or landmark of a specimen, which is highlighted for context by the collector. This field is a relationship field.
Relationship Name: FeatureCode
Refers To: CodeSetBundle

GroupingMethod

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies whether the specimen is part of a group or pooled with other specimens.
Default value: Grouped
Possible values:
- Grouped
- Pooled

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Name of the specimen.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user who owns this record. This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

ReceivedDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date and time when a specimen is received by the testing laboratory.

SourceReferenceRecordId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Represents where a specimen came from. For example, from a patient, from a location (the source of an environmental sample), a sampling of a substance, a biologically derived product, or a device. This field is a polymorphic relationship field.
Relationship Name: SourceReferenceRecord
Refers To: Account, Location

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the status of the specimen.
Default value: Available
Possible values:
- Available
- EnteredInError
- Unavailable
- Unsatisfactory

TypeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The type code set bundle associated with a specimen that represents the type of material that forms the specimen. This field is a relationship field.
Relationship Name: Type
Refers To: CodeSet

UsageCodeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The usage code set bundle associated with a specimen that represents the role of the specimen in the testing workflow. This field is a relationship field.
Relationship Name: UsageCode
Refers To: CodeSetBundle

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

SpecimenChangeEvent: Change events are available for the object.
SpecimenHistory: History is available for tracked fields of the object.
SpecimenOwnerSharingRule: Sharing rules are available for the object.
SpecimenShare: Sharing is available for the object.