QI-Core Implementation Guide
5.0.0 - STU5 United States of America flag

This page is part of the Quality Improvement Core Framework (v5.0.0: STU5 (v5.0.0)) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore Specimen

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-specimen Version: 5.0.0
Active as of 2018-08-22 Computable Name: QICoreSpecimen

Profile of Specimen for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Usage

See the patterns page for implementation and usage patterns.

Examples

Blood Sample Example

Usage:

Formal Views of Profile Content

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

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... type S0..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (preferred): The kind of material that forms the specimen

... subject S0..1Reference(QICore Patient | QICore Device | US Core Implantable Device Profile | QICore Substance | Group)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime S0..1dateTimeThe time when specimen was received for processing
... collection 0..1BackboneElementCollection details
.... collector 0..1Reference(QICore Practitioner)Who collected the specimen
.... collected[x] S0..1dateTime, PeriodCollection time
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (preferred): Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

... processing 0..*BackboneElementProcessing and processing step details
.... procedure S0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (preferred): A coded value specifying the procedure used to process the specimen.

.... additive 0..*Reference(QICore Substance)Material used in the processing step
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... container-sequenceNumber 0..1integerThe sequence number of the sample
URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
.... additive[x] 0..1Additive associated with container
..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(QICore Substance)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Specimen.typepreferredHl7VSSpecimenType
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
Specimen.processing.procedurepreferredSpecimenProcessingProcedure
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... subject SΣ0..1Reference(QICore Patient | QICore Device | US Core Implantable Device Profile | QICore Substance | Group)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime SΣ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(QICore Specimen)Specimen from which this specimen originated
... collection 0..1BackboneElementCollection details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(QICore Practitioner)Who collected the specimen
.... collected[x] SΣ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (preferred): Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

... processing 0..*BackboneElementProcessing and processing step details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... procedure S0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (preferred): A coded value specifying the procedure used to process the specimen.

.... additive 0..*Reference(QICore Substance)Material used in the processing step
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... container-sequenceNumber 0..1integerThe sequence number of the sample
URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(QICore Substance)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredHl7VSSpecimenType
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
Specimen.processing.procedurepreferredSpecimenProcessingProcedure
Specimen.container.additive[x]exampleHl7VSAdditivePreservative

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf 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-4errorSpecimenIf 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-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenA 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
.. Specimen 0..*SpecimenSample for analysis
... 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..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ0..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (preferred): The kind of material that forms the specimen

... subject SΣ0..1Reference(QICore Patient | QICore Device | US Core Implantable Device Profile | QICore Substance | Group)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime SΣ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(QICore Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
.... 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
.... collector Σ0..1Reference(QICore Practitioner)Who collected the specimen
.... collected[x] SΣ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (preferred): Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... 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
.... description 0..1stringTextual description of procedure
.... procedure S0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (preferred): A coded value specifying the procedure used to process the specimen.

.... additive 0..*Reference(QICore Substance)Material used in the processing step
.... time[x] 0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... container-sequenceNumber 0..1integerThe sequence number of the sample
URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example): Type of specimen container.

