Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot2 - Ballot
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot2: STU1 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-substancedefinition | Version: 1.0.0-ballot2 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: CRMISubstanceDefinition | ||
Represents the definition of a substance, suitable for use in various contexts
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Substance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Substance | 0..* | Substance | A homogeneous material with a definite composition | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 artifactUrl | S | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url |
| artifactVersion | S | 0..1 | string | Business version of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-version |
 identifier | S | 0..* | Identifier | Unique identifier |
| code | S | 1..1 | CodeableConcept | What substance this is |
 ingredient | S | 0..* | BackboneElement | Composition information about the substance |
  Slices for substance[x] | S | 1..1 | CodeableConcept, Reference(Substance) | A component of the substance Slice: Unordered, Open by type:$this |
 substance[x]:substanceReference | 0..1 | Reference(Substance) | A component of the substance | |
 artifactReference | S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| artifactUrl | S | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url |
| artifactVersion | S | 0..1 | string | Business version of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-version |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 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. |
| code | SΣ | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. |
| ingredient | SΣ | 0..* | BackboneElement | Composition information about the substance |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for substance[x] | SΣ | 1..1 | A component of the substance Slice: Unordered, Open by type:$this Binding: SubstanceCode (example): Substance Ingredient codes. | |
 substanceCodeableConcept | CodeableConcept | |||
 substanceReference | Reference(Substance) | |||
| substance[x]:substanceReference | Σ | 0..1 | Reference(Substance) | A component of the substance |
| artifactReference | S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.code | example | SubstanceCode |
| Substance.ingredient.substance[x] | example | SubstanceCode |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| artifactUrl | S | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | ||||
| artifactVersion | S | 0..1 | string | Business version of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-version | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 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 | SΣ | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): 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 | Amount of substance in the package | ||||
| ingredient | SΣ | 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 | Optional amount (concentration) | ||||
| Slices for substance[x] | SΣ | 1..1 | A component of the substance Slice: Unordered, Open by type:$this Binding: SubstanceCode (example): Substance Ingredient codes. | |||||
| substanceCodeableConcept | CodeableConcept | |||||||
| substanceReference | Reference(Substance) | |||||||
| substance[x]:substanceReference | Σ | 0..1 | Reference(Substance) | A component of the substance | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| artifactReference | S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | ||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Substance.language | preferred | CommonLanguages
| ||||
| Substance.status | required | FHIRSubstanceStatus | ||||
| Substance.category | extensible | SubstanceCategoryCodes | ||||
| Substance.code | example | SubstanceCode | ||||
| Substance.ingredient.substance[x] | example | SubstanceCode | ||||
| Substance.ingredient.substance[x]:substanceReference.type | extensible | ResourceType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Substance
Summary
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from Substance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| artifactUrl | S | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url |
| artifactVersion | S | 0..1 | string | Business version of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-version |
| identifier | S | 0..* | Identifier | Unique identifier |
| code | S | 1..1 | CodeableConcept | What substance this is |
| ingredient | S | 0..* | BackboneElement | Composition information about the substance |
| Slices for substance[x] | S | 1..1 | CodeableConcept, Reference(Substance) | A component of the substance Slice: Unordered, Open by type:$this |
| substance[x]:substanceReference | 0..1 | Reference(Substance) | A component of the substance | |
| artifactReference | S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| artifactUrl | S | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url |
| artifactVersion | S | 0..1 | string | Business version of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-version |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 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. |
| code | SΣ | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. |
| ingredient | SΣ | 0..* | BackboneElement | Composition information about the substance |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for substance[x] | SΣ | 1..1 | A component of the substance Slice: Unordered, Open by type:$this Binding: SubstanceCode (example): Substance Ingredient codes. | |
| substanceCodeableConcept | CodeableConcept | |||
| substanceReference | Reference(Substance) | |||
| substance[x]:substanceReference | Σ | 0..1 | Reference(Substance) | A component of the substance |
| artifactReference | S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.code | example | SubstanceCode |
| Substance.ingredient.substance[x] | example | SubstanceCode |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| artifactUrl | S | 0..1 | uri | Canonical identifier for this {{title}}, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | ||||
| artifactVersion | S | 0..1 | string | Business version of the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-version | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 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 | SΣ | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): 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 | Amount of substance in the package | ||||
| ingredient | SΣ | 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 | Optional amount (concentration) | ||||
| Slices for substance[x] | SΣ | 1..1 | A component of the substance Slice: Unordered, Open by type:$this Binding: SubstanceCode (example): Substance Ingredient codes. | |||||
| substanceCodeableConcept | CodeableConcept | |||||||
| substanceReference | Reference(Substance) | |||||||
| substance[x]:substanceReference | Σ | 0..1 | Reference(Substance) | A component of the substance | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| artifactReference | S | 0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | ||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Substance.language | preferred | CommonLanguages
| ||||
| Substance.status | required | FHIRSubstanceStatus | ||||
| Substance.category | extensible | SubstanceCategoryCodes | ||||
| Substance.code | example | SubstanceCode | ||||
| Substance.ingredient.substance[x] | example | SubstanceCode | ||||
| Substance.ingredient.substance[x]:substanceReference.type | extensible | ResourceType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Substance
Summary
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#1.0.0-ballot2 based on FHIR 4.0.1. Generated 2023-12-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change