Release 4 5 Preview #2
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Orders and Observations Work Group Maturity Level : 0 1   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the SpecimenDefinition resource.

SpecimenDefinition
Element Id SpecimenDefinition
Definition

A kind of specimen with associated set of requirements.

Cardinality 0..*
Type DomainResource
SpecimenDefinition.url
Element Id SpecimenDefinition.url
Definition

An absolute URL that is used to identify this SpecimenDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this SpecimenDefinition is (or will be) published. The URL SHOULD include the major version of the SpecimenDefinition. For more information see Technical and Business Versions.

Cardinality 0..1
Type uri
Requirements

Allows the SpecimenDefinition to be referenced by a single globally unique identifier.

Summary true
Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.

SpecimenDefinition.identifier
Element Id SpecimenDefinition.identifier
Definition

A business identifier associated with the kind of specimen. assigned to this SpecimenDefinition.

Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..1
Type Identifier
Summary true
SpecimenDefinition.version
Element Id SpecimenDefinition.version
Definition

The identifier that is used to identify this version of the SpecimenDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the SpecimenDefinition author and is not expected to be globally unique.

Note This is a business versionId, not a resource version id (see discussion )
Cardinality 0..1
Type string
Summary true
Comments

There may be multiple different instances of a SpecimenDefinition that have the same identifier but different versions.

SpecimenDefinition.title
Element Id SpecimenDefinition.title
Definition

A short, descriptive, user-friendly title for the SpecimenDefinition.

Cardinality 0..1
Type string
Summary true
SpecimenDefinition.derivedFromCanonical
Element Id SpecimenDefinition.derivedFromCanonical
Definition

The canonical URL pointing to another FHIR-defined SpecimenDefinition that is adhered to in whole or in part by this definition.

Cardinality 0..*
Type canonical ( SpecimenDefinition )
Summary true
SpecimenDefinition.derivedFromUri
Element Id SpecimenDefinition.derivedFromUri
Definition

The URL pointing to an externally-defined type of specimen, guideline or other definition that is adhered to in whole or in part by this definition.

Cardinality 0..*
Type uri
Requirements

Specimen definitions may be refinements of other definitions.

Summary true
SpecimenDefinition.status
Element Id SpecimenDefinition.status
Definition

The current state of theSpecimenDefinition.

Cardinality 1..1
Terminology Binding PublicationStatus ( Required )
Type code
Is Modifier true (Reason: Not known why this is labelled a modifier)
Summary true
Comments

A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

SpecimenDefinition.experimental
Element Id SpecimenDefinition.experimental
Definition

A flag to indicate that this SpecimenDefinition is not authored for genuine usage.

Cardinality 0..1
Type boolean
Is Modifier true (Reason: Not known why this is labelled a modifier)
Summary true
Comments

Allows filtering of SpecimenDefinition that are appropriate for use vs. not.

SpecimenDefinition.subject[x]
Element Id SpecimenDefinition.subject[x]
Definition

A code or group definition that describes the intended subject from which this kind of specimen is to be collected.

Cardinality 0..1
Type CodeableConcept | Reference ( Group )
[x] Note See Choice of Data Types for further information about how to use [x]
Summary true
Comments

Examples: person, animal, device, water ….

SpecimenDefinition.date
Element Id SpecimenDefinition.date
Definition

For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.

Cardinality 0..1
Type dateTime
Summary true
SpecimenDefinition.publisher
Element Id SpecimenDefinition.publisher
Definition

Helps establish the "authority/credibility" of the SpecimenDefinition. May also allow for contact.

Cardinality 0..1
Type Reference ( Practitioner | PractitionerRole | Organization )
Patterns Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant
Requirements

Usually an organization, but may be an individual. The publisher (or steward) of the SpecimenDefinition is the organization or individual primarily responsible for the maintenance and upkeep of the SpecimenDefinition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the SpecimenDefinition. This item SHOULD be populated unless the information is available from context.

Summary true
SpecimenDefinition.contact
Element Id SpecimenDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality 0..*
Type ContactDetail
Summary true
Comments

May be a web site, an email address, a telephone number, etc.

SpecimenDefinition.description
Element Id SpecimenDefinition.description
Definition

A free text natural language description of the SpecimenDefinition from the consumer's perspective.

Cardinality 0..1
Type markdown
Comments

This description can be used to capture details such as why the SpecimenDefinition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

SpecimenDefinition.useContext
Element Id SpecimenDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of specimen definitions.

Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Comments

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

SpecimenDefinition.jurisdiction
Element Id SpecimenDefinition.jurisdiction
Definition

A jurisdiction in which the SpecimenDefinition is intended to be used.

Cardinality 0..*
Terminology Binding Jurisdiction ( Extensible )
Type CodeableConcept
Summary true
SpecimenDefinition.purpose
Element Id SpecimenDefinition.purpose
Definition

Explains why this SpecimeDefinition is needed and why it has been designed as it has.

Cardinality 0..1
Type markdown
Comments

This element does not describe the usage of the SpecimenDefinition. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this SpecimenDefinition.

SpecimenDefinition.copyright
Element Id SpecimenDefinition.copyright
Definition

Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SpecimenDefinition.

Cardinality 0..1
Type markdown
Requirements

Consumers of the SpecimenDefinition must be able to determine any legal restrictions on the use of the artifact and/or its content.

Alternate Names License; Restrictions
SpecimenDefinition.approvalDate
Element Id SpecimenDefinition.approvalDate
Definition

The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Cardinality 0..1
Type date
Comments

The date may be more recent than the approval date because of minor changes / editorial corrections.

SpecimenDefinition.lastReviewDate
Element Id SpecimenDefinition.lastReviewDate
Definition

The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

Cardinality 0..1
Type date
Comments

If specified, this is usually after the approval date.

SpecimenDefinition.effectivePeriod
Element Id SpecimenDefinition.effectivePeriod
Definition

The period during which the SpecimenDefinition content was or is planned to be effective.

Cardinality 0..1
Type Period
Summary true
Comments

The effective period for a SpecimenDefinition determines when the content is applicable for usage and is independent of publication and review dates.

SpecimenDefinition.typeCollected
Element Id SpecimenDefinition.typeCollected
Definition

The kind of material to be collected.

Cardinality 0..1
Terminology Binding v2 Specimen Type ( Example )
Type CodeableConcept
Summary true
SpecimenDefinition.patientPreparation
Element Id SpecimenDefinition.patientPreparation
Definition

Preparation of the patient for specimen collection.

Cardinality 0..*
Terminology Binding Patient preparation prior specimen collection ( Example )
Type CodeableConcept
Summary true
SpecimenDefinition.timeAspect
Element Id SpecimenDefinition.timeAspect
Definition

Time aspect of specimen collection (duration or offset).

Cardinality 0..1
Type string
Summary true
SpecimenDefinition.collection
Element Id SpecimenDefinition.collection
Definition

The action to be performed for collecting the specimen.

Cardinality 0..*
Terminology Binding Specimen collection methods ( Example )
Type CodeableConcept
Summary true
SpecimenDefinition.typeTested
Element Id SpecimenDefinition.typeTested
Definition

Specimen conditioned in a container as expected by the testing laboratory.

Cardinality 0..*
SpecimenDefinition.typeTested.isDerived
Element Id SpecimenDefinition.typeTested.isDerived
Definition

Primary of secondary specimen.

Cardinality 0..1
Type boolean
SpecimenDefinition.typeTested.type
Element Id SpecimenDefinition.typeTested.type
Definition

The kind of specimen conditioned for testing expected by lab.

Cardinality 0..1
Terminology Binding v2 Specimen Type ( Example )
Type CodeableConcept
SpecimenDefinition.typeTested.preference
Element Id SpecimenDefinition.typeTested.preference
Definition

The preference for this type of conditioned specimen.

Cardinality 1..1
Terminology Binding SpecimenContainedPreference ( Required )
Type code
SpecimenDefinition.typeTested.container
Element Id SpecimenDefinition.typeTested.container
Definition

The specimen's container.

Cardinality 0..1
SpecimenDefinition.typeTested.container.material
Element Id SpecimenDefinition.typeTested.container.material
Definition

The type of material of the container.

Cardinality 0..1
Terminology Binding Types of material for specimen containers ( Example )
Type CodeableConcept
Comments

Examples: glass, plastic, metal.

SpecimenDefinition.typeTested.container.type
Element Id SpecimenDefinition.typeTested.container.type
Definition

The type of container used to contain this kind of specimen.

Cardinality 0..1
Terminology Binding Specimen Container Type ( Example )
Type CodeableConcept
SpecimenDefinition.typeTested.container.cap
Element Id SpecimenDefinition.typeTested.container.cap
Definition

Color of container cap.

Cardinality 0..1
Terminology Binding ContainerCap ( Example )
Type CodeableConcept
Requirements

From ISO 6710-2017 Table F.1 Recommended colour codes.

SpecimenDefinition.typeTested.container.description
Element Id SpecimenDefinition.typeTested.container.description
Definition

The textual description of the kind of container.

Cardinality 0..1
Type string
SpecimenDefinition.typeTested.container.capacity
Element Id SpecimenDefinition.typeTested.container.capacity
Definition

The capacity (volume or other measure) of this kind of container.

Cardinality 0..1
Type SimpleQuantity
SpecimenDefinition.typeTested.container.minimumVolume[x]
Element Id SpecimenDefinition.typeTested.container.minimumVolume[x]
Definition

The minimum volume to be conditioned in the container.

Cardinality 0..1
Type SimpleQuantity | string
[x] Note See Choice of Data Types for further information about how to use [x]
SpecimenDefinition.typeTested.container.additive
Element Id SpecimenDefinition.typeTested.container.additive
Definition

Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

Cardinality 0..*
SpecimenDefinition.typeTested.container.additive.additive[x]
Element Id SpecimenDefinition.typeTested.container.additive.additive[x]
Definition

Substance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

Cardinality 1..1
Terminology Binding v2 Additive ( Example )
Type CodeableConcept | Reference ( Substance )
[x] Note See Choice of Data Types for further information about how to use [x]
SpecimenDefinition.typeTested.container.preparation
Element Id SpecimenDefinition.typeTested.container.preparation
Definition

Special processing that should be applied to the container for this kind of specimen.

Cardinality 0..1
Type string
SpecimenDefinition.typeTested.requirement
Element Id SpecimenDefinition.typeTested.requirement
Definition

Requirements for delivery and special handling of this kind of conditioned specimen.

Cardinality 0..1
Type string
SpecimenDefinition.typeTested.retentionTime
Element Id SpecimenDefinition.typeTested.retentionTime
Definition

The usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.

Cardinality 0..1
Type Duration
SpecimenDefinition.typeTested.singleUse
Element Id SpecimenDefinition.typeTested.singleUse
Definition

Specimen can be used by only one test or panel if the value is "true".

Cardinality 0..1
Type boolean
SpecimenDefinition.typeTested.rejectionCriterion
Element Id SpecimenDefinition.typeTested.rejectionCriterion
Definition

Criterion for rejection of the specimen in its container by the laboratory.

Cardinality 0..*
Terminology Binding RejectionCriterion ( Example )
Type CodeableConcept
SpecimenDefinition.typeTested.handling
Element Id SpecimenDefinition.typeTested.handling
Definition

Set of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.

Cardinality 0..*
SpecimenDefinition.typeTested.handling.temperatureQualifier
Element Id SpecimenDefinition.typeTested.handling.temperatureQualifier
Definition

It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.

Cardinality 0..1
Terminology Binding HandlingConditionSet ( Example )
Type CodeableConcept
SpecimenDefinition.typeTested.handling.temperatureRange
Element Id SpecimenDefinition.typeTested.handling.temperatureRange
Definition

The temperature interval for this set of handling instructions.

Cardinality 0..1
Type Range
SpecimenDefinition.typeTested.handling.maxDuration
Element Id SpecimenDefinition.typeTested.handling.maxDuration
Definition

The maximum time interval of preservation of the specimen with these conditions.

Cardinality 0..1
Type Duration
SpecimenDefinition.typeTested.handling.instruction
Element Id SpecimenDefinition.typeTested.handling.instruction
Definition

Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.

Cardinality 0..1
Type string
SpecimenDefinition.typeTested.testingDestination
Element Id SpecimenDefinition.typeTested.testingDestination
Definition

Where the specimen will be tested: e.g., lab, sector, device or any combination of these.

Cardinality 0..*
Terminology Binding Diagnostic Service Section Codes ( Example )
Type CodeableConcept