Skip to main content

Specimen

Trial Use 2 Clinical — Diagnostics

A sample to be used for analysis.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Specimen
InteractionMethodPath
ReadGET/fhir/R5/Specimen/[id]
VreadGET/fhir/R5/Specimen/[id]/_history/[vid]
UpdatePUT/fhir/R5/Specimen/[id]
PatchPATCH/fhir/R5/Specimen/[id]
DeleteDELETE/fhir/R5/Specimen/[id]
CreatePOST/fhir/R5/Specimen
SearchGET/fhir/R5/Specimen?...
HistoryGET/fhir/R5/Specimen/[id]/_history
Type-historyGET/fhir/R5/Specimen/_history

Top-level elements

ElementType(s)CardinalityDescription
identifierIdentifier0..*External Identifier
accessionIdentifierIdentifier0..1Identifier assigned by the lab
statuscode0..1available
typeCodeableConcept0..1Kind of material that forms the specimen
subjectReference0..1Where 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, a biologically-derived product, or a device
receivedTimedateTime0..1The time when specimen is received by the testing laboratory
parentReference0..*Specimen from which this specimen originated
requestReference0..*Why the specimen was collected
combinedcode0..1grouped
roleCodeableConcept0..*The role the specimen serves
featureBackboneElement0..*The physical feature of a specimen
collectionBackboneElement0..1Collection details
processingBackboneElement0..*Processing and processing step details
containerBackboneElement0..*Direct container of specimen (tube/slide, etc.)
conditionCodeableConcept0..*State of the specimen
noteAnnotation0..*Comments

Resource-specific search parameters

ParameterTypeDescription
accessiontokenThe accession number associated with the specimen
bodysitereferenceReference to a resource (by instance)
collecteddateThe date the specimen was collected
collectorreferenceWho collected the specimen
container-devicereferenceThe unique identifier associated with the specimen container
identifiertokenAccount number
parentreferenceThe parent of the specimen
patientreferenceThe entity that caused the expenses
procedurereferenceThe procedure that collected the specimen
statustokenavailable
subjectreferenceThe subject of the specimen
typetokenE.g. patient, expense, depreciation

Reference

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