Skip to main content

Specimen

PropertyValue
Publisher
NameSpecimen
URLhttp://hl7.org/fhir/StructureDefinition/Specimen
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Specimen0..*SpecimenA sample to be used for analysis.
Specimen.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.
Specimen.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.
Specimen.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.
Specimen.language0..1codeThe base language in which the resource is written.
Specimen.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.
Specimen.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.
Specimen.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.
Specimen.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).
Specimen.identifier0..*IdentifierId for specimen.
Specimen.accessionIdentifier0..1IdentifierThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
Specimen.status0..1codeThe availability of the specimen.
Specimen.type0..1CodeableConceptThe kind of material that forms the specimen.
Specimen.subject0..1ReferenceWhere the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
Specimen.receivedTime0..1dateTimeTime when specimen was received for processing or testing.
Specimen.parent0..*ReferenceReference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
Specimen.request0..*ReferenceDetails concerning a service request that required a specimen to be collected.
Specimen.collection0..1BackboneElementDetails concerning the specimen collection.
Specimen.collection.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.
Specimen.collection.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.
Specimen.collection.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).
Specimen.collection.collector0..1ReferencePerson who collected the specimen.
Specimen.collection.collected[x]0..1dateTimeTime when specimen was collected from subject - the physiologically relevant time.
Specimen.collection.duration0..1DurationThe span of time over which the collection of a specimen occurred.
Specimen.collection.quantity0..1QuantityThe quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
Specimen.collection.method0..1CodeableConceptA coded value specifying the technique that is used to perform the procedure.
Specimen.collection.bodySite0..1CodeableConceptAnatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
Specimen.collection.fastingStatus[x]0..1CodeableConceptAbstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.
Specimen.processing0..*BackboneElementDetails concerning processing and processing steps for the specimen.
Specimen.processing.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.
Specimen.processing.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.
Specimen.processing.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).
Specimen.processing.description0..1stringTextual description of procedure.
Specimen.processing.procedure0..1CodeableConceptA coded value specifying the procedure used to process the specimen.
Specimen.processing.additive0..*ReferenceMaterial used in the processing step.
Specimen.processing.time[x]0..1dateTimeA record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
Specimen.container0..*BackboneElementThe container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
Specimen.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.
Specimen.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.
Specimen.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).
Specimen.container.identifier0..*IdentifierId for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.
Specimen.container.description0..1stringTextual description of the container.
Specimen.container.type0..1CodeableConceptThe type of container associated with the specimen (e.g. slide, aliquot, etc.).
Specimen.container.capacity0..1QuantityThe capacity (volume or other measure) the container may contain.
Specimen.container.specimenQuantity0..1QuantityThe quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
Specimen.container.additive[x]0..1CodeableConceptIntroduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
Specimen.condition0..*CodeableConceptA mode or state of being that describes the nature of the specimen.
Specimen.note0..*AnnotationTo communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

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
accessiontokenThe accession number associated with the specimenSpecimen.accessionIdentifier
bodysitetokenThe code for the body site from where the specimen originatedSpecimen.collection.bodySite
collecteddateThe date the specimen was collectedSpecimen.collection.collected
collectorreferenceWho collected the specimenSpecimen.collection.collector
containertokenThe kind of specimen containerSpecimen.container.type
container-idtokenThe unique identifier associated with the specimen containerSpecimen.container.identifier
identifiertokenThe unique identifier associated with the specimenSpecimen.identifier
parentreferenceThe parent of the specimenSpecimen.parent
patientreferenceThe patient the specimen comes fromSpecimen.subject.where(resolve() is Patient)
statustokenavailable / unavailable / unsatisfactory / entered-in-errorSpecimen.status
subjectreferenceThe subject of the specimenSpecimen.subject
typetokenThe specimen typeSpecimen.type