SpecimenDefinition
A kind of specimen with associated set of requirements.
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/SpecimenDefinition/[id] |
| Vread | GET | /fhir/R4/SpecimenDefinition/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/SpecimenDefinition/[id] |
| Patch | PATCH | /fhir/R4/SpecimenDefinition/[id] |
| Delete | DELETE | /fhir/R4/SpecimenDefinition/[id] |
| Create | POST | /fhir/R4/SpecimenDefinition |
| Search | GET | /fhir/R4/SpecimenDefinition |
| History | GET | /fhir/R4/SpecimenDefinition/[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..1 | Business identifier of a kind of specimen |
typeCollected | CodeableConcept | 0..1 | Kind of material to collect |
patientPreparation | CodeableConcept | 0..* | Patient preparation for collection |
timeAspect | string | 0..1 | Time aspect for collection |
collection | CodeableConcept | 0..* | Specimen collection procedure |
typeTested | BackboneElement | 0..* | Specimen in container intended for testing by lab |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
container | token | The type of specimen conditioned in container expected by the lab |
identifier | token | The unique identifier associated with the specimen |
type | token | The type of collected specimen |
Reference
Official FHIR R4 spec: SpecimenDefinition.
Maturity: Draft (FMM 0).