This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0:
R5
-
Mixed
Normative
and
STU
)
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Orders
and
Observations
Work
Group
|
Maturity Level : 2 | Trial Use | Security Category : Patient | Compartments : Device , Patient , Practitioner |
A sample to be used for analysis.
Any material sample:
Some
specimens
are
biological
and
can
contain
one
or
more
components
including
but
not
limited
to
cellular
molecules,
cells,
tissues,
organs,
body
fluids,
embryos,
and
body
excretory
products
(source:
NCI
Thesaurus
,
modified).
The specimen resource covers substances used for diagnostic and environmental testing. The focus of the specimen resource is the process for gathering, maintaining and processing the specimen as well as where the specimen originated. This is distinct from the use of Substance which is only used when these other aspects are not relevant.
The current definition of the specimen resource contains only basic information about specimen containers. It does not address the recursive nature of containers or the tracking of the location of a container within its parent container (for instance: a tube in a tray in a rack in a freezer). The frequency with which these elements are tracked may depend on the context of use; general lab, bio-banking, etc. Comments from reviewers on the appropriate scope for this resource, and the need for tracking related specimen management attributes, are welcomed.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Sample
for
analysis
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
Identifier
|
|
Σ | 0..1 | Identifier |
Identifier
assigned
by
the
lab
|
|
?! Σ | 0..1 | code |
available
|
unavailable
|
unsatisfactory
|
entered-in-error
|
|
Σ | 0..1 | CodeableConcept |
Kind
of
material
that
forms
the
specimen
Binding: hl7VS-specimenType
|
|
Σ | 0..1 | Reference ( Patient | Group | Device | BiologicallyDerivedProduct | Substance | Location ) |
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
|
|
Σ | 0..1 | dateTime |
The
time
when
specimen
|
|
0..* | Reference ( Specimen ) |
Specimen
from
which
this
specimen
originated
|
|
|
0..* | Reference ( ServiceRequest ) |
Why
the
specimen
was
collected
|
|
|
Σ | 0..1 | code |
grouped
|
pooled
Binding: Specimen Combined ( Required ) |
![]() ![]() | 0..* | CodeableConcept |
The
role
the
specimen
serves
Binding: Specimen Role ( Preferred ) | |
![]() ![]() | 0..* | BackboneElement |
The
physical
feature
of
a
specimen
| |
![]() ![]() ![]() | 1..1 | CodeableConcept |
Highlighted
feature
Binding: SNOMED CT Body Structures ( Example ) | |
![]() ![]() ![]() | 1..1 | string |
Information
about
the
feature
| |
![]() ![]() | 0..1 | BackboneElement |
Collection
details
|
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson ) |
Who
collected
the
specimen
|
|
Σ | 0..1 |
Collection
time
|
|
|
dateTime | |||
|
Period | |||
|
Σ | 0..1 | Duration |
How
long
it
took
to
collect
specimen
|
|
0..1 | SimpleQuantity |
The
quantity
of
specimen
collected
|
|
|
0..1 | CodeableConcept |
Technique
used
to
perform
collection
Binding: FHIR Specimen Collection Method ( Example ) |
|
|
0..1 | CodeableReference ( Device ) |
Device
used
to
perform
collection
Binding: SpecimenCollectionDevice ( Example ) | |
![]() ![]() ![]() | 0..1 |
|
The
procedure
that
collects
the
specimen
| |
![]() ![]() ![]() | 0..1 | CodeableReference ( BodyStructure ) |
Anatomical
collection
site
Binding: SNOMED CT Body Structures ( Example ) |
|
|
Σ | 0..1 |
Whether
or
how
long
patient
abstained
from
food
and/or
drink
Binding: hl7VS-relevantClincialInformation
|
|
|
CodeableConcept | |||
|
Duration | |||
|
0..* | BackboneElement |
Processing
and
processing
step
details
|
|
|
0..1 | string |
Textual
description
of
procedure
|
|
|
0..1 | CodeableConcept |
Indicates
the
treatment
step
applied
to
the
specimen
Binding: Specimen |
|
|
0..* | Reference ( Substance ) |
Material
used
in
the
processing
step
|
|
|
0..1 |
Date
and
time
of
specimen
processing
|
||
|
dateTime | |||
|
Period | |||
|
0..* | BackboneElement |
Direct
container
of
specimen
(tube/slide,
etc.)
|
|
|
|
|
|
|
|
0..1 |
|
|
|
|
0..1 | SimpleQuantity |
|
|
|
Σ | 0..* | CodeableConcept |
State
of
the
specimen
Binding: hl7VS-specimenCondition
|
|
0..* | Annotation |
Comments
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<Specimen xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Identifier --></identifier> <accessionIdentifier><!-- 0..1 Identifier Identifier assigned by the lab --></accessionIdentifier> <status value="[code]"/><!-- 0..1 available | unavailable | unsatisfactory | entered-in-error -->
<</type> <</subject> <<type><!-- 0..1 CodeableConcept Kind of material that forms the specimen--></type> <subject><!-- 0..1 Reference(BiologicallyDerivedProduct|Device|Group|Location| Patient|Substance) 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, a biologically-derived product, or a device --></subject> <receivedTime value="[dateTime]"/><!-- 0..1 The time when specimen is received by the testing laboratory --> <parent><!-- 0..* Reference(Specimen) Specimen from which this specimen originated --></parent> <request><!-- 0..* Reference(ServiceRequest) Why the specimen was collected --></request> <combined value="[code]"/><!-- 0..1 grouped | pooled --> <role><!-- 0..* CodeableConcept The role the specimen serves --></role> <feature> <!-- 0..* The physical feature of a specimen --> <type><!-- 1..1 CodeableConcept Highlighted feature --></type> <description value="[string]"/><!-- 1..1 Information about the feature --> </feature> <collection> <!-- 0..1 Collection details -->
<</collector><collector><!-- 0..1 Reference(Patient|Practitioner|PractitionerRole| RelatedPerson) Who collected the specimen --></collector> <collected[x]><!-- 0..1 dateTime|Period Collection time --></collected[x]> <duration><!-- 0..1 Duration How long it took to collect specimen --></duration> <quantity><!-- 0..1 Quantity(SimpleQuantity) The quantity of specimen collected --></quantity> <method><!-- 0..1 CodeableConcept Technique used to perform collection --></method><</bodySite> <</fastingStatus[x]><device><!-- 0..1 CodeableReference(Device) Device used to perform collection --></device> <procedure><!-- 0..1 Reference(Procedure) The procedure that collects the specimen --></procedure> <bodySite><!-- 0..1 CodeableReference(BodyStructure) Anatomical collection site --></bodySite> <fastingStatus[x]><!-- 0..1 CodeableConcept|Duration Whether or how long patient abstained from food and/or drink--></fastingStatus[x]> </collection> <processing> <!-- 0..* Processing and processing step details --> <description value="[string]"/><!-- 0..1 Textual description of procedure -->
<</procedure><method><!-- 0..1 CodeableConcept Indicates the treatment step applied to the specimen --></method> <additive><!-- 0..* Reference(Substance) Material used in the processing step --></additive> <time[x]><!-- 0..1 dateTime|Period Date and time of specimen processing --></time[x]> </processing> <container> <!-- 0..* Direct container of specimen (tube/slide, etc.) --><</identifier> < <</type> <</capacity><device><!-- 1..1 Reference(Device) Device resource for the container --></device> <location><!-- 0..1 Reference(Location) Where the container is --></location> <specimenQuantity><!-- 0..1 Quantity(SimpleQuantity) Quantity of specimen within container --></specimenQuantity><</additive[x]></container><</condition><condition><!-- 0..* CodeableConcept State of the specimen--></condition> <note><!-- 0..* Annotation Comments --></note> </Specimen>
JSON Template
{
"resourceType" : "Specimen",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Identifier
"accessionIdentifier" : { Identifier }, // Identifier assigned by the lab
"status" : "<code>", // available | unavailable | unsatisfactory | entered-in-error
"
"
"
"type" : { CodeableConcept }, // Kind of material that forms the specimen
"subject" : { Reference(BiologicallyDerivedProduct|Device|Group|Location|
Patient|Substance) }, // 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, a biologically-derived product, or a device
"receivedTime" : "<dateTime>", // The time when specimen is received by the testing laboratory
"parent" : [{ Reference(Specimen) }], // Specimen from which this specimen originated
"request" : [{ Reference(ServiceRequest) }], // Why the specimen was collected
"combined" : "<code>", // grouped | pooled
"role" : [{ CodeableConcept }], // The role the specimen serves
"feature" : [{ // The physical feature of a specimen
"type" : { CodeableConcept }, // R! Highlighted feature
"description" : "<string>" // R! Information about the feature
}],
"collection" : { // Collection details
"
"collector" : { Reference(Patient|Practitioner|PractitionerRole|
RelatedPerson) }, // Who collected the specimen
// collected[x]: Collection time. One of these 2:
"collectedDateTime" : "<dateTime>",
"collectedPeriod" : { Period },
"duration" : { Duration }, // How long it took to collect specimen
"quantity" : { Quantity(SimpleQuantity) }, // The quantity of specimen collected
"method" : { CodeableConcept }, // Technique used to perform collection
"
"device" : { CodeableReference(Device) }, // Device used to perform collection
"procedure" : { Reference(Procedure) }, // The procedure that collects the specimen
"bodySite" : { CodeableReference(BodyStructure) }, // Anatomical collection site
// fastingStatus[x]: Whether or how long patient abstained from food and/or drink. One of these 2:
" }
"fastingStatusCodeableConcept" : { CodeableConcept },
"fastingStatusDuration" : { Duration }
},
"processing" : [{ // Processing and processing step details
"description" : "<string>", // Textual description of procedure
"
"method" : { CodeableConcept }, // Indicates the treatment step applied to the specimen
"additive" : [{ Reference(Substance) }], // Material used in the processing step
// time[x]: Date and time of specimen processing. One of these 2:
">"
"timeDateTime" : "<dateTime>",
"timePeriod" : { Period }
}],
"container" : [{ // Direct container of specimen (tube/slide, etc.)
"
"
"
"
"
" }
" }
"device" : { Reference(Device) }, // R! Device resource for the container
"location" : { Reference(Location) }, // Where the container is
"specimenQuantity" : { Quantity(SimpleQuantity) } // Quantity of specimen within container
}],
"
"condition" : [{ CodeableConcept }], // State of the specimen
"note" : [{ Annotation }] // Comments
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:Specimen; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] ]; fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] ], ...; fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] ], ...; fhir: fhir:fhir:identifier ( [ Identifier ] ... ) ; # 0..* External Identifier fhir:accessionIdentifier [ Identifier ] ; # 0..1 Identifier assigned by the lab fhir:status [ code ] ; # 0..1 available | unavailable | unsatisfactory | entered-in-error fhir:type [ CodeableConcept ] ; # 0..1 Kind of material that forms the specimen fhir:subject [ Reference(BiologicallyDerivedProduct|Device|Group|Location|Patient|Substance) ] ; # 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, a biologically-derived product, or a device fhir:receivedTime [ dateTime ] ; # 0..1 The time when specimen is received by the testing laboratory fhir:parent ( [ Reference(Specimen) ] ... ) ; # 0..* Specimen from which this specimen originated fhir:request ( [ Reference(ServiceRequest) ] ... ) ; # 0..* Why the specimen was collected fhir:combined [ code ] ; # 0..1 grouped | pooled fhir:role ( [ CodeableConcept ] ... ) ; # 0..* The role the specimen serves fhir:feature ( [ # 0..* The physical feature of a specimen fhir:type [ CodeableConcept ] ; # 1..1 Highlighted feature fhir:description [ string ] ; # 1..1 Information about the feature ] ... ) ; fhir:collection [ # 0..1 Collection details fhir:collector [ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who collected the specimen # collected[x] : 0..1 Collection time. One of these 2 fhir:collected [ a fhir:dateTime ; dateTime ] fhir:collected [ a fhir:Period ; Period ] fhir:duration [ Duration ] ; # 0..1 How long it took to collect specimen fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 The quantity of specimen collected fhir:method [ CodeableConcept ] ; # 0..1 Technique used to perform collection fhir:device [ CodeableReference(Device) ] ; # 0..1 Device used to perform collection fhir:procedure [ Reference(Procedure) ] ; # 0..1 The procedure that collects the specimen fhir:bodySite [ CodeableReference(BodyStructure) ] ; # 0..1 Anatomical collection site # fastingStatus[x] : 0..1 Whether or how long patient abstained from food and/or drink. One of these 2 fhir:fastingStatus [ a fhir:CodeableConcept ; CodeableConcept ] fhir:fastingStatus [ a fhir:Duration ; Duration ] ] ; fhir:processing ( [ # 0..* Processing and processing step details fhir:description [ string ] ; # 0..1 Textual description of procedure fhir:method [ CodeableConcept ] ; # 0..1 Indicates the treatment step applied to the specimen fhir:additive ( [ Reference(Substance) ] ... ) ; # 0..* Material used in the processing step # time[x] : 0..1 Date and time of specimen processing. One of these 2 fhir:time [ a fhir:dateTime ; dateTime ] fhir:time [ a fhir:Period ; Period ] ] ... ) ; fhir:container ( [ # 0..* Direct container of specimen (tube/slide, etc.) fhir:device [ Reference(Device) ] ; # 1..1 Device resource for the container fhir:location [ Reference(Location) ] ; # 0..1 Where the container is fhir:specimenQuantity [ Quantity(SimpleQuantity) ] ; # 0..1 Quantity of specimen within container ] ... ) ; fhir:condition ( [ CodeableConcept ] ... ) ; # 0..* State of the specimen fhir:note ( [ Annotation ] ... ) ; # 0..* Comments ]
Changes
since
R3
from
both
R4
and
R4B
| Specimen | |
| Specimen.subject |
|
|
|
|
|
|
|
| Specimen.feature |
|
|
|
|
| Specimen.feature.description |
|
| Specimen.collection.collector |
|
| Specimen.collection.device |
|
| Specimen.collection.procedure |
|
| Specimen.collection.bodySite |
|
|
|
|
|
|
|
|
|
|
| Specimen.processing.procedure |
|
| Specimen.container.identifier |
|
| Specimen.container.description |
|
| Specimen.container.type |
|
| Specimen.container.capacity |
|
| Specimen.container.additive[x] |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
See
R3
<-->
R4
<-->
R5
Conversion
Maps
(status
=
4
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
2
r3
resources
are
invalid
(0
errors).
)
See
Conversions
Summary
.)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Sample
for
analysis
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
External
Identifier
|
|
Σ | 0..1 | Identifier |
Identifier
assigned
by
the
lab
|
|
?! Σ | 0..1 | code |
available
|
unavailable
|
unsatisfactory
|
entered-in-error
|
|
Σ | 0..1 | CodeableConcept |
Kind
of
material
that
forms
the
specimen
Binding: hl7VS-specimenType
|
|
Σ | 0..1 | Reference ( Patient | Group | Device | BiologicallyDerivedProduct | Substance | Location ) |
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
|
|
Σ | 0..1 | dateTime |
The
time
when
specimen
|
|
0..* | Reference ( Specimen ) |
Specimen
from
which
this
specimen
originated
|
|
|
0..* | Reference ( ServiceRequest ) |
Why
the
specimen
was
collected
|
|
|
Σ | 0..1 | code |
grouped
|
pooled
Binding: Specimen Combined ( Required ) |
![]() ![]() | 0..* | CodeableConcept |
The
role
the
specimen
serves
Binding: Specimen Role ( Preferred ) | |
![]() ![]() | 0..* | BackboneElement |
The
physical
feature
of
a
specimen
| |
![]() ![]() ![]() | 1..1 | CodeableConcept |
Highlighted
feature
Binding: SNOMED CT Body Structures ( Example ) | |
![]() ![]() ![]() | 1..1 | string |
Information
about
the
feature
| |
![]() ![]() | 0..1 | BackboneElement |
Collection
details
|
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Patient | RelatedPerson ) |
Who
collected
the
specimen
|
|
Σ | 0..1 |
Collection
time
|
|
|
dateTime | |||
|
Period | |||
|
Σ | 0..1 | Duration |
How
long
it
took
to
collect
specimen
|
|
0..1 | SimpleQuantity |
The
quantity
of
specimen
collected
|
|
|
0..1 | CodeableConcept |
Technique
used
to
perform
collection
Binding: FHIR Specimen Collection Method ( Example ) |
|
|
0..1 | CodeableReference ( Device ) |
Device
used
to
perform
collection
Binding: SpecimenCollectionDevice ( Example ) | |
![]() ![]() ![]() |
0..1 |
|
The
procedure
that
collects
the
specimen
| |
![]() ![]() ![]() | 0..1 | CodeableReference ( BodyStructure ) |
Anatomical
collection
site
Binding: SNOMED CT Body Structures ( Example ) |
|
|
Σ | 0..1 |
Whether
or
how
long
patient
abstained
from
food
and/or
drink
Binding: hl7VS-relevantClincialInformation
|
|
|
CodeableConcept | |||
|
Duration | |||
|
0..* | BackboneElement |
Processing
and
processing
step
details
|
|
|
0..1 | string |
Textual
description
of
procedure
|
|
|
0..1 | CodeableConcept |
Indicates
the
treatment
step
applied
to
the
specimen
Binding: Specimen |
|
|
0..* | Reference ( Substance ) |
Material
used
in
the
processing
step
|
|
|
0..1 |
Date
and
time
of
specimen
processing
|
||
|
dateTime | |||
|
Period | |||
|
0..* | BackboneElement |
Direct
container
of
specimen
(tube/slide,
etc.)
|
|
|
|
|
|
|
|
0..1 |
|
|
|
|
0..1 | SimpleQuantity |
|
|
|
Σ | 0..* | CodeableConcept |
State
of
the
specimen
Binding: hl7VS-specimenCondition
|
|
0..* | Annotation |
Comments
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<Specimen xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Identifier --></identifier> <accessionIdentifier><!-- 0..1 Identifier Identifier assigned by the lab --></accessionIdentifier> <status value="[code]"/><!-- 0..1 available | unavailable | unsatisfactory | entered-in-error -->
<</type> <</subject> <<type><!-- 0..1 CodeableConcept Kind of material that forms the specimen--></type> <subject><!-- 0..1 Reference(BiologicallyDerivedProduct|Device|Group|Location| Patient|Substance) 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, a biologically-derived product, or a device --></subject> <receivedTime value="[dateTime]"/><!-- 0..1 The time when specimen is received by the testing laboratory --> <parent><!-- 0..* Reference(Specimen) Specimen from which this specimen originated --></parent> <request><!-- 0..* Reference(ServiceRequest) Why the specimen was collected --></request> <combined value="[code]"/><!-- 0..1 grouped | pooled --> <role><!-- 0..* CodeableConcept The role the specimen serves --></role> <feature> <!-- 0..* The physical feature of a specimen --> <type><!-- 1..1 CodeableConcept Highlighted feature --></type> <description value="[string]"/><!-- 1..1 Information about the feature --> </feature> <collection> <!-- 0..1 Collection details -->
<</collector><collector><!-- 0..1 Reference(Patient|Practitioner|PractitionerRole| RelatedPerson) Who collected the specimen --></collector> <collected[x]><!-- 0..1 dateTime|Period Collection time --></collected[x]> <duration><!-- 0..1 Duration How long it took to collect specimen --></duration> <quantity><!-- 0..1 Quantity(SimpleQuantity) The quantity of specimen collected --></quantity> <method><!-- 0..1 CodeableConcept Technique used to perform collection --></method><</bodySite> <</fastingStatus[x]><device><!-- 0..1 CodeableReference(Device) Device used to perform collection --></device> <procedure><!-- 0..1 Reference(Procedure) The procedure that collects the specimen --></procedure> <bodySite><!-- 0..1 CodeableReference(BodyStructure) Anatomical collection site --></bodySite> <fastingStatus[x]><!-- 0..1 CodeableConcept|Duration Whether or how long patient abstained from food and/or drink--></fastingStatus[x]> </collection> <processing> <!-- 0..* Processing and processing step details --> <description value="[string]"/><!-- 0..1 Textual description of procedure -->
<</procedure><method><!-- 0..1 CodeableConcept Indicates the treatment step applied to the specimen --></method> <additive><!-- 0..* Reference(Substance) Material used in the processing step --></additive> <time[x]><!-- 0..1 dateTime|Period Date and time of specimen processing --></time[x]> </processing> <container> <!-- 0..* Direct container of specimen (tube/slide, etc.) --><</identifier> < <</type> <</capacity><device><!-- 1..1 Reference(Device) Device resource for the container --></device> <location><!-- 0..1 Reference(Location) Where the container is --></location> <specimenQuantity><!-- 0..1 Quantity(SimpleQuantity) Quantity of specimen within container --></specimenQuantity><</additive[x]></container><</condition><condition><!-- 0..* CodeableConcept State of the specimen--></condition> <note><!-- 0..* Annotation Comments --></note> </Specimen>
JSON Template
{
"resourceType" : "Specimen",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Identifier
"accessionIdentifier" : { Identifier }, // Identifier assigned by the lab
"status" : "<code>", // available | unavailable | unsatisfactory | entered-in-error
"
"
"
"type" : { CodeableConcept }, // Kind of material that forms the specimen
"subject" : { Reference(BiologicallyDerivedProduct|Device|Group|Location|
Patient|Substance) }, // 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, a biologically-derived product, or a device
"receivedTime" : "<dateTime>", // The time when specimen is received by the testing laboratory
"parent" : [{ Reference(Specimen) }], // Specimen from which this specimen originated
"request" : [{ Reference(ServiceRequest) }], // Why the specimen was collected
"combined" : "<code>", // grouped | pooled
"role" : [{ CodeableConcept }], // The role the specimen serves
"feature" : [{ // The physical feature of a specimen
"type" : { CodeableConcept }, // R! Highlighted feature
"description" : "<string>" // R! Information about the feature
}],
"collection" : { // Collection details
"
"collector" : { Reference(Patient|Practitioner|PractitionerRole|
RelatedPerson) }, // Who collected the specimen
// collected[x]: Collection time. One of these 2:
"collectedDateTime" : "<dateTime>",
"collectedPeriod" : { Period },
"duration" : { Duration }, // How long it took to collect specimen
"quantity" : { Quantity(SimpleQuantity) }, // The quantity of specimen collected
"method" : { CodeableConcept }, // Technique used to perform collection
"
"device" : { CodeableReference(Device) }, // Device used to perform collection
"procedure" : { Reference(Procedure) }, // The procedure that collects the specimen
"bodySite" : { CodeableReference(BodyStructure) }, // Anatomical collection site
// fastingStatus[x]: Whether or how long patient abstained from food and/or drink. One of these 2:
" }
"fastingStatusCodeableConcept" : { CodeableConcept },
"fastingStatusDuration" : { Duration }
},
"processing" : [{ // Processing and processing step details
"description" : "<string>", // Textual description of procedure
"
"method" : { CodeableConcept }, // Indicates the treatment step applied to the specimen
"additive" : [{ Reference(Substance) }], // Material used in the processing step
// time[x]: Date and time of specimen processing. One of these 2:
">"
"timeDateTime" : "<dateTime>",
"timePeriod" : { Period }
}],
"container" : [{ // Direct container of specimen (tube/slide, etc.)
"
"
"
"
"
" }
" }
"device" : { Reference(Device) }, // R! Device resource for the container
"location" : { Reference(Location) }, // Where the container is
"specimenQuantity" : { Quantity(SimpleQuantity) } // Quantity of specimen within container
}],
"
"condition" : [{ CodeableConcept }], // State of the specimen
"note" : [{ Annotation }] // Comments
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:Specimen; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] ]; fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir: ] ], ...; fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] ], ...; fhir: fhir:fhir:identifier ( [ Identifier ] ... ) ; # 0..* External Identifier fhir:accessionIdentifier [ Identifier ] ; # 0..1 Identifier assigned by the lab fhir:status [ code ] ; # 0..1 available | unavailable | unsatisfactory | entered-in-error fhir:type [ CodeableConcept ] ; # 0..1 Kind of material that forms the specimen fhir:subject [ Reference(BiologicallyDerivedProduct|Device|Group|Location|Patient|Substance) ] ; # 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, a biologically-derived product, or a device fhir:receivedTime [ dateTime ] ; # 0..1 The time when specimen is received by the testing laboratory fhir:parent ( [ Reference(Specimen) ] ... ) ; # 0..* Specimen from which this specimen originated fhir:request ( [ Reference(ServiceRequest) ] ... ) ; # 0..* Why the specimen was collected fhir:combined [ code ] ; # 0..1 grouped | pooled fhir:role ( [ CodeableConcept ] ... ) ; # 0..* The role the specimen serves fhir:feature ( [ # 0..* The physical feature of a specimen fhir:type [ CodeableConcept ] ; # 1..1 Highlighted feature fhir:description [ string ] ; # 1..1 Information about the feature ] ... ) ; fhir:collection [ # 0..1 Collection details fhir:collector [ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 0..1 Who collected the specimen # collected[x] : 0..1 Collection time. One of these 2 fhir:collected [ a fhir:dateTime ; dateTime ] fhir:collected [ a fhir:Period ; Period ] fhir:duration [ Duration ] ; # 0..1 How long it took to collect specimen fhir:quantity [ Quantity(SimpleQuantity) ] ; # 0..1 The quantity of specimen collected fhir:method [ CodeableConcept ] ; # 0..1 Technique used to perform collection fhir:device [ CodeableReference(Device) ] ; # 0..1 Device used to perform collection fhir:procedure [ Reference(Procedure) ] ; # 0..1 The procedure that collects the specimen fhir:bodySite [ CodeableReference(BodyStructure) ] ; # 0..1 Anatomical collection site # fastingStatus[x] : 0..1 Whether or how long patient abstained from food and/or drink. One of these 2 fhir:fastingStatus [ a fhir:CodeableConcept ; CodeableConcept ] fhir:fastingStatus [ a fhir:Duration ; Duration ] ] ; fhir:processing ( [ # 0..* Processing and processing step details fhir:description [ string ] ; # 0..1 Textual description of procedure fhir:method [ CodeableConcept ] ; # 0..1 Indicates the treatment step applied to the specimen fhir:additive ( [ Reference(Substance) ] ... ) ; # 0..* Material used in the processing step # time[x] : 0..1 Date and time of specimen processing. One of these 2 fhir:time [ a fhir:dateTime ; dateTime ] fhir:time [ a fhir:Period ; Period ] ] ... ) ; fhir:container ( [ # 0..* Direct container of specimen (tube/slide, etc.) fhir:device [ Reference(Device) ] ; # 1..1 Device resource for the container fhir:location [ Reference(Location) ] ; # 0..1 Where the container is fhir:specimenQuantity [ Quantity(SimpleQuantity) ] ; # 0..1 Quantity of specimen within container ] ... ) ; fhir:condition ( [ CodeableConcept ] ... ) ; # 0..* State of the specimen fhir:note ( [ Annotation ] ... ) ; # 0..* Comments ]
Changes
since
Release
3
from
both
R4
and
R4B
| Specimen | |
| Specimen.subject |
|
|
|
|
|
|
|
| Specimen.feature |
|
|
|
|
| Specimen.feature.description |
|
| Specimen.collection.collector |
|
| Specimen.collection.device |
|
| Specimen.collection.procedure |
|
| Specimen.collection.bodySite |
|
|
|
|
|
|
|
|
|
|
| Specimen.processing.procedure |
|
| Specimen.container.identifier |
|
| Specimen.container.description |
|
| Specimen.container.type |
|
| Specimen.container.capacity |
|
| Specimen.container.additive[x] |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
See
R3
<-->
R4
<-->
R5
Conversion
Maps
(status
=
4
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
2
r3
resources
are
invalid
(0
errors).
)
See
Conversions
Summary
.)
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| Specimen.status | SpecimenStatus | Required | Codes providing the status/availability of a specimen. |
| Specimen.type |
Hl7VSSpecimenType
(a
valid
code
from
specimenType
)
|
|
Concepts that describe the precise nature of an entity that may be used as the source material for an observation. This is one of two code systems that are used instead of table 0070 (code system xxxx) which conflated specimen types and specimen collection methods. Used in Version 2 messaging in the SPM segment. |
| Specimen.combined |
|
|
Codes providing the combined status of a specimen. |
| Specimen.role |
|
|
Codes providing the role of a specimen. |
|
|
|
Example |
This
value
set
includes
all
codes
from
SNOMED
CT
|
| Specimen.collection.method |
|
|
This example value set defines a set of codes that can be used to indicate the method by which a specimen was collected. |
| Specimen.collection.device |
|
Example |
|
| Specimen.collection.bodySite |
|
Example |
This
value
set
includes
all
codes
from
SNOMED
CT
|
| Specimen.collection.fastingStatus[x] |
(a
valid
code
from
relevantClincialInformation
)
| Extensible |
Value
Set
of
codes
that
specify
additional
clinical
information
about
the
patient
or
specimen
|
| Specimen.processing.method | SpecimenProcessingMethod | Example |
The technique that is used to perform the process or preserve the specimen. These are codes from SNOMED CT - provided as an exemplar value set. |
| Specimen.condition |
(a
valid
code
from
specimenCondition
)
|
Extensible |
Concepts of modes or states of being that describe the nature of a specimen. Used in Version 2 messaging in the SPM segment. |
Specimens can be grouped at the Observation level via two ways:
Specimens can be searched by parent, as described here . Additionally, a recursive, child-based search could be performed, using the instructions here . Note that recursive or reverse searching is highly dependent on the configuration of the local system(s) involved.
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| accession | token | The accession number associated with the specimen | Specimen.accessionIdentifier | |
| bodysite |
|
|
|
|
| collected | date | The date the specimen was collected |
|
|
| collector | reference | Who collected the specimen |
Specimen.collection.collector
( Practitioner , Patient , PractitionerRole , RelatedPerson ) |
|
|
|
|
The unique identifier associated with the specimen container |
( Device ) |
|
| identifier | token | The unique identifier associated with the specimen | Specimen.identifier | 65 Resources |
| parent | reference | The parent of the specimen |
Specimen.parent
( Specimen ) |
|
| patient | reference | The patient the specimen comes from |
Specimen.subject.where(resolve()
is
Patient)
( Patient ) |
66 Resources |
| procedure | reference | The procedure that collected the specimen |
Specimen.collection.procedure
( Procedure ) | |
| status | token | available | unavailable | unsatisfactory | entered-in-error | Specimen.status | |
| subject | reference | The subject of the specimen |
Specimen.subject
( Group , BiologicallyDerivedProduct , Device , Patient , Substance , Location ) |
|
| type | token | The specimen type | Specimen.type | 11 Resources |