Release 4 R6 Ballot (1st Full Ballot)

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU v6.0.0-ballot4: Release 6 Ballot (1st Full Ballot) (see Ballot Notes ) 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 for published versions icon . Page versions: R5 R4B R4 R3 R2

Responsible Owner: Orders and Observations icon Work Group Maturity Level : 2   Trial Use Normative Security Category : Patient Compartments : Device , Group , Patient , Practitioner

Detailed Descriptions for the elements in the Specimen resource.

Specimen.accessionIdentifier Definition The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. string
Element Id Specimen
Definition

A sample to be used for analysis.

Short Display Sample for analysis
Cardinality 0..*
Type DomainResource
Summary Specimen.identifier false
Element Id Constraints Specimen.identifier Definition 0..*
Defined on this element Id for specimen.
spm-1 Note Rule This Specimen.collection.collector SHALL only be present if Specimen.collection.procedure is a business identifier, not a resource identifier (see discussion ) present Cardinality collection.collector.empty() or collection.procedure.empty()
Summary Element Id true Specimen.identifier
Definition

Identifiers used for specimen identification. These could include but are not limited to identifiers generated upon collection, accessioning, or other reasons for labeling a specimen.

Element Id Short Display Specimen.accessionIdentifier Primary specimen identifier
Definition Note The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen a business identifier, depending on local lab procedures. not a resource identifier (see discussion )
Cardinality 0..1 0..*
Type Identifier
Summary true
Comments

These are business identifiers, not Specimen.id - the resource identifier. More information in this (see discussion ). For accession identifiers, the Accession Identifier code, ACSN, should be used in the Identifier.type.

Element Id Specimen.status
Definition

The availability of the specimen.

Short Display available | unavailable | unsatisfactory | entered-in-error
Cardinality 0..1
Terminology Binding SpecimenStatus Specimen Status ( Required )
Type code
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summary true
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Element Id Specimen.type
Definition

The kind of material that forms the specimen.

Short Display Kind of material that forms the specimen
Cardinality 0..1
Terminology Binding v2 Specimen Type hl7VS-specimenType icon ( Example )
Type CodeableConcept
Summary true
Comments

The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.

Element Id Specimen.subject
Definition

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 substance, a biologically-derived product, or a device.

Short Display 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
Cardinality 0..1
Type Reference ( Patient | Group | Device | BiologicallyDerivedProduct | Substance | Location | NutritionProduct )
Requirements

Must know the subject context.

Summary true
Element Id Specimen.receivedTime
Definition

Time when specimen was is received by the testing laboratory for processing or testing.

Short Display The time when specimen is received by the testing laboratory
Cardinality 0..1
Type dateTime
Summary true
Element Id Specimen.parent
Definition

Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

Short Display Specimen from which this specimen originated
Cardinality 0..*
Type Reference ( Specimen )
Comments Hierarchy This reference is part of a strict Hierarchy
Summary false
Comments

The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.

Element Id Specimen.request
Definition

Details concerning a service request that required a specimen to be collected.

Short Display Why the specimen was collected
Cardinality 0..*
Type Reference ( ServiceRequest )
Comments Summary false
Comments

The request may be explicit or implied such with a ServiceRequest that requires a blood draw.

Element Id Specimen.combined
Definition

This element signifies if the specimen is part of a group or pooled.

Short Display grouped | pooled
Cardinality 0..1
Terminology Binding Specimen Combined ( Required )
Type code
Summary true
Element Id Specimen.role
Definition

The role or reason for the specimen in the testing workflow.

Short Display The role the specimen serves
Cardinality 0..*
Terminology Binding Specimen Role ( Preferred )
Type CodeableConcept
Summary false
Element Id Specimen.feature
Definition

A physical feature or landmark on a specimen, highlighted for context by the collector of the specimen (e.g. surgeon), that identifies the type of feature as well as its meaning (e.g. the red ink indicating the resection margin of the right lobe of the excised prostate tissue or wire loop at radiologically suspected tumor location).

