Specimen

ResourceClinical · DiagnosticsTrial useMaturity 2

A sample to be used for analysis.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

12 of 12 parameters tested

Structure

Show inherited elements (17)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	External Identifier
accessionIdentifierΣ	0..1	Identifier	Identifier assigned by the lab
status?!Σ	0..1	code	available | unavailable | unsatisfactory | entered-in-errorBinding (required): specimen-status
typeΣ	0..1	CodeableConcept	Kind of material that forms the specimenBinding (example): v2-0487
subjectΣ	0..1	Reference(Patient | Group | Device | Substance | Location)	Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
receivedTimeΣ	0..1	dateTime	The time when specimen was received for processing
parent	0..*	Reference(Specimen)	Specimen from which this specimen originated
request	0..*	Reference(ServiceRequest)	Why the specimen was collected
collection	0..1	BackboneElement	Collection details
collectorΣ	0..1	Reference(Practitioner | PractitionerRole)	Who collected the specimen
collected[x]Σ	0..1	dateTime | Period	Collection time
durationΣ	0..1	Duration	How long it took to collect specimen
quantity	0..1	Quantity	The quantity of specimen collected
method	0..1	CodeableConcept	Technique used to perform collectionBinding (example): specimen-collection-method
bodySite	0..1	CodeableConcept	Anatomical collection siteBinding (example): body-site
fastingStatus[x]Σ	0..1	CodeableConcept | Duration	Whether or how long patient abstained from food and/or drinkBinding (extensible): v2-0916
processing	0..*	BackboneElement	Processing and processing step details
description	0..1	string	Textual description of procedure
procedure	0..1	CodeableConcept	Indicates the treatment step applied to the specimenBinding (example): specimen-processing-procedure
additive	0..*	Reference(Substance)	Material used in the processing step
time[x]	0..1	dateTime | Period	Date and time of specimen processing
container	0..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
identifierΣ	0..*	Identifier	Id for the container
description	0..1	string	Textual description of the container
type	0..1	CodeableConcept	Kind of container directly associated with specimenBinding (example): specimen-container-type
capacity	0..1	Quantity	Container volume or size
specimenQuantity	0..1	Quantity	Quantity of specimen within container
additive[x]	0..1	CodeableConcept | Reference(Substance)	Additive associated with containerBinding (example): v2-0371
conditionΣ	0..*	CodeableConcept	State of the specimenBinding (extensible): v2-0493
note	0..*	Annotation	Comments

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Specimen?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
accession	token	The accession number associated with the specimen Specimen.accessionIdentifier
bodysite	token	The code for the body site from where the specimen originated Specimen.collection.bodySite
collected	date	The date the specimen was collected Specimen.collection.collected
collector	reference	Who collected the specimen Specimen.collection.collector
container	token	The kind of specimen container Specimen.container.type
container-id	token	The unique identifier associated with the specimen container Specimen.container.identifier
identifier	token	The unique identifier associated with the specimen Specimen.identifier
parent	reference	The parent of the specimen Specimen.parent
patient	reference	The patient the specimen comes from Specimen.subject.where(resolve() is Patient)
status	token	available | unavailable | unsatisfactory | entered-in-error Specimen.status
subject	reference	The subject of the specimen Specimen.subject
type	token	The specimen type Specimen.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition