UKCore-Specimen
Summary
Details of the specimen(s) provided for testing.
Resource and Profile Links
- R4 Resource (Base): Specimen
- R4 UK Core Profile: UKCore-Specimen
Profile Views
Refer to Profile Descriptions for a definition of the different profile view formats.
UKCoreSpecimen (Specimen) | C | Specimen | There are no (further) constraints on this element Element idSpecimenShort description Sample for analysis DefinitionA sample to be used for analysis.
| |||
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSpecimen.metaShort description Metadata about the resource DefinitionThe 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.
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSpecimen.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
| ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idSpecimen.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||
text | 0..1 | Narrative | There are no (further) constraints on this element Element idSpecimen.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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 information is added later.
| |||
contained | 0..* | Resource | There are no (further) constraints on this element Element idSpecimen.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
extension | C | 0..* | Extension | Element idSpecimen.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
sampleCategory | C | 0..1 | Extension(CodeableConcept) | Element idSpecimen.extension:sampleCategoryShort description An extension to record the category of a sample. Alternate namesextensions, user content DefinitionThis extension allows the recording of the category of a sample for use within Genomics, whether it is a tumour or germline sample. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.identifierShort description External Identifier DefinitionId for specimen.
| ||
accessionIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idSpecimen.accessionIdentifierShort description Identifier assigned by the lab DefinitionThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
| ||
status | S Σ ?! | 0..1 | codeBinding | Element idSpecimen.statusShort description The availability of the specimen sample. DefinitionThe availability of the specimen. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status/availability of a specimen.
| ||
type | S Σ | 0..1 | CodeableConceptBinding | Element idSpecimen.typeShort description The kind of material that forms the specimen. DefinitionThe kind of material that forms the specimen. 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. A code from the SNOMED CT UK Clinical Terminology coding system UKCoreSpecimenType (preferred) Constraints
| ||
subject | S Σ | 0..1 | Reference(Patient | Group | Device | Substance | Location) | Element idSpecimen.subjectShort description Where the specimen came from. DefinitionWhere 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. Must know the subject context. Reference(Patient | Group | Device | Substance | Location) Constraints
| ||
receivedTime | S Σ | 0..1 | dateTime | Element idSpecimen.receivedTimeShort description The time when specimen was received for processing. DefinitionTime when specimen was received for processing or testing.
| ||
parent | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idSpecimen.parentShort description Specimen from which this specimen originated DefinitionReference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. 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.
| |||
request | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idSpecimen.requestShort description Why the specimen was collected DefinitionDetails concerning a service request that required a specimen to be collected. The request may be explicit or implied such with a ServiceRequest that requires a blood draw.
| |||
collection | C | 0..1 | BackboneElement | Element idSpecimen.collectionShort description Collection details DefinitionDetails concerning the specimen collection.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | Element idSpecimen.collection.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
specialHandling | C | 0..* | Extension(CodeableConcept) | Element idSpecimen.collection.extension:specialHandlingShort description This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. Alternate namesextensions, user content DefinitionSpecial handling during the collection, transport, or storage of the specimen. 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. http://hl7.org/fhir/StructureDefinition/specimen-specialHandling ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
collectorR5 | C | 0..1 | Extension(Reference(Patient | RelatedPerson)) | Element idSpecimen.collection.extension:collectorR5Short description Person who collected the specimen. Alternate namesextensions, user content DefinitionPerson who collected the specimen. If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1 Extension(Reference(Patient | RelatedPerson)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idSpecimen.collection.collectorShort description Who collected the specimen DefinitionPerson who collected the specimen. Reference(Practitioner | PractitionerRole) Constraints
| ||
collected[x] | Σ | 0..1 | There are no (further) constraints on this element Element idSpecimen.collection.collected[x]Short description Collection time DefinitionTime when specimen was collected from subject - the physiologically relevant time.
| |||
collectedDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
collectedPeriod | Period | There are no (further) constraints on this element Data type | ||||
duration | Σ | 0..1 | Duration | There are no (further) constraints on this element Element idSpecimen.collection.durationShort description How long it took to collect specimen DefinitionThe span of time over which the collection of a specimen occurred.
| ||
quantity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.collection.quantityShort description The quantity of specimen collected DefinitionThe quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
| |||
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.collection.methodShort description Technique used to perform collection DefinitionA coded value specifying the technique that is used to perform the procedure. The technique that is used to perform the procedure. FHIRSpecimenCollectionMethod (example) Constraints
| |||
bodySite | 0..1 | CodeableConceptBinding | Element idSpecimen.collection.bodySiteShort description Anatomical collection site DefinitionAnatomical 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. 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 bodySite. Codes describing anatomical locations. May include laterality. UKCoreSpecimenBodySite (preferred) Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
bodySiteReference | C | 0..1 | Extension(Reference(BodyStructure)) | Element idSpecimen.collection.bodySite.extension:bodySiteReferenceShort description An extension to allow referencing to a BodyStructure. Alternate namesextensions, user content DefinitionAn extension to replicate the changes within R5 altering the data type of Specimen.collection.bodySite from CodeableConcept to CodeableReference (bodyStructure). 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. Extension(Reference(BodyStructure)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReferenceMappings
| |||
value[x] | 1..1 | Element idSpecimen.collection.bodySite.extension:bodySiteReference.value[x]Short description A reference to a BodyStructure DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||||
valueReference | Reference(BodyStructure) | There are no (further) constraints on this element Data type | ||||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
fastingStatus[x] | Σ | 0..1 | Binding | There are no (further) constraints on this element Element idSpecimen.collection.fastingStatus[x]Short description Whether or how long patient abstained from food and/or drink DefinitionAbstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. Many diagnostic tests require fasting to facilitate accurate interpretation. Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation Codes describing the fasting status of the patient.
| ||
fastingStatusCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
fastingStatusDuration | Duration | There are no (further) constraints on this element Data type | ||||
processing | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.processingShort description Processing and processing step details DefinitionDetails concerning processing and processing steps for the specimen.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.descriptionShort description Textual description of procedure DefinitionTextual description of procedure.
| |||
procedure | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.processing.procedureShort description Indicates the treatment step applied to the specimen DefinitionA coded value specifying the procedure used to process the specimen. Type indicating the technique used to process the specimen. SpecimenProcessingProcedure (example) Constraints
| |||
additive | 0..* | Reference(Substance) | There are no (further) constraints on this element Element idSpecimen.processing.additiveShort description Material used in the processing step DefinitionMaterial used in the processing step.
| |||
time[x] | 0..1 | There are no (further) constraints on this element Element idSpecimen.processing.time[x]Short description Date and time of specimen processing DefinitionA 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.
| ||||
timeDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
timePeriod | Period | There are no (further) constraints on this element Data type | ||||
container | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.containerShort description Direct container of specimen (tube/slide, etc.) DefinitionThe container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | Element idSpecimen.container.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
deviceR5 | C | 0..1 | Extension(Reference(Device)) | Element idSpecimen.container.extension:deviceR5Short description Device resource for the container. Alternate namesextensions, user content DefinitionThe device resource for the the container holding the specimen. If the container is in a holder then the referenced device will point to a parent device. 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. http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
locationR5 | C | 0..1 | Extension(Reference(UKCoreLocation)) | Element idSpecimen.container.extension:locationR5Short description Where the container is. Alternate namesextensions, user content DefinitionThe location of the container holding the specimen. 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. Extension(Reference(UKCoreLocation)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.container.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.container.identifierShort description Id for the container DefinitionId 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.
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.descriptionShort description Textual description of the container DefinitionTextual description of the container.
| |||
type | 0..1 | CodeableConceptBinding | Element idSpecimen.container.typeShort description Kind of container directly associated with specimen DefinitionThe type of container associated with the specimen (e.g. slide, aliquot, etc.). Type of specimen container. SpecimenContainerType (preferred) Constraints
| |||
capacity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.capacityShort description Container volume or size DefinitionThe capacity (volume or other measure) the container may contain.
| |||
specimenQuantity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.specimenQuantityShort description Quantity of specimen within container DefinitionThe quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
| |||
additive[x] | 0..1 | There are no (further) constraints on this element Element idSpecimen.container.additive[x]Short description Additive associated with container DefinitionIntroduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Substance added to specimen container.
| ||||
additiveCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
additiveReference | Reference(Substance) | There are no (further) constraints on this element Data type | ||||
condition | Σ | 0..* | CodeableConceptBinding | Element idSpecimen.conditionShort description State of the specimen DefinitionA mode or state of being that describes the nature of the specimen. The specimen condition can be used to assess its quality or appropriateness for a specific test. Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test. Codes describing the state of the specimen. UKCoreSampleState (extensible) Constraints
| ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idSpecimen.noteShort description Comments DefinitionTo communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
|
UKCoreSpecimen (Specimen) | C | Specimen | There are no (further) constraints on this element Element idSpecimenShort description Sample for analysis DefinitionA sample to be used for analysis.
| |||
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSpecimen.metaShort description Metadata about the resource DefinitionThe 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.
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSpecimen.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
| ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idSpecimen.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||
text | 0..1 | Narrative | There are no (further) constraints on this element Element idSpecimen.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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 information is added later.
| |||
contained | 0..* | Resource | There are no (further) constraints on this element Element idSpecimen.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
extension | C | 0..* | Extension | Element idSpecimen.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
sampleCategory | C | 0..1 | Extension(CodeableConcept) | Element idSpecimen.extension:sampleCategoryShort description An extension to record the category of a sample. Alternate namesextensions, user content DefinitionThis extension allows the recording of the category of a sample for use within Genomics, whether it is a tumour or germline sample. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.identifierShort description External Identifier DefinitionId for specimen.
| ||
accessionIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idSpecimen.accessionIdentifierShort description Identifier assigned by the lab DefinitionThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
| ||
status | S Σ ?! | 0..1 | codeBinding | Element idSpecimen.statusShort description The availability of the specimen sample. DefinitionThe availability of the specimen. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status/availability of a specimen.
| ||
type | S Σ | 0..1 | CodeableConceptBinding | Element idSpecimen.typeShort description The kind of material that forms the specimen. DefinitionThe kind of material that forms the specimen. 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. A code from the SNOMED CT UK Clinical Terminology coding system UKCoreSpecimenType (preferred) Constraints
| ||
subject | S Σ | 0..1 | Reference(Patient | Group | Device | Substance | Location) | Element idSpecimen.subjectShort description Where the specimen came from. DefinitionWhere 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. Must know the subject context. Reference(Patient | Group | Device | Substance | Location) Constraints
| ||
receivedTime | S Σ | 0..1 | dateTime | Element idSpecimen.receivedTimeShort description The time when specimen was received for processing. DefinitionTime when specimen was received for processing or testing.
| ||
parent | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idSpecimen.parentShort description Specimen from which this specimen originated DefinitionReference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. 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.
| |||
request | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idSpecimen.requestShort description Why the specimen was collected DefinitionDetails concerning a service request that required a specimen to be collected. The request may be explicit or implied such with a ServiceRequest that requires a blood draw.
| |||
collection | C | 0..1 | BackboneElement | Element idSpecimen.collectionShort description Collection details DefinitionDetails concerning the specimen collection.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | Element idSpecimen.collection.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
specialHandling | C | 0..* | Extension(CodeableConcept) | Element idSpecimen.collection.extension:specialHandlingShort description This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. Alternate namesextensions, user content DefinitionSpecial handling during the collection, transport, or storage of the specimen. 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. http://hl7.org/fhir/StructureDefinition/specimen-specialHandling ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
collectorR5 | C | 0..1 | Extension(Reference(Patient | RelatedPerson)) | Element idSpecimen.collection.extension:collectorR5Short description Person who collected the specimen. Alternate namesextensions, user content DefinitionPerson who collected the specimen. If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1 Extension(Reference(Patient | RelatedPerson)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idSpecimen.collection.collectorShort description Who collected the specimen DefinitionPerson who collected the specimen. Reference(Practitioner | PractitionerRole) Constraints
| ||
collected[x] | Σ | 0..1 | There are no (further) constraints on this element Element idSpecimen.collection.collected[x]Short description Collection time DefinitionTime when specimen was collected from subject - the physiologically relevant time.
| |||
collectedDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
collectedPeriod | Period | There are no (further) constraints on this element Data type | ||||
duration | Σ | 0..1 | Duration | There are no (further) constraints on this element Element idSpecimen.collection.durationShort description How long it took to collect specimen DefinitionThe span of time over which the collection of a specimen occurred.
| ||
quantity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.collection.quantityShort description The quantity of specimen collected DefinitionThe quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
| |||
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.collection.methodShort description Technique used to perform collection DefinitionA coded value specifying the technique that is used to perform the procedure. The technique that is used to perform the procedure. FHIRSpecimenCollectionMethod (example) Constraints
| |||
bodySite | 0..1 | CodeableConceptBinding | Element idSpecimen.collection.bodySiteShort description Anatomical collection site DefinitionAnatomical 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. 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 bodySite. Codes describing anatomical locations. May include laterality. UKCoreSpecimenBodySite (preferred) Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
bodySiteReference | C | 0..1 | Extension(Reference(BodyStructure)) | Element idSpecimen.collection.bodySite.extension:bodySiteReferenceShort description An extension to allow referencing to a BodyStructure. Alternate namesextensions, user content DefinitionAn extension to replicate the changes within R5 altering the data type of Specimen.collection.bodySite from CodeableConcept to CodeableReference (bodyStructure). 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. Extension(Reference(BodyStructure)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReferenceMappings
| |||
value[x] | 1..1 | Element idSpecimen.collection.bodySite.extension:bodySiteReference.value[x]Short description A reference to a BodyStructure DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||||
valueReference | Reference(BodyStructure) | There are no (further) constraints on this element Data type | ||||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
fastingStatus[x] | Σ | 0..1 | Binding | There are no (further) constraints on this element Element idSpecimen.collection.fastingStatus[x]Short description Whether or how long patient abstained from food and/or drink DefinitionAbstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. Many diagnostic tests require fasting to facilitate accurate interpretation. Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation Codes describing the fasting status of the patient.
| ||
fastingStatusCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
fastingStatusDuration | Duration | There are no (further) constraints on this element Data type | ||||
processing | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.processingShort description Processing and processing step details DefinitionDetails concerning processing and processing steps for the specimen.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.descriptionShort description Textual description of procedure DefinitionTextual description of procedure.
| |||
procedure | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.processing.procedureShort description Indicates the treatment step applied to the specimen DefinitionA coded value specifying the procedure used to process the specimen. Type indicating the technique used to process the specimen. SpecimenProcessingProcedure (example) Constraints
| |||
additive | 0..* | Reference(Substance) | There are no (further) constraints on this element Element idSpecimen.processing.additiveShort description Material used in the processing step DefinitionMaterial used in the processing step.
| |||
time[x] | 0..1 | There are no (further) constraints on this element Element idSpecimen.processing.time[x]Short description Date and time of specimen processing DefinitionA 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.
| ||||
timeDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
timePeriod | Period | There are no (further) constraints on this element Data type | ||||
container | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.containerShort description Direct container of specimen (tube/slide, etc.) DefinitionThe container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | Element idSpecimen.container.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
deviceR5 | C | 0..1 | Extension(Reference(Device)) | Element idSpecimen.container.extension:deviceR5Short description Device resource for the container. Alternate namesextensions, user content DefinitionThe device resource for the the container holding the specimen. If the container is in a holder then the referenced device will point to a parent device. 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. http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
locationR5 | C | 0..1 | Extension(Reference(UKCoreLocation)) | Element idSpecimen.container.extension:locationR5Short description Where the container is. Alternate namesextensions, user content DefinitionThe location of the container holding the specimen. 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. Extension(Reference(UKCoreLocation)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.container.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.container.identifierShort description Id for the container DefinitionId 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.
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.descriptionShort description Textual description of the container DefinitionTextual description of the container.
| |||
type | 0..1 | CodeableConceptBinding | Element idSpecimen.container.typeShort description Kind of container directly associated with specimen DefinitionThe type of container associated with the specimen (e.g. slide, aliquot, etc.). Type of specimen container. SpecimenContainerType (preferred) Constraints
| |||
capacity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.capacityShort description Container volume or size DefinitionThe capacity (volume or other measure) the container may contain.
| |||
specimenQuantity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.specimenQuantityShort description Quantity of specimen within container DefinitionThe quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
| |||
additive[x] | 0..1 | There are no (further) constraints on this element Element idSpecimen.container.additive[x]Short description Additive associated with container DefinitionIntroduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Substance added to specimen container.
| ||||
additiveCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
additiveReference | Reference(Substance) | There are no (further) constraints on this element Data type | ||||
condition | Σ | 0..* | CodeableConceptBinding | Element idSpecimen.conditionShort description State of the specimen DefinitionA mode or state of being that describes the nature of the specimen. The specimen condition can be used to assess its quality or appropriateness for a specific test. Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test. Codes describing the state of the specimen. UKCoreSampleState (extensible) Constraints
| ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idSpecimen.noteShort description Comments DefinitionTo communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
|
UKCoreSpecimen (Specimen) | C | Specimen | There are no (further) constraints on this element Element idSpecimenShort description Sample for analysis DefinitionA sample to be used for analysis.
| |||
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSpecimen.metaShort description Metadata about the resource DefinitionThe 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.
| ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSpecimen.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
| ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idSpecimen.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||
text | 0..1 | Narrative | There are no (further) constraints on this element Element idSpecimen.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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 information is added later.
| |||
contained | 0..* | Resource | There are no (further) constraints on this element Element idSpecimen.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
extension | C | 0..* | Extension | Element idSpecimen.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
sampleCategory | C | 0..1 | Extension(CodeableConcept) | Element idSpecimen.extension:sampleCategoryShort description An extension to record the category of a sample. Alternate namesextensions, user content DefinitionThis extension allows the recording of the category of a sample for use within Genomics, whether it is a tumour or germline sample. 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. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.identifierShort description External Identifier DefinitionId for specimen.
| ||
accessionIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idSpecimen.accessionIdentifierShort description Identifier assigned by the lab DefinitionThe identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
| ||
status | S Σ ?! | 0..1 | codeBinding | Element idSpecimen.statusShort description The availability of the specimen sample. DefinitionThe availability of the specimen. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Codes providing the status/availability of a specimen.
| ||
type | S Σ | 0..1 | CodeableConceptBinding | Element idSpecimen.typeShort description The kind of material that forms the specimen. DefinitionThe kind of material that forms the specimen. 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. A code from the SNOMED CT UK Clinical Terminology coding system UKCoreSpecimenType (preferred) Constraints
| ||
subject | S Σ | 0..1 | Reference(Patient | Group | Device | Substance | Location) | Element idSpecimen.subjectShort description Where the specimen came from. DefinitionWhere 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. Must know the subject context. Reference(Patient | Group | Device | Substance | Location) Constraints
| ||
receivedTime | S Σ | 0..1 | dateTime | Element idSpecimen.receivedTimeShort description The time when specimen was received for processing. DefinitionTime when specimen was received for processing or testing.
| ||
parent | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idSpecimen.parentShort description Specimen from which this specimen originated DefinitionReference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. 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.
| |||
request | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idSpecimen.requestShort description Why the specimen was collected DefinitionDetails concerning a service request that required a specimen to be collected. The request may be explicit or implied such with a ServiceRequest that requires a blood draw.
| |||
collection | C | 0..1 | BackboneElement | Element idSpecimen.collectionShort description Collection details DefinitionDetails concerning the specimen collection.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | Element idSpecimen.collection.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
specialHandling | C | 0..* | Extension(CodeableConcept) | Element idSpecimen.collection.extension:specialHandlingShort description This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. Alternate namesextensions, user content DefinitionSpecial handling during the collection, transport, or storage of the specimen. 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. http://hl7.org/fhir/StructureDefinition/specimen-specialHandling ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
collectorR5 | C | 0..1 | Extension(Reference(Patient | RelatedPerson)) | Element idSpecimen.collection.extension:collectorR5Short description Person who collected the specimen. Alternate namesextensions, user content DefinitionPerson who collected the specimen. If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1 Extension(Reference(Patient | RelatedPerson)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idSpecimen.collection.collectorShort description Who collected the specimen DefinitionPerson who collected the specimen. Reference(Practitioner | PractitionerRole) Constraints
| ||
collected[x] | Σ | 0..1 | There are no (further) constraints on this element Element idSpecimen.collection.collected[x]Short description Collection time DefinitionTime when specimen was collected from subject - the physiologically relevant time.
| |||
collectedDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
collectedPeriod | Period | There are no (further) constraints on this element Data type | ||||
duration | Σ | 0..1 | Duration | There are no (further) constraints on this element Element idSpecimen.collection.durationShort description How long it took to collect specimen DefinitionThe span of time over which the collection of a specimen occurred.
| ||
quantity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.collection.quantityShort description The quantity of specimen collected DefinitionThe quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
| |||
method | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.collection.methodShort description Technique used to perform collection DefinitionA coded value specifying the technique that is used to perform the procedure. The technique that is used to perform the procedure. FHIRSpecimenCollectionMethod (example) Constraints
| |||
bodySite | 0..1 | CodeableConceptBinding | Element idSpecimen.collection.bodySiteShort description Anatomical collection site DefinitionAnatomical 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. 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 bodySite. Codes describing anatomical locations. May include laterality. UKCoreSpecimenBodySite (preferred) Constraints
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
bodySiteReference | C | 0..1 | Extension(Reference(BodyStructure)) | Element idSpecimen.collection.bodySite.extension:bodySiteReferenceShort description An extension to allow referencing to a BodyStructure. Alternate namesextensions, user content DefinitionAn extension to replicate the changes within R5 altering the data type of Specimen.collection.bodySite from CodeableConcept to CodeableReference (bodyStructure). 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. Extension(Reference(BodyStructure)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReferenceMappings
| |||
value[x] | 1..1 | Element idSpecimen.collection.bodySite.extension:bodySiteReference.value[x]Short description A reference to a BodyStructure DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||||
valueReference | Reference(BodyStructure) | There are no (further) constraints on this element Data type | ||||
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
| ||
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
| ||
fastingStatus[x] | Σ | 0..1 | Binding | There are no (further) constraints on this element Element idSpecimen.collection.fastingStatus[x]Short description Whether or how long patient abstained from food and/or drink DefinitionAbstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. Many diagnostic tests require fasting to facilitate accurate interpretation. Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation Codes describing the fasting status of the patient.
| ||
fastingStatusCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
fastingStatusDuration | Duration | There are no (further) constraints on this element Data type | ||||
processing | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.processingShort description Processing and processing step details DefinitionDetails concerning processing and processing steps for the specimen.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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.
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.descriptionShort description Textual description of procedure DefinitionTextual description of procedure.
| |||
procedure | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.processing.procedureShort description Indicates the treatment step applied to the specimen DefinitionA coded value specifying the procedure used to process the specimen. Type indicating the technique used to process the specimen. SpecimenProcessingProcedure (example) Constraints
| |||
additive | 0..* | Reference(Substance) | There are no (further) constraints on this element Element idSpecimen.processing.additiveShort description Material used in the processing step DefinitionMaterial used in the processing step.
| |||
time[x] | 0..1 | There are no (further) constraints on this element Element idSpecimen.processing.time[x]Short description Date and time of specimen processing DefinitionA 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.
| ||||
timeDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
timePeriod | Period | There are no (further) constraints on this element Data type | ||||
container | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.containerShort description Direct container of specimen (tube/slide, etc.) DefinitionThe container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
| |||
id | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
extension | C | 0..* | Extension | Element idSpecimen.container.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
| ||
deviceR5 | C | 0..1 | Extension(Reference(Device)) | Element idSpecimen.container.extension:deviceR5Short description Device resource for the container. Alternate namesextensions, user content DefinitionThe device resource for the the container holding the specimen. If the container is in a holder then the referenced device will point to a parent device. 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. http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
locationR5 | C | 0..1 | Extension(Reference(UKCoreLocation)) | Element idSpecimen.container.extension:locationR5Short description Where the container is. Alternate namesextensions, user content DefinitionThe location of the container holding the specimen. 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. Extension(Reference(UKCoreLocation)) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.container.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
| ||
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.container.identifierShort description Id for the container DefinitionId 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.
| ||
description | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.descriptionShort description Textual description of the container DefinitionTextual description of the container.
| |||
type | 0..1 | CodeableConceptBinding | Element idSpecimen.container.typeShort description Kind of container directly associated with specimen DefinitionThe type of container associated with the specimen (e.g. slide, aliquot, etc.). Type of specimen container. SpecimenContainerType (preferred) Constraints
| |||
capacity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.capacityShort description Container volume or size DefinitionThe capacity (volume or other measure) the container may contain.
| |||
specimenQuantity | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.specimenQuantityShort description Quantity of specimen within container DefinitionThe quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
| |||
additive[x] | 0..1 | There are no (further) constraints on this element Element idSpecimen.container.additive[x]Short description Additive associated with container DefinitionIntroduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. Substance added to specimen container.
| ||||
additiveCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
additiveReference | Reference(Substance) | There are no (further) constraints on this element Data type | ||||
condition | Σ | 0..* | CodeableConceptBinding | Element idSpecimen.conditionShort description State of the specimen DefinitionA mode or state of being that describes the nature of the specimen. The specimen condition can be used to assess its quality or appropriateness for a specific test. Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test. Codes describing the state of the specimen. UKCoreSampleState (extensible) Constraints
| ||
note | 0..* | Annotation | There are no (further) constraints on this element Element idSpecimen.noteShort description Comments DefinitionTo communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
|
HbA1c Request
HbA1c Report
Hepatitis B Surface Antigen Report
HPV Primary Screening Report
Full Blood Count Report
Lipids Profile and HbA1c Report
Liver Function and U&Es Report
Glucose Tolerance Test Report Unstructured
Glucose Tolerance Test Report Structured
Urine MC&S Report Unstructured
Urine MC&S Report Structured
UKCore-Specimen Snippets
Specimen Snippets
UK Core Examples
UKCore-Specimen-BloodSpecimen-Example
UKCore-Specimen-UrineSpecimen-Example
UKCore-Extension-BodySiteReference-Example
UKCore-Extension-SpecialHandling-Example
Additional Guidance
The following additional guidance SHOULD be applied when implementing this profile. It SHOULD be used in conjunction with the profile definition presented above and the Profile Specific Implementation Guidance for UKCore-Specimen
in the UK Core Implementation Guide (STU3 Sequence).
status
This SHALL be populated as follows:
available
: when the specimen is present and in a usable conditionunavailable
: when the specimen is not available, for example it has been lostunsatisfactory
: when the specimen cannot be used, for example because of a broken container or contamination
type
Specimen type is currently represented as text in PMIP EDIFACT (NHS003). To facilitate the initial adoption of FHIR and minimise the impact on existing systems and processes, Specimen.type
SHALL continue to be represented as text (using the text
element of CodeableConcept
), rather than using SNOMED CT coded concepts.
For further information relating to the use of the text
element of CodeableConcept
, refer to the base FHIR R4 Specification.
request
Reference to the ServiceRequest
that the specimen relates to. This should only be used when a test was requested before the specimen was collected.
It is also possible to link a ServiceRequest
to a Specimen
using the ServiceRequest.specimen
data element. This should be used when a test is requested and the specimen has already been collected.
For further information refer to:
- the description of the UKCore-ServiceRequest-Lab profile in this implementation guide, and
- the notes relating to the use of the
ServiceRequest
resource in the base FHIR R4 Specification.