QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)
QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions
| Honey Bee venom (apitoxin) Example |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-substance
Profile of Substance for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
This profile builds on Substance.
This profile was published on Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Substance | I | 0..* | Substance | A homogeneous material with a definite composition |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Unique identifier |
| status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required) |
| category | ΣI | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible) |
| code | SΣI | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example) |
| description | ΣI | 0..1 | string | Textual description of the substance, comments |
| instance | ΣI | 0..* | BackboneElement | If this describes a specific package/container of the substance |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier | ΣI | 0..1 | Identifier | Identifier of the package/container |
| expiry | ΣI | 0..1 | dateTime | When no longer valid to use |
 quantity | SΣI | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | ΣI | 0..* | BackboneElement | Composition information about the substance |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| quantity | SΣI | 0..1 | Ratio | Optional amount (concentration) |
 substance[x] | SΣI | 1..1 | Reference(QICoreSubstance) | A component of the substance |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | I | 0..* | Substance | A homogeneous material with a definite composition |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Unique identifier |
| status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required) |
| category | ΣI | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible) |
| code | SΣI | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example) |
| description | ΣI | 0..1 | string | Textual description of the substance, comments |
| instance | ΣI | 0..* | BackboneElement | If this describes a specific package/container of the substance |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| identifier | ΣI | 0..1 | Identifier | Identifier of the package/container |
| expiry | ΣI | 0..1 | dateTime | When no longer valid to use |
| quantity | SΣI | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | ΣI | 0..* | BackboneElement | Composition information about the substance |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| quantity | SΣI | 0..1 | Ratio | Optional amount (concentration) |
| substance[x] | SΣI | 1..1 | Reference(QICoreSubstance) | A component of the substance |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.category | extensible | SubstanceCategoryCodes |
| Substance.code | example | SubstanceCode |
| Id | Path | Details | Requirements |
| dom-2 | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Substance | 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 | Substance | 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 | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Substance.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.instance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.instance.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.instance.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.instance.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.instance.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.instance.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.instance.expiry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.instance.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.ingredient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.ingredient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.ingredient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.ingredient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Substance.ingredient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Substance.ingredient.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Substance.ingredient.substance[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2011+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#4.0.0 based on FHIR v4.0.1 Generated 2020-03-24.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 