.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(QICore Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredHl7VSSpecimenType
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedurepreferredSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

Constraints

IdGradePath(s)DetailsRequirements
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()

Differential View

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... type S0..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (preferred): The kind of material that forms the specimen

... subject S0..1Reference(QICore Patient | QICore Device | US Core Implantable Device Profile | QICore Substance | Group)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime S0..1dateTimeThe time when specimen was received for processing
... collection 0..1BackboneElementCollection details
.... collector 0..1Reference(QICore Practitioner)Who collected the specimen
.... collected[x] S0..1dateTime, PeriodCollection time
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (preferred): Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

... processing 0..*BackboneElementProcessing and processing step details
.... procedure S0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (preferred): A coded value specifying the procedure used to process the specimen.

.... additive 0..*Reference(QICore Substance)Material used in the processing step
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... container-sequenceNumber 0..1integerThe sequence number of the sample
URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
.... additive[x] 0..1Additive associated with container
..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(QICore Substance)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Specimen.typepreferredHl7VSSpecimenType
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
Specimen.processing.procedurepreferredSpecimenProcessingProcedure

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..*SpecimenSample for analysis
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... subject SΣ0..1Reference(QICore Patient | QICore Device | US Core Implantable Device Profile | QICore Substance | Group)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime SΣ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(QICore Specimen)Specimen from which this specimen originated
... collection 0..1BackboneElementCollection details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... collector Σ0..1Reference(QICore Practitioner)Who collected the specimen
.... collected[x] SΣ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (preferred): Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

... processing 0..*BackboneElementProcessing and processing step details
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... procedure S0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (preferred): A coded value specifying the procedure used to process the specimen.

.... additive 0..*Reference(QICore Substance)Material used in the processing step
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... container-sequenceNumber 0..1integerThe sequence number of the sample
URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(QICore Substance)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredHl7VSSpecimenType
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
Specimen.processing.procedurepreferredSpecimenProcessingProcedure
Specimen.container.additive[x]exampleHl7VSAdditivePreservative

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenIf 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-4errorSpecimenIf 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-5errorSpecimenIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenA 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
.. Specimen 0..*SpecimenSample for analysis
... 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..*IdentifierExternal Identifier
... accessionIdentifier Σ0..1IdentifierIdentifier assigned by the lab
... status ?!Σ0..1codeavailable | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.

... type SΣ0..1CodeableConceptKind of material that forms the specimen
Binding: hl7VS-specimenType (preferred): The kind of material that forms the specimen

... subject SΣ0..1Reference(QICore Patient | QICore Device | US Core Implantable Device Profile | QICore Substance | Group)Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
... receivedTime SΣ0..1dateTimeThe time when specimen was received for processing
... parent 0..*Reference(QICore Specimen)Specimen from which this specimen originated
... request 0..*Reference(ServiceRequest)Why the specimen was collected
... collection 0..1BackboneElementCollection details
.... 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
.... collector Σ0..1Reference(QICore Practitioner)Who collected the specimen
.... collected[x] SΣ0..1Collection time
..... collectedDateTimedateTime
..... collectedPeriodPeriod
.... duration Σ0..1DurationHow long it took to collect specimen
.... quantity 0..1SimpleQuantityThe quantity of specimen collected
.... method 0..1CodeableConceptTechnique used to perform collection
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.

.... bodySite S0..1CodeableConceptAnatomical collection site
Binding: SNOMEDCTBodyStructures (preferred): Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.

.... fastingStatus[x] Σ0..1Whether or how long patient abstained from food and/or drink
Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.

..... fastingStatusCodeableConceptCodeableConcept
..... fastingStatusDurationDuration
... processing 0..*BackboneElementProcessing and processing step details
.... 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
.... description 0..1stringTextual description of procedure
.... procedure S0..1CodeableConceptIndicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (preferred): A coded value specifying the procedure used to process the specimen.

.... additive 0..*Reference(QICore Substance)Material used in the processing step
.... time[x] 0..1Date and time of specimen processing
..... timeDateTimedateTime
..... timePeriodPeriod
... container 0..*BackboneElementDirect container of specimen (tube/slide, etc.)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... container-sequenceNumber 0..1integerThe sequence number of the sample
URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierId for the container
.... description 0..1stringTextual description of the container
.... type 0..1CodeableConceptKind of container directly associated with specimen
Binding: SpecimenContainerType (example): Type of specimen container.

.... capacity 0..1SimpleQuantityContainer volume or size
.... specimenQuantity 0..1SimpleQuantityQuantity of specimen within container
.... additive[x] 0..1Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

..... additiveCodeableConceptCodeableConcept
..... additiveReferenceReference(QICore Substance)
... condition Σ0..*CodeableConceptState of the specimen
Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.


... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Specimen.statusrequiredSpecimenStatus
Specimen.typepreferredHl7VSSpecimenType
Specimen.collection.methodexampleFHIRSpecimenCollectionMethod
Specimen.collection.bodySitepreferredSNOMEDCTBodyStructures
Specimen.collection.fastingStatus[x]extensibleHl7VSRelevantClincialInformation
Specimen.processing.procedurepreferredSpecimenProcessingProcedure
Specimen.container.typeexampleSpecimenContainerType
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
Specimen.conditionextensibleHl7VSSpecimenCondition

Constraints

IdGradePath(s)DetailsRequirements
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()

 

Other representations of profile: CSV, Excel, Schematron