Short Display The physical feature of a specimen
Cardinality 0..*
Summary false
Element Id Specimen.feature.type
Definition

The landmark or feature being highlighted.

Short Display Highlighted feature
Cardinality 1..1
Terminology Binding SNOMED CT Body Structures ( Example )
Type CodeableConcept
Summary false
Element Id Specimen.feature.description
Definition

Description of the feature of the specimen.

Short Display Information about the feature
Cardinality 1..1
Type string
Summary false
Element Id Specimen.collection
Definition

Details concerning the specimen collection.

Short Display Collection details
Cardinality 0..1
Summary false
Element Id Specimen.collection.collector
Definition

Person who collected the specimen.

Short Display Who collected the specimen
Cardinality 0..1
Type Reference ( Organization | Practitioner | PractitionerRole | Patient | RelatedPerson )
Summary true
Constraints
Affect this element
spm-1 Rule Specimen.collection.collector SHALL only be present if Specimen.collection.procedure is not present collection.collector.empty() or collection.procedure.empty()
Element Id Specimen.collection.collected[x]
Definition

Time when specimen was collected from subject - the physiologically relevant time.

Short Display Collection time
Cardinality 0..1
Type dateTime | Period
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Summary true
Element Id Specimen.collection.duration
Definition

The span of time over which the collection of a specimen occurred.

Short Display How long it took to collect specimen
Cardinality 0..1
Type Duration
Summary true
Element Id Specimen.collection.quantity
Definition

The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.

Short Display The quantity of specimen collected
Cardinality 0..1
Type SimpleQuantity
Summary false
Element Id Specimen.collection.method
Definition

A coded value specifying the technique that is used to perform the procedure.

Short Display Technique used to perform collection
Cardinality 0..1
Terminology Binding FHIR Specimen Collection Method ( Example )
Type CodeableConcept
Summary false
Element Id Specimen.collection.device[x]
Definition

A coded value specifying the device that is used to perform the procedure.

Short Display Device used to perform collection
Cardinality 0..1
Terminology Binding Specimen Container ( Example )
Type CodeableConcept | Reference ( Device )| canonical ( DeviceDefinition )
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
Element Id Specimen.collection.procedure
Definition

The procedure event during which the specimen was collected (e.g. the surgery leading to the collection of a pathology sample).

Short Display The procedure that collects the specimen
Cardinality 0..1
Type Reference ( Procedure )
Summary false
Constraints
Affect this element
spm-1 Rule Specimen.collection.collector SHALL only be present if Specimen.collection.procedure is not present collection.collector.empty() or collection.procedure.empty()
Element Id Specimen.collection.bodySite
Definition

Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

Short Display Anatomical collection site
Cardinality 0..1
Terminology Binding SNOMED CT Body Structures ( Example )
Type CodeableReference ( BodyStructure )
CodeableConcept Summary false
Comments

If the use case requires BodySite Reasons for using BodyStructure reference include: 1.) Need to be handled as identify a separate resource instead of an inline coded element specific site instance (e.g. to identify and track separately) then use a specific mole), 2.) a single pre-coordinated coded concept for the standard extension body site does not exist, 3.) a desire to represent bodySite . using multiple attributes (e.g. modifiers).

Element Id Specimen.collection.fastingStatus[x]
Definition

Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.

Short Display Whether or how long patient abstained from food and/or drink
Cardinality 0..1
Terminology Binding v2 Relevant Clincial Information hl7VS-relevantClincialInformation icon ( Extensible )
Type CodeableConcept | Duration
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Requirements

Many diagnostic tests require fasting to facilitate accurate interpretation.

