Current Build
Orders and Observations Work GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the SpecimenDefinition resource.

SpecimenDefinition
Element IdSpecimenDefinition
Definition

A kind of specimen with associated set of requirements.

Cardinality0..*
TypeDomainResource
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.

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.

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.

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

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

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.

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.

Cardinality0..*
Typeuri
Requirements

Specimen definitions may be refinements of other definitions.

Summarytrue
SpecimenDefinition.status
Element IdSpecimenDefinition.status
Definition

The current state of theSpecimenDefinition.

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

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

Cardinality0..1
Typeboolean
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
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.

Cardinality0..1
TypeCodeableConcept|Reference(Group)
[x] NoteSee Choice of Data Types 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.

Cardinality0..1
TypedateTime
Summarytrue
SpecimenDefinition.publisher
Element IdSpecimenDefinition.publisher
Definition

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

Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization)
PatternsReference(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.

Summarytrue
SpecimenDefinition.contact
Element IdSpecimenDefinition.contact
Definition

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

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

SpecimenDefinition.description
Element IdSpecimenDefinition.description
Definition

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

Cardinality0..1
Typemarkdown
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 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.

Cardinality0..*
TypeUsageContext
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 IdSpecimenDefinition.jurisdiction
Definition

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

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
SpecimenDefinition.purpose
Element IdSpecimenDefinition.purpose
Definition

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

Cardinality0..1
Typemarkdown
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.

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
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.

Cardinality0..1
Typedate
Comments

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

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.

Cardinality0..1
Typedate
Comments

If specified, this is usually after the approval date.

SpecimenDefinition.effectivePeriod
Element IdSpecimenDefinition.effectivePeriod
Definition

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

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.

SpecimenDefinition.typeCollected
Element IdSpecimenDefinition.typeCollected
Definition

The kind of material to be collected.

Cardinality0..1
Terminology Bindingv2 Specimen Type (Example)
TypeCodeableConcept
Summarytrue
SpecimenDefinition.patientPreparation
Element IdSpecimenDefinition.patientPreparation
Definition

Preparation of the patient for specimen 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).

Cardinality0..1
Typestring
Summarytrue
SpecimenDefinition.collection
Element IdSpecimenDefinition.collection
Definition

The action to be performed for collecting the specimen.

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.

Cardinality0..*
SpecimenDefinition.typeTested.isDerived
Element IdSpecimenDefinition.typeTested.isDerived
Definition

Primary of secondary specimen.

Cardinality0..1
Typeboolean
SpecimenDefinition.typeTested.type
Element IdSpecimenDefinition.typeTested.type
Definition

The kind of specimen conditioned for testing expected by lab.

Cardinality0..1
Terminology Bindingv2 Specimen Type (Example)
TypeCodeableConcept
SpecimenDefinition.typeTested.preference
Element IdSpecimenDefinition.typeTested.preference
Definition

The preference for this type of conditioned specimen.

Cardinality1..1
Terminology BindingSpecimenContainedPreference (Required)
Typecode
SpecimenDefinition.typeTested.container
Element IdSpecimenDefinition.typeTested.container
Definition

The specimen's container.

Cardinality0..1
SpecimenDefinition.typeTested.container.material
Element IdSpecimenDefinition.typeTested.container.material
Definition

The type of material of the container.

Cardinality0..1
Terminology BindingTypes of material for specimen containers (Example)
TypeCodeableConcept
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.

Cardinality0..1
Terminology BindingSpecimen Container Type (Example)
TypeCodeableConcept
SpecimenDefinition.typeTested.container.cap
Element IdSpecimenDefinition.typeTested.container.cap
Definition

Color of container cap.

Cardinality0..1
Terminology BindingContainerCap (Example)
TypeCodeableConcept
Requirements

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

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

The textual description of the kind of container.

Cardinality0..1
Typestring
SpecimenDefinition.typeTested.container.capacity
Element IdSpecimenDefinition.typeTested.container.capacity
Definition

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

Cardinality0..1
TypeSimpleQuantity
SpecimenDefinition.typeTested.container.minimumVolume[x]
Element IdSpecimenDefinition.typeTested.container.minimumVolume[x]
Definition

The minimum volume to be conditioned in the container.

Cardinality0..1
TypeSimpleQuantity|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
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.

Cardinality0..*
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.

Cardinality1..1
Terminology Bindingv2 Additive (Example)
TypeCodeableConcept|Reference(Substance)
[x] NoteSee Choice of Data Types for further information about how to use [x]
SpecimenDefinition.typeTested.container.preparation
Element IdSpecimenDefinition.typeTested.container.preparation
Definition

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

Cardinality0..1
Typestring
SpecimenDefinition.typeTested.requirement
Element IdSpecimenDefinition.typeTested.requirement
Definition

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

Cardinality0..1
Typestring
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.

Cardinality0..1
TypeDuration
SpecimenDefinition.typeTested.singleUse
Element IdSpecimenDefinition.typeTested.singleUse
Definition

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

Cardinality0..1
Typeboolean
SpecimenDefinition.typeTested.rejectionCriterion
Element IdSpecimenDefinition.typeTested.rejectionCriterion
Definition

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

Cardinality0..*
Terminology BindingRejectionCriterion (Example)
TypeCodeableConcept
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.

Cardinality0..*
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.

Cardinality0..1
Terminology BindingHandlingConditionSet (Example)
TypeCodeableConcept
SpecimenDefinition.typeTested.handling.temperatureRange
Element IdSpecimenDefinition.typeTested.handling.temperatureRange
Definition

The temperature interval for this set of handling instructions.

Cardinality0..1
TypeRange
SpecimenDefinition.typeTested.handling.maxDuration
Element IdSpecimenDefinition.typeTested.handling.maxDuration
Definition

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

Cardinality0..1
TypeDuration
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'.

Cardinality0..1
Typestring
SpecimenDefinition.typeTested.testingDestination
Element IdSpecimenDefinition.typeTested.testingDestination
Definition

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

Cardinality0..*
Terminology BindingDiagnostic Service Section Codes (Example)
TypeCodeableConcept