QI-Core Implementation Guide
4.1.1 - STU 4.1.1
US
This page is part of the Quality Improvement Core Framework (v4.1.1: STU 4) based on FHIR 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
Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-specimen | Version: 4.1.1 | |||
Draft 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
Summary
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
type | S | 0..1 | CodeableConcept | Kind of material that forms the specimen |
subject | S | 0..1 | Reference(QICorePatient | QICoreDevice | QICoreSubstance | 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..1 | dateTime | The time when specimen was received for processing |
parent | 0..* | Reference(QICoreSpecimen) | Specimen from which this specimen originated | |
collection | 0..1 | BackboneElement | Collection details | |
collector | 0..1 | Reference(QICorePractitioner) | Who collected the specimen | |
collected[x] | S | 0..1 | dateTime, Period | Collection time |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site |
processing | 0..* | BackboneElement | Processing and processing step details | |
procedure | S | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen |
additive | 0..* | Reference(QICoreSubstance) | Material used in the processing step | |
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
specimen-sequenceNumber | 0..1 | integer | The sequence number of the sample URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber | |
additive[x] | 0..1 | Additive associated with container | ||
additiveCodeableConcept | CodeableConcept | |||
additiveReference | Reference(QICoreSubstance) | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Identifier |
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
subject | SΣ | 0..1 | Reference(QICorePatient | QICoreDevice | QICoreSubstance | 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..1 | dateTime | The time when specimen was received for processing |
parent | 0..* | Reference(QICoreSpecimen) | Specimen from which this specimen originated | |
request | 0..* | Reference(ServiceRequest) | Why the specimen was collected | |
collection | 0..1 | BackboneElement | Collection details | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
collector | Σ | 0..1 | Reference(QICorePractitioner) | Who collected the specimen |
collected[x] | SΣ | 0..1 | Collection time | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
duration | Σ | 0..1 | Duration | How long it took to collect specimen |
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |
fastingStatusCodeableConcept | CodeableConcept | |||
fastingStatusDuration | Duration | |||
processing | 0..* | BackboneElement | Processing and processing step details | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
description | 0..1 | string | Textual description of procedure | |
procedure | S | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. |
additive | 0..* | Reference(QICoreSubstance) | Material used in the processing step | |
time[x] | 0..1 | Date and time of specimen processing | ||
timeDateTime | dateTime | |||
timePeriod | Period | |||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
specimen-sequenceNumber | 0..1 | integer | The sequence number of the sample URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | Σ | 0..* | Identifier | Id for the container |
description | 0..1 | string | Textual description of the container | |
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |
capacity | 0..1 | SimpleQuantity | Container volume or size | |
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |
additive[x] | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||
additiveCodeableConcept | CodeableConcept | |||
additiveReference | Reference(QICoreSubstance) | |||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. |
note | 0..* | Annotation | Comments | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
type | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
subject | Σ | 0..1 | Reference(QICorePatient | QICoreDevice | QICoreSubstance | 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 | Σ | 0..1 | dateTime | The time when specimen was received for processing |
collection | 0..1 | BackboneElement | Collection details | |
collected[x] | Σ | 0..1 | Collection time | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
processing | 0..* | BackboneElement | Processing and processing step details | |
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |
Documentation for this format |
This structure is derived from Specimen
Summary
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Specimen
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
type | S | 0..1 | CodeableConcept | Kind of material that forms the specimen |
subject | S | 0..1 | Reference(QICorePatient | QICoreDevice | QICoreSubstance | 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..1 | dateTime | The time when specimen was received for processing |
parent | 0..* | Reference(QICoreSpecimen) | Specimen from which this specimen originated | |
collection | 0..1 | BackboneElement | Collection details | |
collector | 0..1 | Reference(QICorePractitioner) | Who collected the specimen | |
collected[x] | S | 0..1 | dateTime, Period | Collection time |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site |
processing | 0..* | BackboneElement | Processing and processing step details | |
procedure | S | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen |
additive | 0..* | Reference(QICoreSubstance) | Material used in the processing step | |
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
specimen-sequenceNumber | 0..1 | integer | The sequence number of the sample URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber | |
additive[x] | 0..1 | Additive associated with container | ||
additiveCodeableConcept | CodeableConcept | |||
additiveReference | Reference(QICoreSubstance) | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | Sample for analysis | |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | External Identifier |
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
subject | SΣ | 0..1 | Reference(QICorePatient | QICoreDevice | QICoreSubstance | 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..1 | dateTime | The time when specimen was received for processing |
parent | 0..* | Reference(QICoreSpecimen) | Specimen from which this specimen originated | |
request | 0..* | Reference(ServiceRequest) | Why the specimen was collected | |
collection | 0..1 | BackboneElement | Collection details | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
collector | Σ | 0..1 | Reference(QICorePractitioner) | Who collected the specimen |
collected[x] | SΣ | 0..1 | Collection time | |
collectedDateTime | dateTime | |||
collectedPeriod | Period | |||
duration | Σ | 0..1 | Duration | How long it took to collect specimen |
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |
fastingStatusCodeableConcept | CodeableConcept | |||
fastingStatusDuration | Duration | |||
processing | 0..* | BackboneElement | Processing and processing step details | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
description | 0..1 | string | Textual description of procedure | |
procedure | S | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. |
additive | 0..* | Reference(QICoreSubstance) | Material used in the processing step | |
time[x] | 0..1 | Date and time of specimen processing | ||
timeDateTime | dateTime | |||
timePeriod | Period | |||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
specimen-sequenceNumber | 0..1 | integer | The sequence number of the sample URL: http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | Σ | 0..* | Identifier | Id for the container |
description | 0..1 | string | Textual description of the container | |
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |
capacity | 0..1 | SimpleQuantity | Container volume or size | |
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |
additive[x] | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||
additiveCodeableConcept | CodeableConcept | |||
additiveReference | Reference(QICoreSubstance) | |||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. |
note | 0..* | Annotation | Comments | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Specimen.language | preferred | CommonLanguages Max Binding: AllLanguages |
Specimen.status | required | SpecimenStatus |
Specimen.type | example | Hl7VSSpecimenType |
Specimen.collection.method | example | FHIRSpecimenCollectionMethod |
Specimen.collection.bodySite | example | SNOMEDCTBodyStructures |
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation |
Specimen.processing.procedure | example | SpecimenProcessingProcedure |
Specimen.container.type | example | SpecimenContainerType |
Specimen.container.additive[x] | example | Hl7VSAdditivePreservative |
Specimen.condition | extensible | Hl7VSSpecimenCondition |
Id | Grade | Path | Details | Requirements |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | 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 | error | Specimen | 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 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Best Practice | Specimen | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | Specimen.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.accessionIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.receivedTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.parent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.collection | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.collection.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.collection.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.collection.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.collection.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.collection.collector | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.collection.collected[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.collection.duration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.collection.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.collection.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.collection.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.collection.fastingStatus[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.processing | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.processing.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.processing.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.processing.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.processing.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.processing.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.processing.procedure | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.processing.additive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.processing.time[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.container | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.container.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.container.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.container.extension:container-sequenceNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.container.extension:container-sequenceNumber | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.container.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Specimen.container.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Specimen.container.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.container.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.container.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.container.capacity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.container.specimenQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.container.additive[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Specimen.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |