This page is part of the Quality Improvement Core Framework (v3.1.0: STU 3) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 7.0.1. For a full list of available versions, 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 AEST 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..* | 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 |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 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) |
| category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: Substance Category Codes (extensible) |
| code | SΣ | 1..1 | CodeableConcept | What substance this is Binding: Substance Code (example) |
| description | Σ | 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Identifier of the package/container |
| expiry | Σ | 0..1 | dateTime | When no longer valid to use |
 quantity | SΣ | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | ΣI | 0..* | BackboneElement | Composition information about the substance |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| quantity | SΣ | 0..1 | Ratio | Optional amount (concentration) |
 substanceReference | SΣ | 1..1 | Reference(QICore-Substance) | A component of the substance |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | I | 0..* | 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 |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 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) |
| category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: Substance Category Codes (extensible) |
| code | SΣ | 1..1 | CodeableConcept | What substance this is Binding: Substance Code (example) |
| description | Σ | 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Identifier of the package/container |
| expiry | Σ | 0..1 | dateTime | When no longer valid to use |
| quantity | SΣ | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | ΣI | 0..* | BackboneElement | Composition information about the substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| quantity | SΣ | 0..1 | Ratio | Optional amount (concentration) |
| substanceReference | SΣ | 1..1 | Reference(QICore-Substance) | A component of the substance |
| Documentation for this format | ||||
| Path | Name | Conformance | ValueSet |
| Substance.language | Common Languages | extensible | Common Languages |
| Substance.status | FHIRSubstanceStatus | required | FHIRSubstanceStatus |
| Substance.category | Substance Category Codes | extensible | Substance Category Codes |
| Substance.code | Substance Code | example | Substance Code |
| 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-1 | Substance | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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-3 | Substance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | Substance.instance | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Substance.ingredient | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
© HL7.org 2011+. QICore STU3 (v3.1.0) (for FHIR v3.0.1-11917) generated on Wed, Aug 22, 2018 23:31+1000. QA Page
Links: Search |
Table of Contents |
History |
|
Propose a change 