QI-Core Implementation Guide
7.0.0-ballot - STU7 United States of America flag

QI-Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICore Substance

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-substance Version: 7.0.0-ballot
Active as of 2018-08-22 Computable Name: QICoreSubstance

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

QI Elements:
  • code: (QI) If this describes a specific package/container of the substance
  • instance.quantity: (QI) Amount of substance in the package
  • ingredient.quantity: (QI) Optional amount (concentration)
  • ingredient.substance[x]: (QI) A component of the substance
Primary code path: code
(PCPath) This element is the primary code path for this resource CQL Retrieve


NOTE TO BALLOT REVIEWERS:
  • US Core 7.0, and thus QI-Core 7.0, has a new approach to USCDI requirements.
    • As noted in the US Core 7.0 Must Support section, US Core 7.0 no longer highlights mandatory (cardinality 1..* or 1..1) and Must Support elements with a (USCDI) indicator as such items must be supported for interoperability.
    • Those USCDI elements that are not mandatory or Must Support now include an indicator (ADDITIONAL USCDI) in US Core. QI-Core 7.0 does not reference USCDI elements; rather, users should access US Core 7.0 to understand its implementation of USCDI version 4.
  • We invite comments about the approach and suggestions for other options that would also avoid unnecessary noise or reading load to the QI-Core profile representation.
  • Further, QI-Core 7.0 does not discuss USCDI+Quality because at the time of ballot preparation, no published version of USCDI+Quality is available. We seek reviewer advice regarding how QI-Core might address future USCDI+Quality.

Usage

See the patterns page for implementation and usage patterns.

Examples

Honey Bee venom (apitoxin) Example

Usage:

Formal Views of Profile Content

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

This structure is derived from Substance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance Substance
... code 1..1 CodeableConcept (QI) If this describes a specific package/container of the substance
Binding: SubstanceCode (preferred): Substance codes

... instance 0..* BackboneElement If this describes a specific package/container of the substance
.... quantity 0..1 SimpleQuantity (QI) Amount of substance in the package
... ingredient 0..* BackboneElement Composition information about the substance
.... quantity 0..1 Ratio (QI) Optional amount (concentration)
.... substance[x] 1..1 Reference(QICore Substance) (QI) A component of the substance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Substance.codepreferredSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity Σ 0..1 SimpleQuantity (QI) Amount of substance in the package
... ingredient Σ 0..* BackboneElement Composition information about the substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity Σ 0..1 Ratio (QI) Optional amount (concentration)
.... substance[x] Σ 1..1 Reference(QICore Substance) (QI) A component of the substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.codepreferredSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA 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
.. Substance 0..* Substance A homogeneous material with a definite composition
... id Σ 0..1 id 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
... 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 Unique identifier
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... category Σ 0..* CodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code Σ 1..1 CodeableConcept (QI) If this describes a specific package/container of the substance
Binding: SubstanceCode (preferred): Substance codes

... description Σ 0..1 string Textual description of the substance, comments
... instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
.... 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
.... identifier Σ 0..1 Identifier Identifier of the package/container
.... expiry Σ 0..1 dateTime When no longer valid to use
.... quantity Σ 0..1 SimpleQuantity (QI) Amount of substance in the package
... ingredient Σ 0..* BackboneElement Composition information about the substance
.... 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
.... quantity Σ 0..1 Ratio (QI) Optional amount (concentration)
.... substance[x] Σ 1..1 Reference(QICore Substance) (QI) A component of the substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.categoryextensibleSubstanceCategoryCodes
http://hl7.org/fhir/ValueSet/substance-category
from the FHIR Standard
Substance.codepreferredSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA 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 Substance

Summary

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Substance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance Substance
... code 1..1 CodeableConcept (QI) If this describes a specific package/container of the substance
Binding: SubstanceCode (preferred): Substance codes

... instance 0..* BackboneElement If this describes a specific package/container of the substance
.... quantity 0..1 SimpleQuantity (QI) Amount of substance in the package
... ingredient 0..* BackboneElement Composition information about the substance
.... quantity 0..1 Ratio (QI) Optional amount (concentration)
.... substance[x] 1..1 Reference(QICore Substance) (QI) A component of the substance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Substance.codepreferredSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity Σ 0..1 SimpleQuantity (QI) Amount of substance in the package
... ingredient Σ 0..* BackboneElement Composition information about the substance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity Σ 0..1 Ratio (QI) Optional amount (concentration)
.... substance[x] Σ 1..1 Reference(QICore Substance) (QI) A component of the substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.codepreferredSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA 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
.. Substance 0..* Substance A homogeneous material with a definite composition
... id Σ 0..1 id 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
... 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 Unique identifier
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

... category Σ 0..* CodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.


... code Σ 1..1 CodeableConcept (QI) If this describes a specific package/container of the substance
Binding: SubstanceCode (preferred): Substance codes

... description Σ 0..1 string Textual description of the substance, comments
... instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
.... 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
.... identifier Σ 0..1 Identifier Identifier of the package/container
.... expiry Σ 0..1 dateTime When no longer valid to use
.... quantity Σ 0..1 SimpleQuantity (QI) Amount of substance in the package
... ingredient Σ 0..* BackboneElement Composition information about the substance
.... 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
.... quantity Σ 0..1 Ratio (QI) Optional amount (concentration)
.... substance[x] Σ 1..1 Reference(QICore Substance) (QI) A component of the substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.categoryextensibleSubstanceCategoryCodes
http://hl7.org/fhir/ValueSet/substance-category
from the FHIR Standard
Substance.codepreferredSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA 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 Substance

Summary

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron