This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions
Definitions for cimi-entity-Specimen.
Specimen | |
Definition | A specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
Specimen.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Specimen.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Specimen.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Specimen.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Specimen.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
Specimen.contained | |
Definition | These 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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
Specimen.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-CollectionTime-extension]]) | |
Definition | When the sample was obtained, as a specific time or time period. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: dateTime, Period) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Specimen.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecimenTreatment-extension]]) | |
Definition | Treatment performed on the specimen. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Reference(SpecimenTreatmentProfile)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Specimen.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-HandlingRisk-extension]]) | |
Definition | Cautions on the handling of this specimen. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Specimen.extension ([CanonicalType[http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-SpecialHandling-extension]]) | |
Definition | Information about the proper handling of the specimen. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Specimen.modifierExtension | |
Definition | May 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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.identifier | |
Definition | Id for specimen. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Specimen.accessionIdentifier | |
Definition | The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
Control | 0..1 |
Type | Identifier(AccessionIdentifierProfile) |
Specimen.status | |
Definition | The availability of the specimen. |
Control | 0..1 |
Binding | Codes providing the status/availability of a specimen. The codes SHALL be taken from SpecimenStatus |
Type | code |
Is Modifier | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Specimen.type | |
Definition | The kind of material that forms the specimen. |
Control | 1..1 |
Binding | The type of the specimen. The codes SHALL be taken from v2 Specimen Type |
Type | CodeableConcept |
Comments | The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems. |
Specimen.subject | |
Definition | Where the specimen came from. This may be from the patient(s) or from the environment or a device. |
Control | 1..1 |
Type | Reference(US Core Patient Profile | GroupProfile | US Core Device Profile | SubstanceProfile) |
Requirements | Must know the subject context. |
Specimen.receivedTime | |
Definition | Time when specimen was received for processing or testing. |
Control | 0..1 |
Type | dateTime |
Specimen.parent | |
Definition | Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
Control | 0..1 |
Type | Reference(SpecimenProfile) |
Comments | The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample. |
Specimen.request | |
Definition | Details concerning a test or procedure request that required a specimen to be collected. |
Control | 0..* |
Type | Reference(ProcedureRequest) |
Comments | The request may be explicit or implied such with a ProcedureRequest that requires a blood draw. |
Specimen.collection | |
Definition | Details concerning the specimen collection. |
Control | 0..1 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Specimen.collection.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Specimen.collection.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.collection.modifierExtension | |
Definition | May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.collection.collector | |
Definition | Person who collected the specimen. |
Control | 0..1 |
Type | Reference(Practitioner) |
Specimen.collection.collected[x] | |
Definition | Time when specimen was collected from subject - the physiologically relevant time. |
Control | 0..1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Specimen.collection.quantity | |
Definition | The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Specimen.collection.method | |
Definition | A coded value specifying the technique that is used to perform the procedure. |
Control | 0..1 |
Binding | The technique that is used to perform the procedure For example codes, see FHIR Specimen Collection Method |
Type | CodeableConcept |
Specimen.collection.bodySite | |
Definition | Anatomical 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from AnatomicalLocationVS |
Type | CodeableConcept |
Comments | If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension body-site-instance. |
Specimen.processing | |
Definition | Details concerning processing and processing steps for the specimen. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Specimen.processing.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Specimen.processing.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.processing.modifierExtension | |
Definition | May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.processing.description | |
Definition | Textual description of procedure. |
Control | 0..1 |
Type | string |
Specimen.processing.procedure | |
Definition | A coded value specifying the procedure used to process the specimen. |
Control | 0..1 |
Binding | Type indicating the technique used to process the specimen For example codes, see SpecimenProcessingProcedure |
Type | CodeableConcept |
Specimen.processing.additive | |
Definition | Material used in the processing step. |
Control | 0..* |
Type | Reference(Substance) |
Specimen.processing.time[x] | |
Definition | A 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. |
Control | 0..1 |
Type | Choice of: dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Specimen.container | |
Definition | The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Specimen.container.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Specimen.container.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.container.modifierExtension | |
Definition | May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.container.identifier | |
Definition | Id 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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier(IdentifierProfile) |
Specimen.container.description | |
Definition | Textual description of the container. |
Control | 0..1 |
Type | string |
Specimen.container.type | |
Definition | The type of container associated with the specimen (e.g. slide, aliquot, etc.). |
Control | 0..1 |
Binding | Type of specimen container For example codes, see SpecimenContainer |
Type | CodeableConcept |
Specimen.container.capacity | |
Definition | The capacity (volume or other measure) the container may contain. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Specimen.container.specimenQuantity | |
Definition | The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Specimen.container.additive[x] | |
Definition | Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. |
Control | 0..1 |
Binding | Substance added to specimen container For example codes, see v2 Additive/Preservative |
Type | Choice of: CodeableConcept, Reference(SubstanceProfile) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Specimen.note | |
Definition | To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen). |
Control | 0..* |
Type | Annotation |