SpecimenDefinition - FHIR Resource (r4)
This SpecimenDefinition Resource uses the FHIR API standard for access and structure.
Validate an SpecimenDefinition FHIR Resource (r4)
SpecimenDefinition Attributes
AttributeField is listTypeDescription
Description: Business identifier of a kind of specimen
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (SpecimenDefinition) identifier FHIR attribute
Description: Kind of material to collect
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"typeCollected": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "122555007",
"display": "Venous blood specimen"
}
]
}Learn more about the (SpecimenDefinition) typeCollected FHIR attribute
Description: Patient preparation for collection
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patientPreparation": [
{
"text": "12 hour fasting"
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "263678003",
"display": "At rest"
}
]
}
]Learn more about the (SpecimenDefinition) patientPreparation FHIR attribute
Description: Time aspect for collection
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"timeAspect": "preferrably morning time"Learn more about the (SpecimenDefinition) timeAspect FHIR attribute
Description: Specimen collection procedure
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"collection": Learn more about the (SpecimenDefinition) collection FHIR attribute
Description: Specimen in container intended for testing by lab
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
]
},
"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"
}
},
"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"
}
},
{
"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"
}
}
]
},
{
"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": "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"
}
]
},
"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"
},
"high": {
"value": 25,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"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"
},
"high": {
"value": 8,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"maxDuration": {
"value": 8,
"unit": "hour",
"system": "http://unitsofmeasure.org",
"code": "h"
}
}
]
}
]Learn more about the (SpecimenDefinition) typeTested FHIR attribute
SpecimenDefinition Example
{
"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>"
},
"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": [
{
"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"
}
]
},
"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"
}
},
"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"
}
},
{
"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"
}
}
]
},
{
"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": "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"
}
]
},
"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"
},
"high": {
"value": 25,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"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"
},
"high": {
"value": 8,
"unit": "°C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"maxDuration": {
"value": 8,
"unit": "hour",
"system": "http://unitsofmeasure.org",
"code": "h"
}
}
]
}
]
}SpecimenDefinition Structure
{
"resourceType" : "SpecimenDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : { Identifier }, // Business identifier of a kind of specimen
"typeCollected" : { CodeableConcept }, // Kind of material to collect
"patientPreparation" : [{ CodeableConcept }], // Patient preparation for collection
"timeAspect" : "<string>", // Time aspect for collection
"collection" : [{ CodeableConcept }], // Specimen collection procedure
"typeTested" : [{ // Specimen in container intended for testing by lab
"isDerived" : <boolean>, // Primary or secondary specimen
"type" : { CodeableConcept }, // Type of intended specimen
"preference" : "<code>", // R! preferred | alternate
"container" : { // The specimen's container
"material" : { CodeableConcept }, // Container material
"type" : { CodeableConcept }, // Kind of container associated with the kind of specimen
"cap" : { CodeableConcept }, // Color of container cap
"description" : "<string>", // Container description
"capacity" : { Quantity(SimpleQuantity) }, // Container capacity
// minimumVolume[x]: Minimum volume. One of these 2:
"minimumVolumeQuantity" : { Quantity(SimpleQuantity) },
"minimumVolumeString" : "<string>",
"additive" : [{ // Additive associated with container
// additive[x]: Additive associated with container. One of these 2:
"additiveCodeableConcept" : { CodeableConcept }
"additiveReference" : { Reference(Substance) }
}],
"preparation" : "<string>" // Specimen container preparation
},
"requirement" : "<string>", // Specimen requirements
"retentionTime" : { Duration }, // Specimen retention time
"rejectionCriterion" : [{ CodeableConcept }], // Rejection criterion
"handling" : [{ // Specimen handling before testing
"temperatureQualifier" : { CodeableConcept }, // Temperature qualifier
"temperatureRange" : { Range }, // Temperature range
"maxDuration" : { Duration }, // Maximum preservation time
"instruction" : "<string>" // Preservation instruction
}]
}]
}
SpecimenDefinition Search Parameters
The following search parameters can be used to query SpecimenDefinition resources. Just submit them like so:
https://api.1up.health/fhir/r4/SpecimenDefinition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
container | text | typeTested.container.type |
identifier | text | identifier |
type | text | typeCollected |
