Release
4
5
Administration
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
| Orders and Observations Work Group | Maturity Level : N/A | Standards Status : Informative |
Compartments
:
|
Raw JSON ( canonical form + also see JSON Format Specification )
Example definition of serum or plasma specimen.
{
"resourceType": "SpecimenDefinition",
"id": "2364",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: 2364</p><p><b>typeCollected</b>: Venous blood specimen <span>(Details : {SNOMED CT code '122555007' = 'Venous blood specimen', given as 'Venous blood specimen'})</span></p><p><b>patientPreparation</b>: 12 hour fasting <span>(Details )</span>, At rest <span>(Details : {SNOMED CT code '263678003' = 'At rest', given as 'At rest'})</span></p><p><b>timeAspect</b>: preferrably morning time</p><blockquote><p><b>typeTested</b></p><p><b>type</b>: Serum specimen <span>(Details : {SNOMED CT code '119364003' = 'Serum specimen', given as 'Serum specimen'})</span></p><p><b>preference</b>: preferred</p><h3>Containers</h3><table><tr><td>-</td><td><b>Material</b></td><td><b>Type</b></td><td><b>Cap</b></td><td><b>MinimumVolume[x]</b></td></tr><tr><td>*</td><td>plastic <span>(Details : {SNOMED CT code '61088005' = 'Plastic', given as 'plastic'})</span></td><td>Evacuated blood collection tube, thrombin/clot activator/gel separator <span>(Details : {SNOMED CT code '702281005' = 'Evacuated blood collection tube, thrombin/clot activator/gel separator', given as 'Evacuated blood collection tube, thrombin/clot activator/gel separator'})</span></td><td>yellow cap <span>(Details : {urn:iso:std:iso:6710:2017 code 'yellow' = 'yellow', given as 'yellow cap'})</span></td><td>2 ml<span> (Details: UCUM code mL = 'mL')</span></td></tr></table><blockquote><p><b>handling</b></p><p><b>temperatureQualifier</b>: Ambient temperature <span>(Details )</span></p><p><b>temperatureRange</b>: 15-25 °C</p><p><b>maxDuration</b>: 60 minute<span> (Details: UCUM code min = 'min')</span></p></blockquote><blockquote><p><b>handling</b></p><p><b>temperatureQualifier</b>: Refrigerated temperature <span>(Details )</span></p><p><b>temperatureRange</b>: 2-8 °C</p><p><b>maxDuration</b>: 8 hour<span> (Details: UCUM code h = 'h')</span></p></blockquote></blockquote><blockquote><p><b>typeTested</b></p><p><b>type</b>: Plasma specimen <span>(Details : {SNOMED CT code '119361006' = 'Plasma specimen', given as 'Plasma specimen'})</span></p><p><b>preference</b>: alternate</p><h3>Containers</h3><table><tr><td>-</td><td><b>Material</b></td><td><b>Type</b></td><td><b>Cap</b></td><td><b>MinimumVolume[x]</b></td></tr><tr><td>*</td><td>glass <span>(Details : {SNOMED CT code '32039001' = 'Glass', given as 'glass'})</span></td><td>Evacuated blood collection tube with heparin lithium and gel separator <span>(Details : {SNOMED CT code '767390000' = 'Evacuated blood collection tube with heparin lithium and gel separator', given as 'Evacuated blood collection tube with heparin lithium and gel separator'})</span></td><td>green cap <span>(Details : {urn:iso:std:iso:6710:2017 code 'green' = 'green', given as 'green cap'})</span></td><td>2 ml<span> (Details: UCUM code mL = 'mL')</span></td></tr></table><p><b>rejectionCriterion</b>: insufficient specimen volume <span>(Details : {http://terminology.hl7.org/CodeSystem/rejection-criteria code 'insufficient' = 'insufficient specimen volume', given as 'insufficient specimen volume'})</span>, hemolized specimen <span>(Details : {http://terminology.hl7.org/CodeSystem/rejection-criteria code 'hemolized' = 'hemolized specimen', given as 'hemolized specimen'})</span></p><blockquote><p><b>handling</b></p><p><b>temperatureQualifier</b>: Ambient temperature <span>(Details )</span></p><p><b>temperatureRange</b>: 15-25 °C</p><p><b>maxDuration</b>: 60 minute<span> (Details: UCUM code min = 'min')</span></p></blockquote><blockquote><p><b>handling</b></p><p><b>temperatureQualifier</b>: Refrigerated temperature <span>(Details )</span></p><p><b>temperatureRange</b>: 2-8 °C</p><p><b>maxDuration</b>: 8 hour<span> (Details: UCUM code h = 'h')</span></p></blockquote></blockquote></div>"
"resourceType" : "SpecimenDefinition",
"id" : "2364",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: SpecimenDefinition</b><a name=\"2364\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource SpecimenDefinition "2364" </p></div><p><b>url</b>: <code>http://example.com/specdef/v1/12345</code></p><p><b>identifier</b>: id:\u00a012345</p><p><b>title</b>: Example Specimen Definition for Testing</p><p><b>status</b>: active</p><p><b>experimental</b>: false</p><p><b>typeCollected</b>: Venous blood specimen <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#122555007)</span></p><p><b>patientPreparation</b>: 12 hour fasting <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span>, At rest <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#263678003)</span></p><p><b>timeAspect</b>: preferrably morning time</p><blockquote><p><b>typeTested</b></p><p><b>isDerived</b>: false</p><p><b>type</b>: Serum specimen <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#119364003)</span></p><p><b>preference</b>: preferred</p><h3>Containers</h3><table class=\"grid\"><tr><td>-</td><td><b>Material</b></td><td><b>Type</b></td><td><b>Cap</b></td><td><b>MinimumVolume[x]</b></td></tr><tr><td>*</td><td>plastic <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#61088005)</span></td><td>Evacuated blood collection tube, thrombin/clot activator/gel separator <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#702281005)</span></td><td>yellow cap <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (unknown#yellow)</span></td><td>2 ml<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code mL = 'mL')</span></td></tr></table><blockquote><p><b>handling</b></p><p><b>temperatureQualifier</b>: Ambient temperature <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>temperatureRange</b>: 15-25 °C</p><h3>MaxDurations</h3><table class=\"grid\"><tr><td>-</td><td><b>Value</b></td><td><b>Unit</b></td><td><b>System</b></td><td><b>Code</b></td></tr><tr><td>*</td><td>60</td><td>minute</td><td><a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ucum.html\">Unified Code for Units of Measure (UCUM)</a></td><td>min</td></tr></table></blockquote><blockquote><p><b>handling</b></p><p><b>temperatureQualifier</b>: Refrigerated temperature <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>temperatureRange</b>: 2-8 °C</p><h3>MaxDurations</h3><table class=\"grid\"><tr><td>-</td><td><b>Value</b></td><td><b>Unit</b></td><td><b>System</b></td><td><b>Code</b></td></tr><tr><td>*</td><td>8</td><td>hour</td><td><a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ucum.html\">Unified Code for Units of Measure (UCUM)</a></td><td>h</td></tr></table></blockquote></blockquote><blockquote><p><b>typeTested</b></p><p><b>type</b>: Plasma specimen <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#119361006)</span></p><p><b>preference</b>: alternate</p><h3>Containers</h3><table class=\"grid\"><tr><td>-</td><td><b>Material</b></td><td><b>Type</b></td><td><b>Cap</b></td><td><b>MinimumVolume[x]</b></td></tr><tr><td>*</td><td>glass <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#32039001)</span></td><td>Evacuated blood collection tube, thrombin/clot activator/gel separator <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#702281005)</span></td><td>green cap <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (unknown#green)</span></td><td>2 ml<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code mL = 'mL')</span></td></tr></table><p><b>rejectionCriterion</b>: insufficient specimen volume <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-rejection-criteria.html\">RejectionCriterion</a>#insufficient)</span>, hemolized specimen <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-rejection-criteria.html\">RejectionCriterion</a>#hemolized)</span></p><blockquote><p><b>handling</b></p><p><b>temperatureQualifier</b>: Ambient temperature <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>temperatureRange</b>: 15-25 °C</p><h3>MaxDurations</h3><table class=\"grid\"><tr><td>-</td><td><b>Value</b></td><td><b>Unit</b></td><td><b>System</b></td><td><b>Code</b></td></tr><tr><td>*</td><td>60</td><td>minute</td><td><a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ucum.html\">Unified Code for Units of Measure (UCUM)</a></td><td>min</td></tr></table></blockquote><blockquote><p><b>handling</b></p><p><b>temperatureQualifier</b>: Refrigerated temperature <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>temperatureRange</b>: 2-8 °C</p><h3>MaxDurations</h3><table class=\"grid\"><tr><td>-</td><td><b>Value</b></td><td><b>Unit</b></td><td><b>System</b></td><td><b>Code</b></td></tr><tr><td>*</td><td>8</td><td>hour</td><td><a href=\"http://terminology.hl7.org/5.1.0/CodeSystem-v3-ucum.html\">Unified Code for Units of Measure (UCUM)</a></td><td>h</td></tr></table></blockquote></blockquote></div>"
},
"typeCollected": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "122555007",
"display": "Venous blood specimen"
}
]
"url" : "http://example.com/specdef/v1/12345",
"identifier" : {
"value" : "12345"
},
"patientPreparation": [
{
"text": "12 hour fasting"
"title" : "Example Specimen Definition for Testing",
"status" : "active",
"experimental" : false,
"typeCollected" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "122555007",
"display" : "Venous blood specimen"
}]
},
"patientPreparation" : [{
"text" : "12 hour fasting"
},
{
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "263678003",
"display" : "At rest"
}]
}],
"timeAspect" : "preferrably morning time",
"typeTested" : [{
"isDerived" : false,
"type" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "119364003",
"display" : "Serum specimen"
}]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "263678003",
"display": "At rest"
}
]
}
],
"timeAspect": "preferrably morning time",
"typeTested": [
{
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119364003",
"display": "Serum specimen"
}
]
"preference" : "preferred",
"container" : {
"material" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "61088005",
"display" : "plastic"
}]
},
"preference": "preferred",
"container": {
"material": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "61088005",
"display": "plastic"
}
]
},
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "702281005",
"display": "Evacuated blood collection tube, thrombin/clot activator/gel separator"
}
]
},
"cap": {
"coding": [
{
"system": "urn:iso:std:iso:6710:2017",
"code": "yellow",
"display": "yellow cap"
}
]
},
"minimumVolumeQuantity": {
"value": 2,
"unit": "ml",
"system": "http://unitsofmeasure.org",
"code": "mL"
}
"type" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "702281005",
"display" : "Evacuated blood collection tube, thrombin/clot activator/gel separator"
}]
},
"handling": [
{
"temperatureQualifier": {
"text": "Ambient temperature"
},
"temperatureRange": {
"low": {
"value": 15,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
},
"high": {
"value": 25,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"maxDuration": {
"value": 60,
"unit": "minute",
"system": "http://unitsofmeasure.org",
"code": "min"
}
"cap" : {
"coding" : [{
"system" : "urn:iso:std:iso:6710:2017",
"code" : "yellow",
"display" : "yellow cap"
}]
},
"minimumVolumeQuantity" : {
"value" : 2,
"unit" : "ml",
"system" : "http://unitsofmeasure.org",
"code" : "mL"
}
},
"handling" : [{
"temperatureQualifier" : {
"text" : "Ambient temperature"
},
"temperatureRange" : {
"low" : {
"value" : 15,
"unit" : "°C",
"system" : "http://unitsofmeasure.org",
"code" : "Cel"
},
{
"temperatureQualifier": {
"text": "Refrigerated temperature"
},
"temperatureRange": {
"low": {
"value": 2,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
},
"high": {
"value": 8,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"maxDuration": {
"value": 8,
"unit": "hour",
"system": "http://unitsofmeasure.org",
"code": "h"
}
"high" : {
"value" : 25,
"unit" : "°C",
"system" : "http://unitsofmeasure.org",
"code" : "Cel"
}
]
},
"maxDuration" : {
"value" : 60,
"unit" : "minute",
"system" : "http://unitsofmeasure.org",
"code" : "min"
}
},
{
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119361006",
"display": "Plasma specimen"
}
]
"temperatureQualifier" : {
"text" : "Refrigerated temperature"
},
"preference": "alternate",
"container": {
"material": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "32039001",
"display": "glass"
}
]
},
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "767390000",
"display": "Evacuated blood collection tube with heparin lithium and gel separator"
}
]
},
"cap": {
"coding": [
{
"system": "urn:iso:std:iso:6710:2017",
"code": "green",
"display": "green cap"
}
]
"temperatureRange" : {
"low" : {
"value" : 2,
"unit" : "°C",
"system" : "http://unitsofmeasure.org",
"code" : "Cel"
},
"minimumVolumeQuantity": {
"value": 2,
"unit": "ml",
"system": "http://unitsofmeasure.org",
"code": "mL"
"high" : {
"value" : 8,
"unit" : "°C",
"system" : "http://unitsofmeasure.org",
"code" : "Cel"
}
},
"rejectionCriterion": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/rejection-criteria",
"code": "insufficient",
"display": "insufficient specimen volume"
}
]
"maxDuration" : {
"value" : 8,
"unit" : "hour",
"system" : "http://unitsofmeasure.org",
"code" : "h"
}
}]
},
{
"type" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "119361006",
"display" : "Plasma specimen"
}]
},
"preference" : "alternate",
"container" : {
"material" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "32039001",
"display" : "glass"
}]
},
"type" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "702281005",
"display" : "Evacuated blood collection tube, thrombin/clot activator/gel separator"
}]
},
"cap" : {
"coding" : [{
"system" : "urn:iso:std:iso:6710:2017",
"code" : "green",
"display" : "green cap"
}]
},
"minimumVolumeQuantity" : {
"value" : 2,
"unit" : "ml",
"system" : "http://unitsofmeasure.org",
"code" : "mL"
}
},
"rejectionCriterion" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/rejection-criteria",
"code" : "insufficient",
"display" : "insufficient specimen volume"
}]
},
{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/rejection-criteria",
"code" : "hemolized",
"display" : "hemolized specimen"
}]
}],
"handling" : [{
"temperatureQualifier" : {
"text" : "Ambient temperature"
},
"temperatureRange" : {
"low" : {
"value" : 15,
"unit" : "°C",
"system" : "http://unitsofmeasure.org",
"code" : "Cel"
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/rejection-criteria",
"code": "hemolized",
"display": "hemolized specimen"
}
]
"high" : {
"value" : 25,
"unit" : "°C",
"system" : "http://unitsofmeasure.org",
"code" : "Cel"
}
],
"handling": [
{
"temperatureQualifier": {
"text": "Ambient temperature"
},
"temperatureRange": {
"low": {
"value": 15,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
},
"high": {
"value": 25,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"maxDuration": {
"value": 60,
"unit": "minute",
"system": "http://unitsofmeasure.org",
"code": "min"
}
},
"maxDuration" : {
"value" : 60,
"unit" : "minute",
"system" : "http://unitsofmeasure.org",
"code" : "min"
}
},
{
"temperatureQualifier" : {
"text" : "Refrigerated temperature"
},
"temperatureRange" : {
"low" : {
"value" : 2,
"unit" : "°C",
"system" : "http://unitsofmeasure.org",
"code" : "Cel"
},
{
"temperatureQualifier": {
"text": "Refrigerated temperature"
},
"temperatureRange": {
"low": {
"value": 2,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
},
"high": {
"value": 8,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"maxDuration": {
"value": 8,
"unit": "hour",
"system": "http://unitsofmeasure.org",
"code": "h"
}
"high" : {
"value" : 8,
"unit" : "°C",
"system" : "http://unitsofmeasure.org",
"code" : "Cel"
}
]
}
]
},
"maxDuration" : {
"value" : 8,
"unit" : "hour",
"system" : "http://unitsofmeasure.org",
"code" : "h"
}
}]
}]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R5
hl7.fhir.core#5.0.0
generated
on
Fri,
Nov
1,
2019
09:36+1100.
QA
Page
Sun,
Mar
26,
2023
15:26+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R4B
|
|
Propose
a
change