CH LAB-Report (R4)
0.1.1 - draft Switzerland flag

This page is part of the CH LAB-Report (R4) (v0.1.1: DSTU 1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CH Lab SpecimenDefinition: Laboratory Report

Official URL: http://fhir.ch/ig/ch-lab-report/StructureDefinition/ch-lab-report-specimen-definition Version: 0.1.1
Active as of 2023-12-28 Computable Name: ChLabReportSpecimenDefinition

Copyright/Legal: CC0-1.0

Defines a kind of specimen, which can be associated with in vitro diagnostic procedures

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenDefinitionIf 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-4errorSpecimenDefinitionIf 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-5errorSpecimenDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierBusiness identifier of a kind of specimen
... typeCollected Σ0..1CodeableConceptKind of material to collect
Binding: hl7VS-specimenType (example): The type of the specimen to be collected.

... patientPreparation Σ0..*CodeableConceptPatient preparation for collection
Binding: PreparePatient (example): Checks on the patient prior specimen collection.


... timeAspect Σ0..1stringTime aspect for collection
Example General: 24 hour, 20' post charge
... collection Σ0..*CodeableConceptSpecimen collection procedure
Binding: SpecimenCollection (example): The action to collect a type of specimen.


... typeTested 0..*BackboneElementSpecimen in container intended for testing by lab
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... isDerived 0..1booleanPrimary or secondary specimen
Example General: false
.... type 0..1CodeableConceptType of intended specimen
Binding: hl7VS-specimenType (example): The type of specimen conditioned in a container for lab testing.

.... preference 1..1codepreferred | alternate
Binding: SpecimenContainedPreference (required): Degree of preference of a type of conditioned specimen.


Example General: preferred, alternate
.... container 0..1BackboneElementThe specimen's container
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... material 0..1CodeableConceptContainer material
Binding: ContainerMaterials (example): Types of material for specimen containers.

..... type 0..1CodeableConceptKind of container associated with the kind of specimen
Binding: SpecimenContainerType (example): Type of specimen container.

..... cap 0..1CodeableConceptColor of container cap
Binding: ContainerCap (example): Color of the container cap.

..... description 0..1stringContainer description
Example General: Blue top tube with citrate
..... capacity 0..1SimpleQuantityContainer capacity
..... minimumVolume[x] 0..1Minimum volume
...... minimumVolumeQuantityQuantity(SimpleQuantity)
...... minimumVolumeStringstring
..... additive 0..*BackboneElementAdditive associated with container
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... additive[x] 1..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

....... additiveCodeableConceptCodeableConcept
....... additiveReferenceReference(Substance)
..... preparation 0..1stringSpecimen container preparation
.... requirement 0..1stringSpecimen requirements
.... retentionTime 0..1DurationSpecimen retention time
.... rejectionCriterion 0..*CodeableConceptRejection criterion
Binding: RejectionCriterion (example): Criterion for rejection of the specimen by laboratory.


.... handling 0..*BackboneElementSpecimen handling before testing
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... temperatureQualifier 0..1CodeableConceptTemperature qualifier
Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen.

..... temperatureRange 0..1RangeTemperature range
..... maxDuration 0..1DurationMaximum preservation time
..... instruction 0..1stringPreservation instruction
Example General: freeze within 4 hours

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
SpecimenDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
SpecimenDefinition.typeCollectedexampleHl7VSSpecimenType
SpecimenDefinition.patientPreparationexamplePreparePatient
SpecimenDefinition.collectionexampleSpecimenCollection
SpecimenDefinition.typeTested.typeexampleHl7VSSpecimenType
SpecimenDefinition.typeTested.preferencerequiredSpecimenContainedPreference
SpecimenDefinition.typeTested.container.materialexampleContainerMaterials
SpecimenDefinition.typeTested.container.typeexampleSpecimenContainerType
SpecimenDefinition.typeTested.container.capexampleContainerCap
SpecimenDefinition.typeTested.container.additive.additive[x]exampleHl7VSAdditivePreservative
SpecimenDefinition.typeTested.rejectionCriterionexampleRejectionCriterion
SpecimenDefinition.typeTested.handling.temperatureQualifierexampleHandlingConditionSet

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenDefinitionIf 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-4errorSpecimenDefinitionIf 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-5errorSpecimenDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenDefinitionIf 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-4errorSpecimenDefinitionIf 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-5errorSpecimenDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..*SpecimenDefinitionKind of specimen
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..1IdentifierBusiness identifier of a kind of specimen
... typeCollected Σ0..1CodeableConceptKind of material to collect
Binding: hl7VS-specimenType (example): The type of the specimen to be collected.

... patientPreparation Σ0..*CodeableConceptPatient preparation for collection
Binding: PreparePatient (example): Checks on the patient prior specimen collection.


... timeAspect Σ0..1stringTime aspect for collection
Example General: 24 hour, 20' post charge
... collection Σ0..*CodeableConceptSpecimen collection procedure
Binding: SpecimenCollection (example): The action to collect a type of specimen.


... typeTested 0..*BackboneElementSpecimen in container intended for testing by lab
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... isDerived 0..1booleanPrimary or secondary specimen
Example General: false
.... type 0..1CodeableConceptType of intended specimen
Binding: hl7VS-specimenType (example): The type of specimen conditioned in a container for lab testing.

.... preference 1..1codepreferred | alternate
Binding: SpecimenContainedPreference (required): Degree of preference of a type of conditioned specimen.


Example General: preferred, alternate
.... container 0..1BackboneElementThe specimen's container
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... material 0..1CodeableConceptContainer material
Binding: ContainerMaterials (example): Types of material for specimen containers.

..... type 0..1CodeableConceptKind of container associated with the kind of specimen
Binding: SpecimenContainerType (example): Type of specimen container.

..... cap 0..1CodeableConceptColor of container cap
Binding: ContainerCap (example): Color of the container cap.

..... description 0..1stringContainer description
Example General: Blue top tube with citrate
..... capacity 0..1SimpleQuantityContainer capacity
..... minimumVolume[x] 0..1Minimum volume
...... minimumVolumeQuantityQuantity(SimpleQuantity)
...... minimumVolumeStringstring
..... additive 0..*BackboneElementAdditive associated with container
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... additive[x] 1..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

....... additiveCodeableConceptCodeableConcept
....... additiveReferenceReference(Substance)
..... preparation 0..1stringSpecimen container preparation
.... requirement 0..1stringSpecimen requirements
.... retentionTime 0..1DurationSpecimen retention time
.... rejectionCriterion 0..*CodeableConceptRejection criterion
Binding: RejectionCriterion (example): Criterion for rejection of the specimen by laboratory.


.... handling 0..*BackboneElementSpecimen handling before testing
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... temperatureQualifier 0..1CodeableConceptTemperature qualifier
Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen.

..... temperatureRange 0..1RangeTemperature range
..... maxDuration 0..1DurationMaximum preservation time
..... instruction 0..1stringPreservation instruction
Example General: freeze within 4 hours

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
SpecimenDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
SpecimenDefinition.typeCollectedexampleHl7VSSpecimenType
SpecimenDefinition.patientPreparationexamplePreparePatient
SpecimenDefinition.collectionexampleSpecimenCollection
SpecimenDefinition.typeTested.typeexampleHl7VSSpecimenType
SpecimenDefinition.typeTested.preferencerequiredSpecimenContainedPreference
SpecimenDefinition.typeTested.container.materialexampleContainerMaterials
SpecimenDefinition.typeTested.container.typeexampleSpecimenContainerType
SpecimenDefinition.typeTested.container.capexampleContainerCap
SpecimenDefinition.typeTested.container.additive.additive[x]exampleHl7VSAdditivePreservative
SpecimenDefinition.typeTested.rejectionCriterionexampleRejectionCriterion
SpecimenDefinition.typeTested.handling.temperatureQualifierexampleHandlingConditionSet

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenDefinitionIf 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-4errorSpecimenDefinitionIf 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-5errorSpecimenDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

Summary

 

Other representations of profile: CSV, Excel, Schematron