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 IdSpecimenDefinition
Definition

A kind of specimen with associated set of requirements.

Short DisplayKind of specimen
Cardinality0..*
TypeMetadataResource
Summaryfalse
SpecimenDefinition.url
Element IdSpecimenDefinition.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 DisplayLogical canonical URL to reference this SpecimenDefinition (globally unique)
Cardinality0..1
Typeuri
Requirements

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

Summarytrue
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 IdSpecimenDefinition.identifier
Definition

A business identifier assigned to this SpecimenDefinition.

Short DisplayBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..1
TypeIdentifier
Summarytrue
SpecimenDefinition.version
Element IdSpecimenDefinition.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 DisplayBusiness version of the SpecimenDefinition
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

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

SpecimenDefinition.versionAlgorithm[x]
Element IdSpecimenDefinition.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
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 IdSpecimenDefinition.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 DisplayName for this {{title}} (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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 IdSpecimenDefinition.title
Definition

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

Short DisplayName for this SpecimenDefinition (Human friendly)
Cardinality0..1
Typestring
Summarytrue
SpecimenDefinition.derivedFromCanonical
Element IdSpecimenDefinition.derivedFromCanonical
Definition

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

Short DisplayBased on FHIR definition of another SpecimenDefinition
Cardinality0..*
Typecanonical(SpecimenDefinition)
Summarytrue
SpecimenDefinition.derivedFromUri
Element IdSpecimenDefinition.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 DisplayBased on external definition
Cardinality0..*
Typeuri
Requirements

Specimen definitions may be refinements of other definitions.

Summarytrue
SpecimenDefinition.status
Element IdSpecimenDefinition.status
Definition

The current state of theSpecimenDefinition.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
Summarytrue
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 IdSpecimenDefinition.experimental
Definition

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

Short DisplayIf this SpecimenDefinition is not for real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Summarytrue
Comments

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

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

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

Short DisplayType of subject for specimen collection
Cardinality0..1
TypeCodeableConcept|Reference(Group)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

Examples: person, animal, device, water ….

SpecimenDefinition.date
Element IdSpecimenDefinition.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 DisplayDate status first applied
Cardinality0..1
TypedateTime
Summarytrue
Comments

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

SpecimenDefinition.publisher
Element IdSpecimenDefinition.publisher
Definition

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

Short DisplayThe name of the individual or organization that published the SpecimenDefinition
Cardinality0..1
Typestring
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.

Summarytrue
SpecimenDefinition.contact
Element IdSpecimenDefinition.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
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 IdSpecimenDefinition.description
Definition

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

Short DisplayNatural language description of the SpecimenDefinition
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdSpecimenDefinition.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 DisplayContent intends to support these contexts
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summaryfalse
Comments

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

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

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

Short DisplayIntended jurisdiction for this SpecimenDefinition (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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 IdSpecimenDefinition.purpose
Definition

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

Short DisplayWhy this SpecimenDefinition is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdSpecimenDefinition.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 DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

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

Alternate NamesLicense; Restrictions
Summaryfalse
SpecimenDefinition.copyrightLabel
Element IdSpecimenDefinition.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 DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

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

Summaryfalse
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 IdSpecimenDefinition.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 DisplayWhen SpecimenDefinition was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
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 IdSpecimenDefinition.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 DisplayThe date on which the asset content was last reviewed by the publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

If specified, this is usually after the approval date.

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

SpecimenDefinition.effectivePeriod
Element IdSpecimenDefinition.effectivePeriod
Definition

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

Short DisplayThe effective date range for the SpecimenDefinition
Cardinality0..1
TypePeriod
Summarytrue
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 IdSpecimenDefinition.typeCollected
Definition

The kind of material to be collected.

Short DisplayKind of material to collect
Cardinality0..1
Terminology Bindinghl7VS-specimenType icon (Example)
TypeCodeableConcept
Summarytrue
SpecimenDefinition.patientPreparation
Element IdSpecimenDefinition.patientPreparation
Definition

Preparation of the patient for specimen collection.

Short DisplayPatient preparation for collection
Cardinality0..*
Terminology BindingPatient preparation prior specimen collection (Example)
TypeCodeableConcept
Summarytrue
SpecimenDefinition.timeAspect
Element IdSpecimenDefinition.timeAspect
Definition

Time aspect of specimen collection (duration or offset).

Short DisplayTime aspect for collection
Cardinality0..1
Typestring
Summarytrue
SpecimenDefinition.collection
Element IdSpecimenDefinition.collection
Definition

The action to be performed for collecting the specimen.

Short DisplaySpecimen collection procedure
Cardinality0..*
Terminology BindingSpecimen collection methods (Example)
TypeCodeableConcept
Summarytrue
SpecimenDefinition.typeTested
Element IdSpecimenDefinition.typeTested
Definition

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

Short DisplaySpecimen in container intended for testing by lab
Cardinality0..*
Summaryfalse
SpecimenDefinition.typeTested.isDerived
Element IdSpecimenDefinition.typeTested.isDerived
Definition

Primary of secondary specimen.

Short DisplayPrimary or secondary specimen
Cardinality0..1
Typeboolean
Summaryfalse
SpecimenDefinition.typeTested.type
Element IdSpecimenDefinition.typeTested.type
Definition

The kind of specimen conditioned for testing expected by lab.

Short DisplayType of intended specimen
Cardinality0..1
Terminology Bindinghl7VS-specimenType icon (Example)
TypeCodeableConcept
Summaryfalse
SpecimenDefinition.typeTested.preference
Element IdSpecimenDefinition.typeTested.preference
Definition

The preference for this type of conditioned specimen.

Short Displaypreferred | alternate
Cardinality1..1
Terminology BindingSpecimen Contained Preference (Required)
Typecode
Summaryfalse
SpecimenDefinition.typeTested.container
Element IdSpecimenDefinition.typeTested.container
Definition

The specimen's container.

Short DisplayThe specimen's container
Cardinality0..1
Summaryfalse
SpecimenDefinition.typeTested.container.material
Element IdSpecimenDefinition.typeTested.container.material
Definition

The type of material of the container.

Short DisplayThe material type used for the container
Cardinality0..1
Terminology BindingTypes of material for specimen containers (Example)
TypeCodeableConcept
Summaryfalse
Comments

Examples: glass, plastic, metal.

SpecimenDefinition.typeTested.container.type
Element IdSpecimenDefinition.typeTested.container.type
Definition

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

Short DisplayKind of container associated with the kind of specimen
Cardinality0..1
Terminology BindingSpecimen Container Type (Example)
TypeCodeableConcept
Summaryfalse
SpecimenDefinition.typeTested.container.cap
Element IdSpecimenDefinition.typeTested.container.cap
Definition

Color of container cap.

Short DisplayColor of container cap
Cardinality0..1
Terminology BindingContainer Cap (Example)
TypeCodeableConcept
Requirements

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

Summaryfalse
SpecimenDefinition.typeTested.container.description
Element IdSpecimenDefinition.typeTested.container.description
Definition

The textual description of the kind of container.

Short DisplayThe description of the kind of container
Cardinality0..1
Typemarkdown
Summaryfalse
SpecimenDefinition.typeTested.container.capacity
Element IdSpecimenDefinition.typeTested.container.capacity
Definition

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

Short DisplayThe capacity of this kind of container
Cardinality0..1
TypeSimpleQuantity
Summaryfalse
SpecimenDefinition.typeTested.container.minimumVolume[x]
Element IdSpecimenDefinition.typeTested.container.minimumVolume[x]
Definition

The minimum volume to be conditioned in the container.

Short DisplayMinimum volume
Cardinality0..1
TypeSimpleQuantity|string
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
SpecimenDefinition.typeTested.container.additive
Element IdSpecimenDefinition.typeTested.container.additive
Definition

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

Short DisplayAdditive associated with container
Cardinality0..*
Summaryfalse
SpecimenDefinition.typeTested.container.additive.additive[x]
Element IdSpecimenDefinition.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 DisplayAdditive associated with container
Cardinality1..1
Terminology Bindinghl7VS-additivePreservative icon (Example)
TypeCodeableConcept|Reference(SubstanceDefinition)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
SpecimenDefinition.typeTested.container.preparation
Element IdSpecimenDefinition.typeTested.container.preparation
Definition

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

Short DisplaySpecial processing applied to the container for this specimen type
Cardinality0..1
Typemarkdown
Summaryfalse
SpecimenDefinition.typeTested.requirement
Element IdSpecimenDefinition.typeTested.requirement
Definition

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

Short DisplayRequirements for specimen delivery and special handling
Cardinality0..1
Typemarkdown
Summaryfalse
SpecimenDefinition.typeTested.retentionTime
Element IdSpecimenDefinition.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 DisplayThe usual time for retaining this kind of specimen
Cardinality0..1
TypeDuration
Summaryfalse
SpecimenDefinition.typeTested.singleUse
Element IdSpecimenDefinition.typeTested.singleUse
Definition

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

Short DisplaySpecimen for single use only
Cardinality0..1
Typeboolean
Summaryfalse
SpecimenDefinition.typeTested.rejectionCriterion
Element IdSpecimenDefinition.typeTested.rejectionCriterion
Definition

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

Short DisplayCriterion specified for specimen rejection
Cardinality0..*
Terminology BindingRejection Criterion (Example)
TypeCodeableConcept
Summaryfalse
SpecimenDefinition.typeTested.handling
Element IdSpecimenDefinition.typeTested.handling
Definition

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

Short DisplaySpecimen handling before testing
Cardinality0..*
Summaryfalse
SpecimenDefinition.typeTested.handling.temperatureQualifier
Element IdSpecimenDefinition.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 DisplayQualifies the interval of temperature
Cardinality0..1
Terminology BindingHandling Condition Set (Example)
TypeCodeableConcept
Summaryfalse
SpecimenDefinition.typeTested.handling.temperatureRange
Element IdSpecimenDefinition.typeTested.handling.temperatureRange
Definition

The temperature interval for this set of handling instructions.

Short DisplayTemperature range for these handling instructions
Cardinality0..1
TypeRange
Summaryfalse
SpecimenDefinition.typeTested.handling.maxDuration
Element IdSpecimenDefinition.typeTested.handling.maxDuration
Definition

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

Short DisplayMaximum preservation time
Cardinality0..1
TypeDuration
Summaryfalse
SpecimenDefinition.typeTested.handling.instruction
Element IdSpecimenDefinition.typeTested.handling.instruction
Definition

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

Short DisplayPreservation instruction
Cardinality0..1
Typemarkdown
Summaryfalse
SpecimenDefinition.typeTested.testingDestination
Element IdSpecimenDefinition.typeTested.testingDestination
Definition

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

Short DisplayWhere the specimen will be tested
Cardinality0..*
Terminology BindingDiagnostic Service Section Codes (Example)
TypeCodeableConcept
Summaryfalse