SpecimenDefinition

ResourceSpecialized · Definitional ArtifactsTrial useMaturity 0

A kind of specimen with associated set of requirements.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

3 of 3 parameters tested

Structure

Show inherited elements (20)

Element	Card.	Type	Description
identifierΣ	0..1	Identifier	Business identifier of a kind of specimen
typeCollectedΣ	0..1	CodeableConcept	Kind of material to collectBinding (example): v2-0487
patientPreparationΣ	0..*	CodeableConcept	Patient preparation for collectionBinding (example): prepare-patient-prior-specimen-collection
timeAspectΣ	0..1	string	Time aspect for collection
collectionΣ	0..*	CodeableConcept	Specimen collection procedureBinding (example): specimen-collection
typeTested	0..*	BackboneElement	Specimen in container intended for testing by lab
isDerived	0..1	boolean	Primary or secondary specimen
type	0..1	CodeableConcept	Type of intended specimenBinding (example): v2-0487
preferenceRequired	1..1	code	preferred | alternateBinding (required): specimen-contained-preference
container	0..1	BackboneElement	The specimen's container
material	0..1	CodeableConcept	Container materialBinding (example): container-material
type	0..1	CodeableConcept	Kind of container associated with the kind of specimenBinding (example): specimen-container-type
cap	0..1	CodeableConcept	Color of container capBinding (example): container-cap
description	0..1	string	Container description
capacity	0..1	Quantity	Container capacity
minimumVolume[x]	0..1	Quantity | string	Minimum volume
additive	0..*	BackboneElement	Additive associated with container
additive[x]Required	1..1	CodeableConcept | Reference(Substance)	Additive associated with containerBinding (example): v2-0371
preparation	0..1	string	Specimen container preparation
requirement	0..1	string	Specimen requirements
retentionTime	0..1	Duration	Specimen retention time
rejectionCriterion	0..*	CodeableConcept	Rejection criterionBinding (example): rejection-criteria
handling	0..*	BackboneElement	Specimen handling before testing
temperatureQualifier	0..1	CodeableConcept	Temperature qualifierBinding (example): handling-condition
temperatureRange	0..1	Range	Temperature range
maxDuration	0..1	Duration	Maximum preservation time
instruction	0..1	string	Preservation instruction

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/SpecimenDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
container	token	The type of specimen conditioned in container expected by the lab SpecimenDefinition.typeTested.container.type
identifier	token	The unique identifier associated with the specimen SpecimenDefinition.identifier
type	token	The type of collected specimen SpecimenDefinition.typeCollected

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition