Specimen - FHIR Resource (dstu2)
This Specimen Resource uses the FHIR API standard for access and structure.
Validate an Specimen FHIR Resource (dstu2)
Specimen Attributes
AttributeField is listTypeDescription
Description: available | unavailable | unsatisfactory | entered-in-error
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Specimen) status FHIR attribute
Description: Direct container of specimen (tube/slide, etc.)
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"container": Learn more about the (Specimen) container FHIR attribute
Description: Identifier assigned by the lab
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"accessionIdentifier": Learn more about the (Specimen) accessionIdentifier FHIR attribute
Description: Specimen from which this specimen originated
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"parent": Learn more about the (Specimen) parent FHIR attribute
Description: The time when specimen was received for processing
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"receivedTime": Learn more about the (Specimen) receivedTime FHIR attribute
Description: Collection details
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"collection": Learn more about the (Specimen) collection FHIR attribute
Description: Treatment and processing step details
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"treatment": Learn more about the (Specimen) treatment FHIR attribute
Description: External Identifier
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Specimen) identifier FHIR attribute
Description: Kind of material that forms the specimen
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Specimen) type FHIR attribute
Description: Where the specimen came from. This may be from the patient(s) or from the environment or a device
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject": Learn more about the (Specimen) subject FHIR attribute
Specimen Structure
{
"resourceType" : "Specimen",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Identifier
"status" : "<code>", // available | unavailable | unsatisfactory | entered-in-error
"type" : { CodeableConcept }, // Kind of material that forms the specimen
"parent" : [{ Reference(Specimen) }], // Specimen from which this specimen originated
"subject" : { Reference(Patient|Group|Device|Substance) }, // R! Where the specimen came from. This may be from the patient(s) or from the environment or a device
"accessionIdentifier" : { Identifier }, // Identifier assigned by the lab
"receivedTime" : "<dateTime>", // The time when specimen was received for processing
"collection" : { // Collection details
"collector" : { Reference(Practitioner) }, // Who collected the specimen
"comment" : ["<string>"], // Collector comments
// collected[x]: Collection time. One of these 2:
"collectedDateTime" : "<dateTime>",
"collectedPeriod" : { Period },
"quantity" : { Quantity(SimpleQuantity) }, // The quantity of specimen collected
"method" : { CodeableConcept }, // Technique used to perform collection
"bodySite" : { CodeableConcept } // Anatomical collection site
},
"treatment" : [{ // Treatment and processing step details
"description" : "<string>", // Textual description of procedure
"procedure" : { CodeableConcept }, // Indicates the treatment or processing step applied to the specimen
"additive" : [{ Reference(Substance) }] // Material used in the processing step
}],
"container" : [{ // Direct container of specimen (tube/slide, etc.)
"identifier" : [{ Identifier }], // Id for the container
"description" : "<string>", // Textual description of the container
"type" : { CodeableConcept }, // Kind of container directly associated with specimen
"capacity" : { Quantity(SimpleQuantity) }, // Container volume or size
"specimenQuantity" : { Quantity(SimpleQuantity) }, // Quantity of specimen within container
// additive[x]: Additive associated with container. One of these 2:
"additiveCodeableConcept" : { CodeableConcept }
"additiveReference" : { Reference(Substance) }
}]
}
Specimen Search Parameters
The following search parameters can be used to query Specimen resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/Specimen?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
accession | text | accessionIdentifier |
bodysite | text | collection.bodySite |
collected | date | collection.collected[x] |
collector | reference | collection.collector |
container | text | container.type |
container-id | text | container.identifier |
identifier | text | identifier |
parent | reference | parent |
patient | reference | subject |
subject | reference | subject |
type | text | type |
