FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Orders and Observations icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: No 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.

Short Display Kind of specimen
Cardinality 0..*
Type MetadataResource
Summary false
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.

Short Display Logical canonical URL to reference this SpecimenDefinition (globally unique)
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 assigned to this SpecimenDefinition.

Short Display Business identifier
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.

Short Display Business version of the SpecimenDefinition
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.versionAlgorithm[x]
Element Id SpecimenDefinition.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short Display How to compare versions
Cardinality 0..1
Terminology Binding Version Algorithm (Extensible)
Type string|Coding
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

SpecimenDefinition.name
Element Id SpecimenDefinition.name
Definition

A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short Display Name for this {{title}} (computer friendly)
Cardinality 0..1
Type string
Requirements

Support human navigation and code generation.

Summary true
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

SpecimenDefinition.title
Element Id SpecimenDefinition.title
Definition

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

Short Display Name for this SpecimenDefinition (Human friendly)
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.

Short Display Based on FHIR definition of another SpecimenDefinition
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.

Short Display Based on external 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.

Short Display draft | active | retired | unknown
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 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.

See guidance around (not) making local changes to elements here.

SpecimenDefinition.experimental
Element Id SpecimenDefinition.experimental
Definition

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

Short Display If this SpecimenDefinition is not for real usage
Cardinality 0..1
Type boolean
Meaning if Missing If absent, this resource is treated as though it is not experimental.
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.

Short Display Type of subject for specimen collection
Cardinality 0..1
Type CodeableConcept|Reference(Group)
[x] Note See Choice of Datatypes 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.

Short Display Date status first applied
Cardinality 0..1
Type dateTime
Summary true
Comments

See guidance around (not) making local changes to elements here.

SpecimenDefinition.publisher
Element Id SpecimenDefinition.publisher
Definition

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

Short Display The name of the individual or organization that published the SpecimenDefinition
Cardinality 0..1
Type string
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.

Short Display Contact details for the publisher
Cardinality 0..*
Type ContactDetail
Summary true
Comments

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

See guidance around (not) making local changes to elements here.

SpecimenDefinition.description
Element Id SpecimenDefinition.description
Definition

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

Short Display Natural language description of the SpecimenDefinition
Cardinality 0..1
Type markdown
Summary false
Comments

This description can be used to capture details such as 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.

Short Display Content intends to support these contexts
Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary false
Comments

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

SpecimenDefinition.jurisdiction
Standards Status This element has a standards status of "Deprecated" which is different from the status of the whole resource
Element Id SpecimenDefinition.jurisdiction
Definition

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

Short Display Intended jurisdiction for this SpecimenDefinition (if applicable)
Cardinality 0..*
Terminology Binding Jurisdiction ValueSet (Extensible)
Type CodeableConcept
Summary true
Comments

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

SpecimenDefinition.purpose
Element Id SpecimenDefinition.purpose
Definition

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

Short Display Why this SpecimenDefinition is defined
Cardinality 0..1
Type markdown
Summary false
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.

Short Display Use and/or publishing restrictions
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
Summary false
SpecimenDefinition.copyrightLabel
Element Id SpecimenDefinition.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short Display Copyright holder and year(s)
Cardinality 0..1
Type string
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summary false
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

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.

Short Display When SpecimenDefinition was approved by publisher
Cardinality 0..1
Type date
Summary false
Comments

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

See guidance around (not) making local changes to elements here.

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.

Short Display The date on which the asset content was last reviewed by the publisher
Cardinality 0..1
Type date
Summary false
Comments

If specified, this is usually after the approval date.

See guidance around (not) making local changes to elements here.

SpecimenDefinition.effectivePeriod
Element Id SpecimenDefinition.effectivePeriod
Definition

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

Short Display The effective date range for the SpecimenDefinition
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.

See guidance around (not) making local changes to elements here.

SpecimenDefinition.typeCollected
Element Id SpecimenDefinition.typeCollected
Definition

The kind of material to be collected.

Short Display Kind of material to collect
Cardinality 0..1
Terminology Binding hl7VS-specimenType icon (Example)
Type CodeableConcept
Summary true
SpecimenDefinition.patientPreparation
Element Id SpecimenDefinition.patientPreparation
Definition

Preparation of the patient for specimen collection.

Short Display Patient preparation for 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).

Short Display Time aspect for collection
Cardinality 0..1
Type string
Summary true
SpecimenDefinition.collection
Element Id SpecimenDefinition.collection
Definition

The action to be performed for collecting the specimen.

Short Display Specimen collection procedure
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.

Short Display Specimen in container intended for testing by lab
Cardinality 0..*
Summary false
SpecimenDefinition.typeTested.isDerived
Element Id SpecimenDefinition.typeTested.isDerived
Definition

Primary of secondary specimen.

Short Display Primary or secondary specimen
Cardinality 0..1
Type boolean
Summary false
SpecimenDefinition.typeTested.type
Element Id SpecimenDefinition.typeTested.type
Definition

The kind of specimen conditioned for testing expected by lab.

Short Display Type of intended specimen
Cardinality 0..1
Terminology Binding hl7VS-specimenType icon (Example)
Type CodeableConcept
Summary false
SpecimenDefinition.typeTested.preference
Element Id SpecimenDefinition.typeTested.preference
Definition

The preference for this type of conditioned specimen.

Short Display preferred | alternate
Cardinality 1..1
Terminology Binding Specimen Contained Preference (Required)
Type code
Summary false
SpecimenDefinition.typeTested.container
Element Id SpecimenDefinition.typeTested.container
Definition

The specimen's container.

Short Display The specimen's container
Cardinality 0..1
Summary false
SpecimenDefinition.typeTested.container.material
Element Id SpecimenDefinition.typeTested.container.material
Definition

The type of material of the container.

Short Display The material type used for the container
Cardinality 0..1
Terminology Binding Types of material for specimen containers (Example)
Type CodeableConcept
Summary false
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.

Short Display Kind of container associated with the kind of specimen
Cardinality 0..1
Terminology Binding Specimen Container Type (Example)
Type CodeableConcept
Summary false
SpecimenDefinition.typeTested.container.cap
Element Id SpecimenDefinition.typeTested.container.cap
Definition

Color of container cap.

Short Display Color of container cap
Cardinality 0..1
Terminology Binding Container Cap (Example)
Type CodeableConcept
Requirements

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

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

The textual description of the kind of container.

Short Display The description of the kind of container
Cardinality 0..1
Type markdown
Summary false
SpecimenDefinition.typeTested.container.capacity
Element Id SpecimenDefinition.typeTested.container.capacity
Definition

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

Short Display The capacity of this kind of container
Cardinality 0..1
Type SimpleQuantity
Summary false
SpecimenDefinition.typeTested.container.minimumVolume[x]
Element Id SpecimenDefinition.typeTested.container.minimumVolume[x]
Definition

The minimum volume to be conditioned in the container.

Short Display Minimum volume
Cardinality 0..1
Type SimpleQuantity|string
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
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.

Short Display Additive associated with container
Cardinality 0..*
Summary false
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.

Short Display Additive associated with container
Cardinality 1..1
Terminology Binding hl7VS-additivePreservative icon (Example)
Type CodeableConcept|Reference(SubstanceDefinition)
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
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.

Short Display Special processing applied to the container for this specimen type
Cardinality 0..1
Type markdown
Summary false
SpecimenDefinition.typeTested.requirement
Element Id SpecimenDefinition.typeTested.requirement
Definition

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

Short Display Requirements for specimen delivery and special handling
Cardinality 0..1
Type markdown
Summary false
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.

Short Display The usual time for retaining this kind of specimen
Cardinality 0..1
Type Duration
Summary false
SpecimenDefinition.typeTested.singleUse
Element Id SpecimenDefinition.typeTested.singleUse
Definition

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

Short Display Specimen for single use only
Cardinality 0..1
Type boolean
Summary false
SpecimenDefinition.typeTested.rejectionCriterion
Element Id SpecimenDefinition.typeTested.rejectionCriterion
Definition

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

Short Display Criterion specified for specimen rejection
Cardinality 0..*
Terminology Binding Rejection Criterion (Example)
Type CodeableConcept
Summary false
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.

Short Display Specimen handling before testing
Cardinality 0..*
Summary false
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.

Short Display Qualifies the interval of temperature
Cardinality 0..1
Terminology Binding Handling Condition Set (Example)
Type CodeableConcept
Summary false
SpecimenDefinition.typeTested.handling.temperatureRange
Element Id SpecimenDefinition.typeTested.handling.temperatureRange
Definition

The temperature interval for this set of handling instructions.

Short Display Temperature range for these handling instructions
Cardinality 0..1
Type Range
Summary false
SpecimenDefinition.typeTested.handling.maxDuration
Element Id SpecimenDefinition.typeTested.handling.maxDuration
Definition

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

Short Display Maximum preservation time
Cardinality 0..1
Type Duration
Summary false
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'.

Short Display Preservation instruction
Cardinality 0..1
Type markdown
Summary false
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.

Short Display Where the specimen will be tested
Cardinality 0..*
Terminology Binding Diagnostic Service Section Codes (Example)
Type CodeableConcept
Summary false