Skip to main content

SpecimenDefinition

PropertyValue
Publisher
NameSpecimenDefinition
URLhttp://hl7.org/fhir/StructureDefinition/SpecimenDefinition
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
SpecimenDefinition0..*SpecimenDefinitionA kind of specimen with associated set of requirements.
SpecimenDefinition.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
SpecimenDefinition.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
SpecimenDefinition.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
SpecimenDefinition.language0..1codeThe base language in which the resource is written.
SpecimenDefinition.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
SpecimenDefinition.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
SpecimenDefinition.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SpecimenDefinition.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SpecimenDefinition.identifier0..1IdentifierA business identifier associated with the kind of specimen.
SpecimenDefinition.typeCollected0..1CodeableConceptThe kind of material to be collected.
SpecimenDefinition.patientPreparation0..*CodeableConceptPreparation of the patient for specimen collection.
SpecimenDefinition.timeAspect0..1stringTime aspect of specimen collection (duration or offset).
SpecimenDefinition.collection0..*CodeableConceptThe action to be performed for collecting the specimen.
SpecimenDefinition.typeTested0..*BackboneElementSpecimen conditioned in a container as expected by the testing laboratory.
SpecimenDefinition.typeTested.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SpecimenDefinition.typeTested.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SpecimenDefinition.typeTested.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SpecimenDefinition.typeTested.isDerived0..1booleanPrimary of secondary specimen.
SpecimenDefinition.typeTested.type0..1CodeableConceptThe kind of specimen conditioned for testing expected by lab.
SpecimenDefinition.typeTested.preference1..1codeThe preference for this type of conditioned specimen.
SpecimenDefinition.typeTested.container0..1BackboneElementThe specimen's container.
SpecimenDefinition.typeTested.container.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SpecimenDefinition.typeTested.container.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SpecimenDefinition.typeTested.container.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SpecimenDefinition.typeTested.container.material0..1CodeableConceptThe type of material of the container.
SpecimenDefinition.typeTested.container.type0..1CodeableConceptThe type of container used to contain this kind of specimen.
SpecimenDefinition.typeTested.container.cap0..1CodeableConceptColor of container cap.
SpecimenDefinition.typeTested.container.description0..1stringThe textual description of the kind of container.
SpecimenDefinition.typeTested.container.capacity0..1QuantityThe capacity (volume or other measure) of this kind of container.
SpecimenDefinition.typeTested.container.minimumVolume[x]0..1QuantityThe minimum volume to be conditioned in the container.
SpecimenDefinition.typeTested.container.additive0..*BackboneElementSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
SpecimenDefinition.typeTested.container.additive.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SpecimenDefinition.typeTested.container.additive.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SpecimenDefinition.typeTested.container.additive.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SpecimenDefinition.typeTested.container.additive.additive[x]1..1CodeableConceptSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
SpecimenDefinition.typeTested.container.preparation0..1stringSpecial processing that should be applied to the container for this kind of specimen.
SpecimenDefinition.typeTested.requirement0..1stringRequirements for delivery and special handling of this kind of conditioned specimen.
SpecimenDefinition.typeTested.retentionTime0..1DurationThe usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.
SpecimenDefinition.typeTested.rejectionCriterion0..*CodeableConceptCriterion for rejection of the specimen in its container by the laboratory.
SpecimenDefinition.typeTested.handling0..*BackboneElementSet of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.
SpecimenDefinition.typeTested.handling.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
SpecimenDefinition.typeTested.handling.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
SpecimenDefinition.typeTested.handling.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
SpecimenDefinition.typeTested.handling.temperatureQualifier0..1CodeableConceptIt 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.
SpecimenDefinition.typeTested.handling.temperatureRange0..1RangeThe temperature interval for this set of handling instructions.
SpecimenDefinition.typeTested.handling.maxDuration0..1DurationThe maximum time interval of preservation of the specimen with these conditions.
SpecimenDefinition.typeTested.handling.instruction0..1stringAdditional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
containertokenThe type of specimen conditioned in container expected by the labSpecimenDefinition.typeTested.container.type
identifiertokenThe unique identifier associated with the specimenSpecimenDefinition.identifier
typetokenThe type of collected specimenSpecimenDefinition.typeCollected