MII_PR_Onko_Specimen (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() Mappings- rim: Entity. Role, or Act
- rim: Role[classCode=SPEC]
- oBDS: 6
|
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())
|
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.meta.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.meta.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 |
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idSpecimen.meta.versionId Short descriptionVersion specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
CommentsThe server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Data typeid Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idSpecimen.meta.lastUpdated Short descriptionWhen the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed.
CommentsThis value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Data typeinstant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idSpecimen.meta.source Short descriptionIdentifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
CommentsIn the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.
This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
profile | S Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element idSpecimen.meta.profile Short descriptionProfiles this resource claims to conform to DefinitionCommentsIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Data typecanonical(StructureDefinition) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idSpecimen.meta.security Short descriptionSecurity Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
CommentsThe security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Data typeCoding BindingSecurity Labels from the Healthcare Privacy and Security Classification System.
All Security Labels (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idSpecimen.meta.tag Short descriptionTags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
CommentsThe tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Data typeCoding BindingCodes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
CommonTags (example) 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 | There are no (further) constraints on this element 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 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 | S Σ | 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
|
id | | 0..1 | string | There are no (further) constraints on this element Element idSpecimen.accessionIdentifier.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.accessionIdentifier.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 |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idSpecimen.accessionIdentifier.use Short descriptionusual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier.
RequirementsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
CommentsApplications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data typecode BindingIdentifies the purpose for this identifier, if known .
IdentifierUse (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: N/A
- rim: Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idSpecimen.accessionIdentifier.type Short descriptionDescription of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
RequirementsAllows users to make use of identifiers when the identifier system is not known.
CommentsThis element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data typeCodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Identifier Type Codes (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: CX.5
- rim: Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idSpecimen.accessionIdentifier.system Short descriptionThe namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
RequirementsThere are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
CommentsIdentifier.system is always case sensitive.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples Generalhttp://www.acme.com/identifiers/patient Mappings- v2: CX.4 / EI-2-4
- rim: II.root or Role.id.root
- servd: ./IdentifierType
|
value | S Σ | 0..1 | string | Element idSpecimen.accessionIdentifier.value Short descriptionHistologie-Einsendenummer DefinitionHistologie-Einsendenummer nach 6.2 oBDS 2021
CommentsIf the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Examples General123456 Mappings- v2: CX.1 / EI.1
- rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd: ./Value
- oBDS: 6.2
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idSpecimen.accessionIdentifier.period Short descriptionTime period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: CX.7 + CX.8
- rim: Role.effectiveTime or implied by context
- servd: ./StartDate and ./EndDate
|
assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idSpecimen.accessionIdentifier.assigner Short descriptionOrganization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier.
CommentsThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data typeReference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: CX.4 / (CX.4,CX.9,CX.10)
- rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd: ./IdentifierIssuingAuthority
|
status | Σ ?! | 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 | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element 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 BindingThe type of the specimen.
v2.0487 (example) 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 Σ | 1..1 | Reference(Patient) | 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) 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 | Σ | 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 | S | 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 | There are no (further) constraints on this element 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 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
|
collected[x] | Σ | 0..1 | | Element idSpecimen.collection.collected[x] Short descriptionCollection time DefinitionTime when specimen was collected from subject - the physiologically relevant time.
SlicingUnordered, Open, by $this(Type) 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
|
collectedPeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
collectedDateTime | S Σ | 0..1 | dateTime | Element idSpecimen.collection.collected[x]:collectedDateTime Short descriptionTumor Histologiedatum DefinitionHistologiedatum nach 6.1 oBDS 2021
Data typedateTime 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
- oBDS: 6.1
|
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 | CodeableConcept | There are no (further) constraints on this element 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.
SNOMEDCTBodyStructures (example) 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
|
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 | CodeableConcept | There are no (further) constraints on this element 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 (example) 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 | There are no (further) constraints on this element 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.
v2.0493 (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
|