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

QI-Core Implementation Guide, published by http://www.hl7.org/Special/committees/cqi/index.cfm. This is not an authorized publication; it is the continuous build for version 5.0.0). 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: 5.0.0
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.

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 0..*SubstanceA homogeneous material with a definite composition
... code S1..1CodeableConceptWhat substance this is
Binding: SubstanceCode (preferred): Substance codes

... instance 0..*BackboneElementIf this describes a specific package/container of the substance
.... quantity S0..1SimpleQuantityAmount of substance in the package
... ingredient 0..*BackboneElementComposition information about the substance
.... quantity S0..1RatioOptional amount (concentration)
.... substance[x] S1..1Reference(QICore Substance)A component of the substance

doco Documentation for this format

Terminology Bindings (Differential)

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

... instance Σ0..*BackboneElementIf this describes a specific package/container of the substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... quantity SΣ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... quantity SΣ0..1RatioOptional amount (concentration)
.... substance[x] SΣ1..1Reference(QICore Substance)A component of the substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Substance.statusrequiredFHIRSubstanceStatus
Substance.codepreferredSubstanceCode

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..*SubstanceA homogeneous material with a definite composition
... 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..*IdentifierUnique identifier
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

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


... code SΣ1..1CodeableConceptWhat substance this is
Binding: SubstanceCode (preferred): Substance codes

... description Σ0..1stringTextual description of the substance, comments
... instance Σ0..*BackboneElementIf this describes a specific package/container of the substance
.... 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
.... identifier Σ0..1IdentifierIdentifier of the package/container
.... expiry Σ0..1dateTimeWhen no longer valid to use
.... quantity SΣ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... 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
.... quantity SΣ0..1RatioOptional amount (concentration)
.... substance[x] SΣ1..1Reference(QICore Substance)A component of the substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Substance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Substance.statusrequiredFHIRSubstanceStatus
Substance.categoryextensibleSubstanceCategoryCodes
Substance.codepreferredSubstanceCode

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()

This structure is derived from Substance

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Substance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..*SubstanceA homogeneous material with a definite composition
... code S1..1CodeableConceptWhat substance this is
Binding: SubstanceCode (preferred): Substance codes

... instance 0..*BackboneElementIf this describes a specific package/container of the substance
.... quantity S0..1SimpleQuantityAmount of substance in the package
... ingredient 0..*BackboneElementComposition information about the substance
.... quantity S0..1RatioOptional amount (concentration)
.... substance[x] S1..1Reference(QICore Substance)A component of the substance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Substance.codepreferredSubstanceCode

Key Elements View

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

... instance Σ0..*BackboneElementIf this describes a specific package/container of the substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... quantity SΣ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... quantity SΣ0..1RatioOptional amount (concentration)
.... substance[x] SΣ1..1Reference(QICore Substance)A component of the substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Substance.statusrequiredFHIRSubstanceStatus
Substance.codepreferredSubstanceCode

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..*SubstanceA homogeneous material with a definite composition
... 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..*IdentifierUnique identifier
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.

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


... code SΣ1..1CodeableConceptWhat substance this is
Binding: SubstanceCode (preferred): Substance codes

... description Σ0..1stringTextual description of the substance, comments
... instance Σ0..*BackboneElementIf this describes a specific package/container of the substance
.... 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
.... identifier Σ0..1IdentifierIdentifier of the package/container
.... expiry Σ0..1dateTimeWhen no longer valid to use
.... quantity SΣ0..1SimpleQuantityAmount of substance in the package
... ingredient Σ0..*BackboneElementComposition information about the substance
.... 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
.... quantity SΣ0..1RatioOptional amount (concentration)
.... substance[x] SΣ1..1Reference(QICore Substance)A component of the substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Substance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Substance.statusrequiredFHIRSubstanceStatus
Substance.categoryextensibleSubstanceCategoryCodes
Substance.codepreferredSubstanceCode

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()

This structure is derived from Substance

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron