SpecimenDefinition (MY Core)

Defining URL http://fhir.hie.moh.gov.my/StructureDefinition/SpecimenDefinition-my-core
Version 1.0.0
Name SpecimenDefinitionMyCore
Definition A kind of specimen with associated set of requirements.
Title SpecimenDefinition (MY Core)
Status Active as of 4-11-2022
Publisher Malaysia MOH - HIE Steering Committee
Copyright Used by permission of HL7 International, all rights reserved Creative Commons License

SpecimenDefinition
DefinitionA kind of specimen with associated set of requirements.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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-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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • v2: OM4
  • rim: Role[classCode=SPEC]
SpecimenDefinition.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

SpecimenDefinition.meta
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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
SpecimenDefinition.implicitRules
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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
SpecimenDefinition.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
SpecimenDefinition.text
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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
SpecimenDefinition.contained
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.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
SpecimenDefinition.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.identifier
DefinitionA business identifier associated with the kind of specimen.
Cardinality0...1
TypeIdentifier
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
SpecimenDefinition.typeCollected
DefinitionThe kind of material to be collected.
Cardinality0...1
TypeCodeableConcept
Binding

The type of the specimen to be collected.

v2.0487 (example)
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: OM4-6
SpecimenDefinition.patientPreparation
DefinitionPreparation of the patient for specimen collection.
Cardinality0...*
TypeCodeableConcept
Binding

Checks on the patient prior specimen collection.

PreparePatient (example)
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: OM1-37
SpecimenDefinition.timeAspect
DefinitionTime aspect of specimen collection (duration or offset).
Cardinality0...1
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

24 hour, 20' post charge


Mappings
  • rim: n/a
  • v2: OM1-43, OM1-44
SpecimenDefinition.collection
DefinitionThe action to be performed for collecting the specimen.
Cardinality0...*
TypeCodeableConcept
Binding

The action to collect a type of specimen.

SpecimenCollection (example)
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
SpecimenDefinition.typeTested
DefinitionSpecimen conditioned in a container as expected by the testing laboratory.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
SpecimenDefinition.typeTested.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
SpecimenDefinition.typeTested.extension
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.
Cardinality1...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.extension:combineSample
DefinitionExtension to determine whether the lab test allows combining the same sample with another lab test
Cardinality1...1
TypeExtension(boolean)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.isDerived
DefinitionPrimary of secondary specimen.
Cardinality0...1
Typeboolean
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

false


Mappings
  • rim: n/a
  • v2: OM4-2
SpecimenDefinition.typeTested.type
DefinitionThe kind of specimen conditioned for testing expected by lab.
Cardinality0...1
TypeCodeableConcept
Binding

The type of specimen conditioned in a container for lab testing.

v2.0487 (example)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
SpecimenDefinition.typeTested.preference
DefinitionThe preference for this type of conditioned specimen.
Cardinality1...1
Typecode
Binding

Degree of preference of a type of conditioned specimen.

SpecimenContainedPreference (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

preferred, alternate


Mappings
  • rim: n/a
  • v2: OM4-16
SpecimenDefinition.typeTested.container
DefinitionThe specimen's container.
Cardinality0...1
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
SpecimenDefinition.typeTested.container.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
SpecimenDefinition.typeTested.container.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.container.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.container.material
DefinitionThe type of material of the container.
Cardinality0...1
TypeCodeableConcept
Binding

Types of material for specimen containers.

ContainerMaterials (example)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
SpecimenDefinition.typeTested.container.type
DefinitionThe type of container used to contain this kind of specimen.
Cardinality1...1
TypeCodeableConcept
Binding

Type of specimen container.

ValueSetSpecimenContainerTypeMyCore (required)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
SpecimenDefinition.typeTested.container.cap
DefinitionColor of container cap.
Cardinality0...1
TypeCodeableConcept
Binding

Color of the container cap.

ContainerCap (example)
Requirements

From ISO 6710-2017 Table F.1 Recommended colour codes.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
SpecimenDefinition.typeTested.container.description
DefinitionThe textual description of the kind of container.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

Blue top tube with citrate


Mappings
  • rim: n/a
  • v2: OM4-3
SpecimenDefinition.typeTested.container.capacity
DefinitionThe capacity (volume or other measure) of this kind of container.
Cardinality0...1
TypeSimpleQuantity
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • sqty-1: The comparator is not used on a SimpleQuantity
    comparator.empty()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
  • v2: OM4-4, OM4-5
SpecimenDefinition.typeTested.container.minimumVolume[x]
DefinitionThe minimum volume to be conditioned in the container.
Cardinality0...1
TypeSimpleQuantity
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: OM4-11
SpecimenDefinition.typeTested.container.additive
DefinitionSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: OM4-7
SpecimenDefinition.typeTested.container.additive.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
SpecimenDefinition.typeTested.container.additive.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.container.additive.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.container.additive.additive[x]
DefinitionSubstance introduced in the kind of container to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
Cardinality1...1
TypeCodeableConcept
Binding

Substance added to specimen container.

v2.0371 (example)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: OM4-7
SpecimenDefinition.typeTested.container.preparation
DefinitionSpecial processing that should be applied to the container for this kind of specimen.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: OM4-8
SpecimenDefinition.typeTested.requirement
DefinitionRequirements for delivery and special handling of this kind of conditioned specimen.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: OM4-12
SpecimenDefinition.typeTested.retentionTime
DefinitionThe usual time that a specimen of this kind is retained after the ordered tests are completed, for the purpose of additional testing.
Cardinality0...1
TypeDuration
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
    code.exists() implies ((system = %ucum) and value.exists())
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
  • rim: PQ, IVL<PQ> depending on the values
  • v2: OM4-14
SpecimenDefinition.typeTested.rejectionCriterion
DefinitionCriterion for rejection of the specimen in its container by the laboratory.
Cardinality0...*
TypeCodeableConcept
Binding

Criterion for rejection of the specimen by laboratory.

RejectionCriterion (example)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: OM1-39
SpecimenDefinition.typeTested.handling
DefinitionSet of instructions for preservation/transport of the specimen at a defined temperature interval, prior the testing process.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
SpecimenDefinition.typeTested.handling.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
SpecimenDefinition.typeTested.handling.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.handling.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
  • rim: n/a
  • rim: N/A
SpecimenDefinition.typeTested.handling.temperatureQualifier
DefinitionIt qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element.
Cardinality0...1
TypeCodeableConcept
Binding

Set of handling instructions prior testing of the specimen.

HandlingConditionSet (example)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: OM4-15
SpecimenDefinition.typeTested.handling.temperatureRange
DefinitionThe temperature interval for this set of handling instructions.
Cardinality0...1
TypeRange
Comments

The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • rng-2: If present, low SHALL have a lower value than high
    low.empty() or high.empty() or (low <= high)
Mappings
  • rim: n/a
  • v2: NR and also possibly SN (but see also quantity)
  • rim: IVL<QTY[not(type="TS")]> [lowClosed="true" and highClosed="true"]or URG<QTY[not(type="TS")]>
SpecimenDefinition.typeTested.handling.maxDuration
DefinitionThe maximum time interval of preservation of the specimen with these conditions.
Cardinality0...1
TypeDuration
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
    code.exists() implies ((system = %ucum) and value.exists())
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
  • rim: PQ, IVL<PQ> depending on the values
SpecimenDefinition.typeTested.handling.instruction
DefinitionAdditional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

freeze within 4 hours


Mappings
  • rim: n/a

example-servicerequest

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="SpecimenDefinition-my-core" />
    <url value="http://fhir.hie.moh.gov.my/StructureDefinition/SpecimenDefinition-my-core" />
    <version value="1.0.0" />
    <name value="SpecimenDefinitionMyCore" />
    <title value="SpecimenDefinition (MY Core)" />
    <status value="active" />
    <date value="2024-03-13T01:41:41.3395961+00:00" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="SpecimenDefinition" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/SpecimenDefinition" />
    <derivation value="constraint" />
    <differential>
        <element id="SpecimenDefinition.typeTested.extension">
            <path value="SpecimenDefinition.typeTested.extension" />
            <min value="1" />
        </element>
        <element id="SpecimenDefinition.typeTested.extension:combineSample">
            <path value="SpecimenDefinition.typeTested.extension" />
            <sliceName value="combineSample" />
            <short value="Extension to determine whether the lab test allows combining the same sample with another lab test" />
            <definition value="Extension to determine whether the lab test allows combining the same sample with another lab test" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/specimen-combine-sample-my-core" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="SpecimenDefinition.typeTested.container.type">
            <path value="SpecimenDefinition.typeTested.container.type" />
            <min value="1" />
            <binding>
                <strength value="required" />
                <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/specimen-container-type-my-core" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "SpecimenDefinition-my-core",
    "url": "http://fhir.hie.moh.gov.my/StructureDefinition/SpecimenDefinition-my-core",
    "version": "1.0.0",
    "name": "SpecimenDefinitionMyCore",
    "title": "SpecimenDefinition (MY Core)",
    "status": "active",
    "date": "2024-03-13T01:41:41.3395961+00:00",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "SpecimenDefinition",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "SpecimenDefinition.typeTested.extension",
                "path": "SpecimenDefinition.typeTested.extension",
                "min": 1
            },
            {
                "id": "SpecimenDefinition.typeTested.extension:combineSample",
                "path": "SpecimenDefinition.typeTested.extension",
                "sliceName": "combineSample",
                "short": "Extension to determine whether the lab test allows combining the same sample with another lab test",
                "definition": "Extension to determine whether the lab test allows combining the same sample with another lab test",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.hie.moh.gov.my/StructureDefinition/specimen-combine-sample-my-core"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "SpecimenDefinition.typeTested.container.type",
                "path": "SpecimenDefinition.typeTested.container.type",
                "min": 1,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/specimen-container-type-my-core"
                }
            }
        ]
    }
}

Snapshot

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..1Identifier
typeCollectedΣ0..1CodeableConcept
patientPreparationΣ0..*CodeableConcept
timeAspectΣ0..1string
collectionΣ0..*CodeableConcept
id0..1string
combineSampleI1..1Extension(boolean)
modifierExtensionΣ ?! I0..*Extension
isDerived0..1boolean
type0..1CodeableConcept
preference1..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
material0..1CodeableConcept
type1..1CodeableConceptBinding
cap0..1CodeableConcept
description0..1string
capacityI0..1SimpleQuantity
minimumVolumeQuantitySimpleQuantity
minimumVolumeStringstring
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
additiveCodeableConceptCodeableConcept
additiveReferenceReference(Substance)
preparation0..1string
requirement0..1string
retentionTimeI0..1Duration
rejectionCriterion0..*CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
temperatureQualifier0..1CodeableConcept
temperatureRangeI0..1Range
maxDurationI0..1Duration
instruction0..1string

Diff

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..1Identifier
typeCollectedΣ0..1CodeableConcept
patientPreparationΣ0..*CodeableConcept
timeAspectΣ0..1string
collectionΣ0..*CodeableConcept
id0..1string
combineSampleI1..1Extension(boolean)
modifierExtensionΣ ?! I0..*Extension
isDerived0..1boolean
type0..1CodeableConcept
preference1..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
material0..1CodeableConcept
type1..1CodeableConceptBinding
cap0..1CodeableConcept
description0..1string
capacityI0..1SimpleQuantity
minimumVolumeQuantitySimpleQuantity
minimumVolumeStringstring
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
additiveCodeableConceptCodeableConcept
additiveReferenceReference(Substance)
preparation0..1string
requirement0..1string
retentionTimeI0..1Duration
rejectionCriterion0..*CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
temperatureQualifier0..1CodeableConcept
temperatureRangeI0..1Range
maxDurationI0..1Duration
instruction0..1string

Hybrid

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..1Identifier
typeCollectedΣ0..1CodeableConcept
patientPreparationΣ0..*CodeableConcept
timeAspectΣ0..1string
collectionΣ0..*CodeableConcept
id0..1string
combineSampleI1..1Extension(boolean)
modifierExtensionΣ ?! I0..*Extension
isDerived0..1boolean
type0..1CodeableConcept
preference1..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
material0..1CodeableConcept
type1..1CodeableConceptBinding
cap0..1CodeableConcept
description0..1string
capacityI0..1SimpleQuantity
minimumVolumeQuantitySimpleQuantity
minimumVolumeStringstring
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
additiveCodeableConceptCodeableConcept
additiveReferenceReference(Substance)
preparation0..1string
requirement0..1string
retentionTimeI0..1Duration
rejectionCriterion0..*CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
temperatureQualifier0..1CodeableConcept
temperatureRangeI0..1Range
maxDurationI0..1Duration
instruction0..1string

This profile is derived from the base FHIR SpecimenDefinition resource.

Requirements

This structure has no mandatory element as of now.

Extension

This structure includes the following extension:

  1. ExtensionSpecimenCombineSample (MY Core)

Slice

This structure defines the following slice:

  1. category.coding element, sliced based on value:system,
  1. code.coding element, sliced based on value:system,