# Specimen

Canonical page: https://docs.ovok.com/api/fhir/r4/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 [#top-level-elements]

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

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [Specimen](https://hl7.org/fhir/R4/specimen.html).  
Maturity: Trial Use 2 (FMM 2).