Summary true
Comments

Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/​time] in 2 hour Urine --12 hours fasting), or using a component observation such as Observation.component code` = LOINC 49541-6 (Fasting status - Reported).

Element Id Specimen.processing
Definition

Details concerning processing and processing steps for the specimen.

Short Display Processing and processing step details
Cardinality 0..*
Summary false
Element Id Specimen.processing.description
Definition

Textual description of procedure.

Short Display Textual description of procedure
Cardinality 0..1
Type string
Summary false
Element Id Specimen.processing.procedure Specimen.processing.method
Definition

A coded value specifying the procedure method used to process the specimen.

Short Display Indicates the treatment step applied to the specimen
Cardinality 0..1
Terminology Binding Specimen processing procedure Processing Method ( Example )
Type CodeableConcept
Summary false
Element Id Specimen.processing.additive Specimen.processing.performer
Definition

Material used in The performer of the processing step. of the specimen.

Short Display Entity processing specimen
Cardinality 0..* 0..1
Type Reference ( Substance Practitioner | PractitionerRole | Patient | RelatedPerson )
Summary true
Element Id Specimen.processing.time[x] Specimen.processing.device[x]
Definition

A record of the time or period when The device used in the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin. specimen.

Short Display Device used to process the specimen
Cardinality 0..1
Terminology Binding Processing Device Code ( Example )
Type dateTime CodeableConcept | Period Reference ( Device )| canonical ( DeviceDefinition )
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Summary Specimen.container Element Id Specimen.container false
Element Id Specimen.container.identifier Specimen.processing.additive
Definition

Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id Material used in some circumstances. the processing step.

Note Short Display This is a business identifier, not a resource identifier (see discussion ) Material used in the processing step
Cardinality 0..*
Type Identifier CodeableReference ( Substance | SubstanceDefinition )
Summary true false
Element Id Specimen.container.description Specimen.processing.time[x]
Definition

Textual description A record of the container. time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.

Short Display Date and time of specimen processing
Cardinality 0..1
Type dateTime | Period | Duration
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
Element Id Specimen.container.type Specimen.container
Definition

The type of container associated with holding the specimen (e.g. slide, aliquot, etc.). specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

Cardinality Short Display 0..1 Direct container of specimen (tube/slide, etc.)
Terminology Binding Cardinality Specimen container ( Example ) 0..*
Type Summary CodeableConcept false
Element Id Specimen.container.capacity Specimen.container.device[x]
Definition

The capacity (volume or other measure) device resource for the the container may contain. holding the specimen. If the container is in a holder then the referenced device will point to a parent device.

Short Display Device resource for the container
Cardinality 0..1 1..1
Type Terminology Binding SimpleQuantity Container Device Code ( Example )
Type Specimen.container.specimenQuantity Element Id Specimen.container.specimenQuantity CodeableConcept | Reference ( Device )| canonical ( DeviceDefinition )
Definition [x] Note The quantity See Choice of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. Datatypes for further information about how to use [x]
Cardinality Summary 0..1 false
Element Id Specimen.container.additive[x] Specimen.container.specimenQuantity
Definition

Introduced substance to preserve, maintain The quantity of specimen in the container; may be volume, dimensions, or enhance other appropriate measurements, depending on the specimen. Examples: Formalin, Citrate, EDTA. specimen type.

Cardinality Short Display 0..1 Quantity of specimen within container
Terminology Binding Cardinality v2 Additive ( Example ) 0..1
Type CodeableConcept | Reference ( Substance SimpleQuantity )
[x] Note See Choice of Data Types Summary for further information about how to use [x] false
Element Id Specimen.condition
Definition

A mode or state of being that describes the nature of the specimen.

Short Display State of the specimen
Cardinality 0..*
Terminology Binding v2 Specimen Condition hl7VS-specimenCondition icon ( Extensible Example )
Type CodeableConcept
Requirements

The specimen condition can be used to assess its quality or appropriateness for a specific test.

Summary true
Comments

Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.

Element Id Specimen.note
Definition

To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Short Display Comments
Cardinality 0..*
Type Annotation
Summary false