- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
Important
This CodeSystem has may be new or has been amended since the last ballot. Users are advised to review all content carefully. Details of the changes can be found within the UK Core Version History.StructureDefinition UKCore-Specimen
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Specimen | active | 3.1.0 | 2025-01-22 | This profile defines the UK constraints and extensions on the International FHIR resource Specimen. |
Profile_Purpose |
---|
This profile allows the exchange of information about a sample to be used for analysis. |
Detailed Descriptions
Specimen | |||
Short | Sample for analysis | ||
Definition | A sample to be used for analysis. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
Specimen.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
Specimen.meta | |||
Short | Metadata about the resource | ||
Definition | The 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. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
Constraints |
| ||
Specimen.implicitRules | |||
Short | A set of rules under which this content was created | ||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | True | ||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 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. | ||
Constraints |
| ||
Specimen.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language.
| ||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
Constraints |
| ||
Specimen.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A 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. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | narrative, html, xhtml, display | ||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.contained | |||
Short | Contained, inline Resources | ||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | inline resources, anonymous resources, contained resources | ||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||
Mappings |
| ||
Specimen.extension | |||
Short | Additional content defined by implementations | ||
Definition | May 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) | ||
Constraints |
| ||
Mappings |
| ||
Specimen.extension:sampleCategory | |||
Short | An extension to record the category of a sample. | ||
Definition | This extension allows the recording of the category of a sample for use within Genomics, whether it is a tumour or germline sample. | ||
Cardinality | 0..1 | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Specimen.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | extensions, user content | ||
Requirements | 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. | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.identifier | |||
Short | External Identifier | ||
Definition | Id for specimen. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Specimen.accessionIdentifier | |||
Short | Identifier assigned by the lab | ||
Definition | The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. | ||
Cardinality | 0..1 | ||
Type | Identifier | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Specimen.status | |||
Short | The availability of the specimen sample. | ||
Definition | The availability of the specimen. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Codes providing the status/availability of a specimen. | ||
Must Support | True | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.type | |||
Short | The kind of material that forms the specimen. | ||
Definition | The kind of material that forms the specimen. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A code from the SNOMED CT UK Clinical Terminology coding system | ||
Must Support | True | ||
Summary | True | ||
Comments | The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.subject | |||
Short | Where the specimen came from. | ||
Definition | Where 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. | ||
Cardinality | 0..1 | ||
Type | Reference(Patient | Group | Device | Substance | Location) | ||
Must Support | True | ||
Summary | True | ||
Requirements | Must know the subject context. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.receivedTime | |||
Short | The time when specimen was received for processing. | ||
Definition | Time when specimen was received for processing or testing. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Must Support | True | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Specimen.parent | |||
Short | Specimen from which this specimen originated | ||
Definition | Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. | ||
Cardinality | 0..* | ||
Type | Reference(Specimen) | ||
Comments | The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.request | |||
Short | Why the specimen was collected | ||
Definition | Details concerning a service request that required a specimen to be collected. | ||
Cardinality | 0..* | ||
Type | Reference(ServiceRequest) | ||
Comments | The request may be explicit or implied such with a ServiceRequest that requires a blood draw. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection | |||
Short | Collection details | ||
Definition | Details concerning the specimen collection. | ||
Cardinality | 0..1 | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Specimen.collection.extension | |||
Short | Additional content defined by implementations | ||
Definition | May 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.extension:specialHandling | |||
Short | This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. | ||
Definition | Special handling during the collection, transport, or storage of the specimen. | ||
Cardinality | 0..* | ||
Type | Extension(CodeableConcept) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.extension:collectorR5 | |||
Short | Person who collected the specimen. | ||
Definition | Person who collected the specimen. | ||
Cardinality | 0..1 | ||
Type | Extension(Reference(Patient | RelatedPerson)) | ||
Alias | extensions, user content | ||
Comments | If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1 | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, user content, modifiers | ||
Requirements | 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. | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.collector | |||
Short | Who collected the specimen | ||
Definition | Person who collected the specimen. | ||
Cardinality | 0..1 | ||
Type | Reference(Practitioner | PractitionerRole) | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.collected[x] | |||
Short | Collection time | ||
Definition | Time when specimen was collected from subject - the physiologically relevant time. | ||
Cardinality | 0..1 | ||
Type | dateTime, Period | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.duration | |||
Short | How long it took to collect specimen | ||
Definition | The span of time over which the collection of a specimen occurred. | ||
Cardinality | 0..1 | ||
Type | Duration | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.quantity | |||
Short | The quantity of specimen collected | ||
Definition | The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.method | |||
Short | Technique used to perform collection | ||
Definition | A coded value specifying the technique that is used to perform the procedure. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The technique that is used to perform the procedure. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.bodySite | |||
Short | Anatomical collection site | ||
Definition | Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | Codes describing anatomical locations. May include laterality. | ||
Comments | If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension bodySite. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.bodySite.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Specimen.collection.bodySite.extension | |||
Short | Additional content defined by implementations | ||
Definition | May 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.bodySite.extension:bodySiteReference | |||
Short | An extension to allow referencing to a BodyStructure. | ||
Definition | An extension to replicate the changes within R5 altering the data type of Specimen.collection.bodySite from CodeableConcept to CodeableReference (bodyStructure). | ||
Cardinality | 0..1 | ||
Type | Extension(Reference(BodyStructure)) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.bodySite.extension:bodySiteReference.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Specimen.collection.bodySite.extension:bodySiteReference.extension | |||
Short | Additional content defined by implementations | ||
Definition | May 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.bodySite.extension:bodySiteReference.url | |||
Short | identifies the meaning of the extension | ||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Comments | 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. | ||
Fixed Value | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference | ||
Mappings |
| ||
Specimen.collection.bodySite.extension:bodySiteReference.value[x] | |||
Short | A reference to a BodyStructure | ||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
Cardinality | 1..1 | ||
Type | Reference(BodyStructure) | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.bodySite.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
Comments | 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. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.bodySite.text | |||
Short | Plain text representation of the concept | ||
Definition | A 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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | 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. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.collection.fastingStatus[x] | |||
Short | Whether or how long patient abstained from food and/or drink | ||
Definition | Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept, Duration | ||
Binding | Codes describing the fasting status of the patient. | ||
Summary | True | ||
Requirements | Many diagnostic tests require fasting to facilitate accurate interpretation. | ||
Comments | 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 | ||
Constraints |
| ||
Mappings |
| ||
Specimen.processing | |||
Short | Processing and processing step details | ||
Definition | Details concerning processing and processing steps for the specimen. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Specimen.processing.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Specimen.processing.extension | |||
Short | Additional content defined by implementations | ||
Definition | May 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.processing.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, user content, modifiers | ||
Requirements | 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. | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.processing.description | |||
Short | Textual description of procedure | ||
Definition | Textual description of procedure. | ||
Cardinality | 0..1 | ||
Type | string | ||
Constraints |
| ||
Mappings |
| ||
Specimen.processing.procedure | |||
Short | Indicates the treatment step applied to the specimen | ||
Definition | A coded value specifying the procedure used to process the specimen. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | Type indicating the technique used to process the specimen. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.processing.additive | |||
Short | Material used in the processing step | ||
Definition | Material used in the processing step. | ||
Cardinality | 0..* | ||
Type | Reference(Substance) | ||
Constraints |
| ||
Mappings |
| ||
Specimen.processing.time[x] | |||
Short | Date and time of specimen processing | ||
Definition | A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin. | ||
Cardinality | 0..1 | ||
Type | dateTime, Period | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container | |||
Short | Direct container of specimen (tube/slide, etc.) | ||
Definition | The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.id | |||
Short | Unique id for inter-element referencing | ||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
Specimen.container.extension | |||
Short | Additional content defined by implementations | ||
Definition | May 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Slicing | Unordered, Open, by url(Value) | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.extension:deviceR5 | |||
Short | Device resource for the container. | ||
Definition | The 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. | ||
Cardinality | 0..1 | ||
Type | Extension(Reference(Device)) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.extension:locationR5 | |||
Short | Where the container is. | ||
Definition | The location of the container holding the specimen. | ||
Cardinality | 0..1 | ||
Type | Extension(Reference(UKCoreLocation)) | ||
Alias | extensions, user content | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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). | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, user content, modifiers | ||
Requirements | 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. | ||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.identifier | |||
Short | Id for the container | ||
Definition | Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.description | |||
Short | Textual description of the container | ||
Definition | Textual description of the container. | ||
Cardinality | 0..1 | ||
Type | string | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.type | |||
Short | Kind of container directly associated with specimen | ||
Definition | The type of container associated with the specimen (e.g. slide, aliquot, etc.). | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | Type of specimen container. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.capacity | |||
Short | Container volume or size | ||
Definition | The capacity (volume or other measure) the container may contain. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.specimenQuantity | |||
Short | Quantity of specimen within container | ||
Definition | The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. | ||
Cardinality | 0..1 | ||
Type | SimpleQuantity | ||
Constraints |
| ||
Mappings |
| ||
Specimen.container.additive[x] | |||
Short | Additive associated with container | ||
Definition | Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept, Reference(Substance) | ||
Binding | Substance added to specimen container. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.condition | |||
Short | State of the specimen | ||
Definition | A mode or state of being that describes the nature of the specimen. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Codes describing the state of the specimen. | ||
Summary | True | ||
Requirements | The specimen condition can be used to assess its quality or appropriateness for a specific test. | ||
Comments | 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. | ||
Constraints |
| ||
Mappings |
| ||
Specimen.note | |||
Short | Comments | ||
Definition | To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen). | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Constraints |
| ||
Mappings |
|
Table View
Specimen | .. | |
Specimen.extension:sampleCategory | Extension | ..1 |
Specimen.status | .. | |
Specimen.type | .. | |
Specimen.subject | .. | |
Specimen.receivedTime | .. | |
Specimen.collection | .. | |
Specimen.collection.extension:specialHandling | Extension | .. |
Specimen.collection.extension:CollectorR5 | Extension | ..1 |
Specimen.collection.bodySite | .. | |
Specimen.collection.bodySite.extension:bodySiteReference | Extension | ..1 |
Specimen.collection.bodySite.extension:bodySiteReference.value[x] | .. | |
Specimen.container | .. | |
Specimen.container.extension:deviceR5 | Extension | ..1 |
Specimen.container.extension:locationR5 | Extension | ..1 |
Specimen.container.type | .. | |
Specimen.condition | .. |
XML View
JSON View
Examples
id | div |
---|---|
UKCore-Specimen-BloodSpecimen-Example | An example to illustrate a blood specimen that was taken by a finger prick |
UKCore-Specimen-UrineSpecimen-Example | An example to illustrate a urine sample |
UK Core Extensions examples can be found on the relevant Extension page.
Feedback
Click here to:Example Usage Scenarios
The following are example usage scenarios for the UK Core Specimen profile:
- Query for specimen information
- Exchange specimen information used in Observations and DiagnosticReport
Profile Specific Implementation Guidance:
Mandatory and Must Support Data Elements
The following elements are identified as MustSupport, and it is expected that consumers and suppliers SHALL support these as per the MustSupport Guidance.
Element | Reason |
---|---|
Specimen.status | The availability of the specimen sample. |
Specimen.type | The kind of material that forms the specimen. |
Specimen.subject | Where the specimen came from. |
Specimen.receivedTime | The time when specimen was received for processing. |
Extensions
More information about the extensions can be found using the links below.
Extension | Context | Link | Comment |
---|---|---|---|
bodySiteReference | Specimen. collection.bodySite |
Extension-UKCore-BodySiteReference | An extension to replicate the changes within R5 allowing the data type of Specimen.collection.bodySite to act as a CodeableReference (BodyStructure). |
collectionCollector | Specimen. collection.collector |
Extension-UKCore-SpecimenCollectionCollector | An extension to replicate the changes within R5 allowing the data type of Specimen.collection.collector to reference Patient and RelatedPerson. For more details, see HL7-Backport-Elements. |
sampleCategory | Specimen | Extension-UKCore-SampleCategory | An extension to record the Category of a sample. |
specialHandling | Specimen.collection | HL7 core-defined Extension specimen-specialHandling | This SHOULD be included if there is a high contamination risk reason for a sample/biopsy. Note: There is no binding defined within this HL7 extension. |
Important
The ValueSet is changed from BiopsyState to SampleState for Specimen.condition
Bindings (differential)
More information about the bindings to UK Core ValueSets can be found below.
Context | Strength | Link |
---|---|---|
Specimen.type | preferred | https://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenType |
Specimen.collection.bodySite | preferred | https://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenBodySite |
Specimen.condition | extensible | https://fhir.hl7.org.uk/ValueSet/UKCore-SampleState |
Specimen.extension:sampleCategory | extensible | ValueSet-UKCore-SampleCategory |
Constraints (differential)
More information about the constraints on the profile can be found below.
Key | Severity | Expression | Human_Description |
---|---|---|---|
ukcore-spec-001 | error | collector.reference.empty() or collector.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector').empty() | Only one of Specimen.collection.collector or Specimen.collection.extension:collectorR5 can be populated at a time. |
type
If a SNOMED CT concept from the ValueSet-UKCore-SpecimenType is used, and the concept is a descendant of "105590001 | Substance", Specimen.collection.method
and Specimen.collection.bodySite
SHOULD be populated.
subject
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
collection
Specimen.collection.collector
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
Specimen.collection.bodySite
If Specimen.collection.bodySite.coding
and Extension-UKCore-BodySiteReference are both are present, they are expected to be consistent with each other - e.g. the concept is to a code for headache, and the resource reference describes a headache.
processing
It is expected that Specimen.processing
SHOULD be populated where the specimen is an extracted sample for testing, obtained from a raw sample.
note
The resource referenced in Specimen.note.authorReference
SHALL conform to one of the following: