Specimen

A sample to be used for analysis.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

Interaction	Method	Path
Read	GET	/fhir/R4/Specimen/[id]
Vread	GET	/fhir/R4/Specimen/[id]/_history/[vid]
Update	PUT	/fhir/R4/Specimen/[id]
Patch	PATCH	/fhir/R4/Specimen/[id]
Delete	DELETE	/fhir/R4/Specimen/[id]
Create	POST	/fhir/R4/Specimen
Search	GET	/fhir/R4/Specimen
History	GET	/fhir/R4/Specimen/[id]/_history

Top-level elements

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
identifier	Identifier	0..*	External Identifier
accessionIdentifier	Identifier	0..1	Identifier assigned by the lab
status	code	0..1	available | unavailable | unsatisfactory | entered-in-error
type	CodeableConcept	0..1	Kind of material that forms the specimen
subject	Reference	0..1	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	dateTime	0..1	The time when specimen was received for processing
parent	Reference	0..*	Specimen from which this specimen originated
request	Reference	0..*	Why the specimen was collected
collection	BackboneElement	0..1	Collection details
processing	BackboneElement	0..*	Processing and processing step details
container	BackboneElement	0..*	Direct container of specimen (tube/slide, etc.)
condition	CodeableConcept	0..*	State of the specimen
note	Annotation	0..*	Comments

Resource-specific search parameters

Parameter	Type	Description
accession	token	The accession number associated with the specimen
bodysite	token	The code for the body site from where the specimen originated
collected	date	The date the specimen was collected
collector	reference	Who collected the specimen
container	token	The kind of specimen container
container-id	token	The unique identifier associated with the specimen container
identifier	token	The unique identifier associated with the specimen
parent	reference	The parent of the specimen
patient	reference	The patient the specimen comes from
status	token	available | unavailable | unsatisfactory | entered-in-error
subject	reference	The subject of the specimen
type	token	The specimen type

Reference

Official FHIR R4 spec: Specimen.
Maturity: Trial Use 2 (FMM 2).