Skip to main content

Specimen

Trial Use 2 Clinical — Diagnostics

A sample to be used for analysis.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Specimen
InteractionMethodPath
ReadGET/fhir/R4/Specimen/[id]
VreadGET/fhir/R4/Specimen/[id]/_history/[vid]
UpdatePUT/fhir/R4/Specimen/[id]
PatchPATCH/fhir/R4/Specimen/[id]
DeleteDELETE/fhir/R4/Specimen/[id]
CreatePOST/fhir/R4/Specimen
SearchGET/fhir/R4/Specimen
HistoryGET/fhir/R4/Specimen/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*External Identifier
accessionIdentifierIdentifier0..1Identifier assigned by the lab
statuscode0..1available | unavailable | unsatisfactory | entered-in-error modifier
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 or a device
receivedTimedateTime0..1The time when specimen was received for processing
parentReference0..*Specimen from which this specimen originated
requestReference0..*Why the specimen was collected
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
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
accessionstringhttp://hl7.org/fhir/SearchParameter/Specimen-accession
bodysitestringhttp://hl7.org/fhir/SearchParameter/Specimen-bodysite
collectedstringhttp://hl7.org/fhir/SearchParameter/Specimen-collected
collectorstringhttp://hl7.org/fhir/SearchParameter/Specimen-collector
containerstringhttp://hl7.org/fhir/SearchParameter/Specimen-container
container-idstringhttp://hl7.org/fhir/SearchParameter/Specimen-container-id
identifierstringhttp://hl7.org/fhir/SearchParameter/Specimen-identifier
parentstringhttp://hl7.org/fhir/SearchParameter/Specimen-parent
patientstringhttp://hl7.org/fhir/SearchParameter/Specimen-patient
statusstringhttp://hl7.org/fhir/SearchParameter/Specimen-status
subjectstringhttp://hl7.org/fhir/SearchParameter/Specimen-subject
typestringhttp://hl7.org/fhir/SearchParameter/Specimen-type

Reference​

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