type: resource-definitionsresource: SpecimenDefinition

SpecimenDefinition Definitions

SpecimenDefinition

Kind of specimen

Definition: A kind of specimen with associated set of requirements.

Cardinality: 0..*

Mappings: v2=OM4; rim=Role[classCode=SPEC]; w5=clinical.diagnostics

SpecimenDefinition.url

Logical canonical URL to reference this SpecimenDefinition (globally unique)

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.

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.

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

Cardinality: 0..1

Type: uri

Summary: true

SpecimenDefinition.identifier

Business identifier

Definition: A business identifier assigned to this SpecimenDefinition.

Cardinality: 0..1

Type: Identifier

Summary: true

SpecimenDefinition.version

Business version of the SpecimenDefinition

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.

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

Cardinality: 0..1

Type: string

Summary: true

SpecimenDefinition.versionAlgorithm[x]

How to compare versions

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

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.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

SpecimenDefinition.name

Name for this {{title}} (computer friendly)

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.

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.

Requirements: Support human navigation and code generation.

Cardinality: 0..1

Type: string

Summary: true

SpecimenDefinition.title

Name for this SpecimenDefinition (Human friendly)

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

Cardinality: 0..1

Type: string

Summary: true

SpecimenDefinition.derivedFromCanonical

Based on FHIR definition of another SpecimenDefinition

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

Summary: true

SpecimenDefinition.derivedFromUri

Based on external definition

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.

Requirements: Specimen definitions may be refinements of other definitions.

Cardinality: 0..*

Type: uri

Summary: true

SpecimenDefinition.status

draft | active | retired | unknown

Definition: The current state of theSpecimenDefinition.

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.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: Not known why this is labelled a modifier)

SpecimenDefinition.experimental

If this SpecimenDefinition is not for real usage

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

Comments: Allows filtering of SpecimenDefinition that are appropriate for use vs. not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

SpecimenDefinition.subject[x]

Type of subject for specimen collection

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

Comments: Examples: person, animal, device, water ….

Cardinality: 0..1

Type: CodeableConcept, Reference(Group)

Summary: true

SpecimenDefinition.date

Date status first applied

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.

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

Cardinality: 0..1

Type: dateTime

Summary: true

SpecimenDefinition.publisher

The name of the individual or organization that published the SpecimenDefinition

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

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.

Cardinality: 0..1

Type: string

Summary: true

SpecimenDefinition.contact

Contact details for the publisher

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

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

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

Cardinality: 0..*

Type: ContactDetail

Summary: true

SpecimenDefinition.description

Natural language description of the SpecimenDefinition

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

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.

Cardinality: 0..1

Type: markdown

SpecimenDefinition.useContext

Content intends to support these contexts

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.

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

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

SpecimenDefinition.jurisdiction

Jurisdiction of the authority that maintains the this SpecimenDefinition (if applicable)

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

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

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:jurisdiction

Summary: true

SpecimenDefinition.purpose

Why this SpecimenDefinition is defined

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

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.

Cardinality: 0..1

Type: markdown

SpecimenDefinition.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: Copyright statement relating to the SpecimenDefinition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the SpecimenDefinition.

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

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

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 restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Comments: The copyright symbol and the '(c)' textual representation 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.

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

Cardinality: 0..1

Type: string

SpecimenDefinition.approvalDate

When SpecimenDefinition was approved by publisher

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

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.

Cardinality: 0..1

Type: date

SpecimenDefinition.lastReviewDate

The date on which the asset content was last reviewed by the publisher

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

Comments: If specified, this is usually after the approval date.

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

Cardinality: 0..1

Type: date

SpecimenDefinition.effectivePeriod

The effective date range for the SpecimenDefinition

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

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.

Cardinality: 0..1

Type: Period

Summary: true

SpecimenDefinition.typeCollected

Kind of material to collect

Definition: The kind of material to be collected.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:v2-0487

Summary: true

Mappings: v2=OM4-6

SpecimenDefinition.patientPreparation

Patient preparation for collection

Definition: Preparation of the patient for specimen collection.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:prepare-patient-prior-specimen-collection

Summary: true

Mappings: v2=OM1-37

SpecimenDefinition.timeAspect

Time aspect for collection

Definition: Time aspect of specimen collection (duration or offset).

Cardinality: 0..1

Type: string

Summary: true

Mappings: v2=OM1-43, OM1-44

SpecimenDefinition.collection

Specimen collection procedure

Definition: The action to be performed for collecting the specimen.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:specimen-collection

Summary: true

SpecimenDefinition.typeTested

Specimen in container intended for testing by lab

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

Cardinality: 0..*

Type: BackboneElement

SpecimenDefinition.typeTested.isDerived

Primary or secondary specimen

Definition: Primary of secondary specimen.

Cardinality: 0..1

Type: boolean

Mappings: v2=OM4-2

SpecimenDefinition.typeTested.type

Type of intended specimen

Definition: The kind of specimen conditioned for testing expected by lab.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:v2-0487

Mappings: w5=FiveWs.what[x]

SpecimenDefinition.typeTested.preference

preferred | alternate

Definition: The preference for this type of conditioned specimen.

Cardinality: 1..1

Type: code

Binding: required:specimen-contained-preference

Mappings: v2=OM4-16

SpecimenDefinition.typeTested.container

The specimen's container

Definition: The specimen's container.

Cardinality: 0..1

Type: BackboneElement

SpecimenDefinition.typeTested.container.material

The material type used for the container

Definition: The type of material of the container.

Comments: Examples: glass, plastic, metal.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:container-material

SpecimenDefinition.typeTested.container.type

Kind of container associated with the kind of specimen

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

Cardinality: 0..1

Type: CodeableConcept

Binding: example:specimen-container-type

SpecimenDefinition.typeTested.container.cap

Color of container cap

Definition: Color of container cap.

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

Cardinality: 0..1

Type: CodeableConcept

Binding: example:container-cap

SpecimenDefinition.typeTested.container.description

The description of the kind of container

Definition: The textual description of the kind of container.

Cardinality: 0..1

Type: markdown

Mappings: v2=OM4-3

SpecimenDefinition.typeTested.container.capacity

The capacity of this kind of container

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

Cardinality: 0..1

Type: Quantity(SimpleQuantity)

Mappings: v2=OM4-4, OM4-5

SpecimenDefinition.typeTested.container.minimumVolume[x]

Minimum volume

Definition: The minimum volume to be conditioned in the container.

Cardinality: 0..1

Type: Quantity(SimpleQuantity), string

Mappings: v2=OM4-11

SpecimenDefinition.typeTested.container.additive

Additive associated with container

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

Cardinality: 0..*

Type: BackboneElement

Mappings: v2=OM4-7

SpecimenDefinition.typeTested.container.additive.additive[x]

Additive associated with container

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

Cardinality: 1..1

Type: CodeableConcept, Reference(SubstanceDefinition)

Binding: example:v2-0371

Mappings: v2=OM4-7

SpecimenDefinition.typeTested.container.preparation

Special processing applied to the container for this specimen type

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

Cardinality: 0..1

Type: markdown

Mappings: v2=OM4-8

SpecimenDefinition.typeTested.requirement

Requirements for specimen delivery and special handling

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

Cardinality: 0..1

Type: markdown

Mappings: v2=OM4-12

SpecimenDefinition.typeTested.retentionTime

The usual time for retaining this kind of specimen

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

Mappings: v2=OM4-14

SpecimenDefinition.typeTested.singleUse

Specimen for single use only

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

Cardinality: 0..1

Type: boolean

SpecimenDefinition.typeTested.rejectionCriterion

Criterion specified for specimen rejection

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

Cardinality: 0..*

Type: CodeableConcept

Binding: example:rejection-criteria

Mappings: v2=OM1-39

SpecimenDefinition.typeTested.handling

Specimen handling before testing

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

Cardinality: 0..*

Type: BackboneElement

SpecimenDefinition.typeTested.handling.temperatureQualifier

Qualifies the interval of temperature

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

Type: CodeableConcept

Binding: example:handling-condition

Mappings: v2=OM4-15