UKCoreSpecimen (Specimen) | C | | Specimen | Element idSpecimen Short descriptionSample for analysis DefinitionA sample to be used for analysis.
Data typeSpecimen Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - ukcore-spec-001: There SHALL be only one reference between collection.collector and the extension collectionCollectorR5
collection.collector.reference.empty() or collection.collector.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector').empty() Mappings- rim: Entity. Role, or Act
- rim: Role[classCode=SPEC]
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idSpecimen.meta Short descriptionMetadata 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.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idSpecimen.implicitRules Short descriptionA 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.
CommentsAsserting 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.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idSpecimen.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idSpecimen.text Short descriptionText 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.
CommentsContained 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.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idSpecimen.contained Short descriptionContained, 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.
CommentsThis 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.
Data typeResource Mappings |
extension | C | 0..* | Extension | Element idSpecimen.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
sampleCategory | C | 0..1 | Extension(CodeableConcept) | Element idSpecimen.extension:sampleCategory Short descriptionAn extension to record the category of the 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.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.modifierExtension Short descriptionExtensions 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.identifier Short descriptionExternal Identifier DefinitionData typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.identifier
- v2: SPM-2
- rim: .id
|
accessionIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idSpecimen.accessionIdentifier Short descriptionIdentifier 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.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.identifier
- v2: SPM-30 (v2.7+)
- rim: .participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id
|
status | S Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idSpecimen.status Short descriptionavailable | unavailable | unsatisfactory | entered-in-error DefinitionThe availability of the specimen.
CommentsThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Data typecode BindingCodes providing the status/availability of a specimen.
SpecimenStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.status
- v2: SPM-20
- rim: status
|
type | S Σ | 0..1 | CodeableConceptBinding | Element idSpecimen.type Short descriptionKind of material that forms the specimen DefinitionThe kind of material that forms the specimen.
CommentsThe 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.
Data typeCodeableConcept BindingA code from the SNOMED CT UK Clinical Terminology coding system
UKCoreSpecimenType (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.what[x]
- v2: SPM-4 and possibly SPM-5
- rim: .code
|
subject | S Σ | 0..1 | Reference(Patient | Group | Device | Substance | Location) | There are no (further) constraints on this element Element idSpecimen.subject Short descriptionWhere 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 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.
RequirementsMust know the subject context.
Data typeReference(Patient | Group | Device | Substance | Location) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.subject[x]
- rim: .scoper or .scoper.playsRole
- w5: FiveWs.subject
|
receivedTime | S Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idSpecimen.receivedTime Short descriptionThe time when specimen was received for processing DefinitionTime when specimen was received for processing or testing.
Data typedateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.done[x]
- v2: SPM-18
- rim: .participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime
|
parent | | 0..* | Reference(Specimen) | There are no (further) constraints on this element Element idSpecimen.parent Short descriptionSpecimen 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.
CommentsThe 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.
Data typeReference(Specimen) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)
|
request | | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idSpecimen.request Short descriptionWhy the specimen was collected DefinitionDetails concerning a service request that required a specimen to be collected.
CommentsThe request may be explicit or implied such with a ServiceRequest that requires a blood draw.
Data typeReference(ServiceRequest) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.why[x]
- v2: ORC? OBR-2/3?
- rim: outboundRelationship[typeCode=FLFS].target
|
collection | | 0..1 | BackboneElement | There are no (further) constraints on this element Element idSpecimen.collection Short descriptionCollection details DefinitionDetails concerning the specimen collection.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SPM-14
- rim: .participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | Element idSpecimen.collection.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
specialHandling | C | 0..* | Extension(CodeableConcept) | Element idSpecimen.collection.extension:specialHandling Short descriptionSpecial handling of the specimen Alternate namesextensions, user content DefinitionSpecial handling during the collection, transport, or storage of the specimen.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttp://hl7.org/fhir/StructureDefinition/specimen-specialHandling ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.modifierExtension Short descriptionExtensions 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idSpecimen.collection.collector Short descriptionWho collected the specimen DefinitionPerson who collected the specimen.
Data typeReference(Practitioner | PractitionerRole) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.actor
- v2: PRT
- rim: .participation[typeCode=PFM].role
|
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.collector.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.collector.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
collectionCollectorR5 | C | 0..1 | Extension(Reference(Patient | RelatedPerson)) | Element idSpecimen.collection.collector.extension:collectionCollectorR5 Short descriptionPerson who collected the specimen Alternate namesextensions, user content DefinitionPerson who collected the specimen. This is an R5 backport
CommentsThere 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.
Data typeExtension(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- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.collector.extension:collectionCollectorR5.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.collector.extension:collectionCollectorR5.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idSpecimen.collection.collector.extension:collectionCollectorR5.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector Mappings |
value[x] | | 1..1 | | Element idSpecimen.collection.collector.extension:collectionCollectorR5.value[x] Short descriptionPerson who collected the specimen DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
valueReference | | | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Data typeReference(Patient | RelatedPerson) |
reference | Σ C | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.collector.reference Short descriptionLiteral reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
CommentsUsing absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data typestring ConditionsThe cardinality or value of this element may be affected by these constraints: ref-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idSpecimen.collection.collector.type Short descriptionType the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
CommentsThis element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data typeuri BindingAa resource (or, for logical models, the URI of the logical model).
ResourceType (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idSpecimen.collection.collector.identifier Short descriptionLogical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
CommentsWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.collector.display Short descriptionText alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
CommentsThis is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
collected[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idSpecimen.collection.collected[x] Short descriptionCollection time DefinitionTime when specimen was collected from subject - the physiologically relevant time.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.init
- v2: SPM-17
- rim: .effectiveTime
|
collectedDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
collectedPeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
duration | Σ | 0..1 | Duration | There are no (further) constraints on this element Element idSpecimen.collection.duration Short descriptionHow long it took to collect specimen DefinitionThe span of time over which the collection of a specimen occurred.
Data typeDuration Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
quantity | | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.collection.quantity Short descriptionThe 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.
Data typeSimpleQuantity Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SPM-12
- rim: .participation[typeCode=SBJ].role[classCode=SPEC].player.quantity
|
method | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.collection.method Short descriptionTechnique used to perform collection DefinitionA coded value specifying the technique that is used to perform the procedure.
Data typeCodeableConcept BindingThe technique that is used to perform the procedure.
FHIRSpecimenCollectionMethod (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SPM-7
- rim: .methodCode
|
bodySite | | 0..1 | CodeableConceptBinding | Element idSpecimen.collection.bodySite Short descriptionAnatomical 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.
CommentsIf 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.
Data typeCodeableConcept BindingCodes describing anatomical locations. May include laterality.
UKCoreSpecimenBodySite (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SPM-8 and SPM-9
- rim: .targetSiteCode
|
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
bodySiteReference | C | 0..1 | Extension(Reference(BodyStructure)) | Element idSpecimen.collection.bodySite.extension:bodySiteReference Short descriptionAn 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).
CommentsThere 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.
Data typeExtension(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- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.extension:bodySiteReference.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
CommentsThe 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.
Data typeuri Auto valuehttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference Mappings |
value[x] | | 1..1 | | Element idSpecimen.collection.bodySite.extension:bodySiteReference.value[x] Short descriptionA reference to a BodyStructure DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
valueReference | | | Reference(BodyStructure) | There are no (further) constraints on this element Data typeReference(BodyStructure) |
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.coding Short descriptionCode defined by a terminology system DefinitionA reference to a code defined by a terminology system.
RequirementsAllows for alternative encodings within a code system, and translations to other code systems.
CommentsCodes 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.
Data typeCoding Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.1-8, C*E.10-22
- rim: union(., ./translation)
- orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.collection.bodySite.text Short descriptionPlain 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.
RequirementsThe 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.
CommentsVery often the text is the same as a displayName of one of the codings.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: C*E.9. But note many systems use C*E.2 for this
- rim: ./originalText[mediaType/code="text/plain"]/data
- orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
|
fastingStatus[x] | Σ | 0..1 | Binding | There are no (further) constraints on this element Element idSpecimen.collection.fastingStatus[x] Short descriptionWhether 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.
RequirementsMany diagnostic tests require fasting to facilitate accurate interpretation.
CommentsRepresenting 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 such as Observation.component code` = LOINC 49541-6 (Fasting status - Reported).
BindingCodes describing the fasting status of the patient.
v2.0916 (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
fastingStatusCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
fastingStatusDuration | | | Duration | There are no (further) constraints on this element Data typeDuration |
processing | | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.processing Short descriptionProcessing and processing step details DefinitionDetails concerning processing and processing steps for the specimen.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]
|
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.processing.modifierExtension Short descriptionExtensions 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
description | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.processing.description Short descriptionTextual description of procedure DefinitionTextual description of procedure.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
procedure | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idSpecimen.processing.procedure Short descriptionIndicates the treatment step applied to the specimen DefinitionA coded value specifying the procedure used to process the specimen.
Data typeCodeableConcept BindingType indicating the technique used to process the specimen.
SpecimenProcessingProcedure (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
additive | | 0..* | Reference(Substance) | There are no (further) constraints on this element Element idSpecimen.processing.additive Short descriptionMaterial used in the processing step DefinitionMaterial used in the processing step.
Data typeReference(Substance) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SPM-6
- rim: .participation[typeCode=CSM].role[classCode=ADTV].code
|
time[x] | | 0..1 | | There are no (further) constraints on this element Element idSpecimen.processing.time[x] Short descriptionDate 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.
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
timeDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
timePeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
container | | 0..* | BackboneElement | There are no (further) constraints on this element Element idSpecimen.container Short descriptionDirect 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.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .player.scopingRole[classCode=CONT].scoper
|
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.id Short descriptionUnique 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.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.container.extension Short descriptionAdditional 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idSpecimen.container.modifierExtension Short descriptionExtensions 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists() Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idSpecimen.container.identifier Short descriptionId 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.
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
description | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.container.description Short descriptionTextual description of the container DefinitionTextual description of the container.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
type | | 0..1 | CodeableConceptBinding | Element idSpecimen.container.type Short descriptionKind of container directly associated with specimen DefinitionThe type of container associated with the specimen (e.g. slide, aliquot, etc.).
Data typeCodeableConcept BindingType of specimen container.
SpecimenContainerType (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
capacity | | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.capacity Short descriptionContainer volume or size DefinitionThe capacity (volume or other measure) the container may contain.
Data typeSimpleQuantity Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20
- rim: .quantity
|
specimenQuantity | | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idSpecimen.container.specimenQuantity Short descriptionQuantity of specimen within container DefinitionThe quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
Data typeSimpleQuantity Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SAC-23 (value) SAC-24 (units
- rim: .playedRole[classCode=CONT].quantity
|
additive[x] | | 0..1 | | There are no (further) constraints on this element Element idSpecimen.container.additive[x] Short descriptionAdditive associated with container DefinitionIntroduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
BindingSubstance added to specimen container.
v2.0371 (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: SAC-27
- rim: .scopesRole[classCode=ADTV].player
|
additiveCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
additiveReference | | | Reference(Substance) | There are no (further) constraints on this element Data typeReference(Substance) |
condition | Σ | 0..* | CodeableConceptBinding | Element idSpecimen.condition Short descriptionState of the specimen DefinitionA mode or state of being that describes the nature of the specimen.
RequirementsThe specimen condition can be used to assess its quality or appropriateness for a specific test.
CommentsSpecimen 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.
Data typeCodeableConcept BindingCodes describing the state of the specimen.
UKCoreBiopsyState (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
note | | 0..* | Annotation | There are no (further) constraints on this element Element idSpecimen.note Short descriptionComments DefinitionTo communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
Data typeAnnotation Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: OBX
- rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
|