Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablesubstance | Version: 2.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: CRMIPublishableSubstance | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.74 | ||||
Supports declaration of the substance metadata required by HL7 and other organizations that share and publish substances with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Conformance | ValueSet | URI |
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1From the FHIR Standard | |
| Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codeFrom the FHIR Standard | |
| Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codeFrom the FHIR Standard |
| 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 CRMISubstanceDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  Substance |
1..1 | CRMISubstanceDefinition | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:date |
S | 1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | ||||
| extension:contact |
S | 0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | ||||
| extension:useContext |
S | 0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | ||||
| extension:jurisdiction |
S | 0..* | CodeableConcept | Intended jurisdiction for artifact (if applicable) URL: http://hl7.org/fhir/StructureDefinition/artifact-jurisdiction Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| extension:purpose |
S | 0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | ||||
| extension:usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| extension:copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | ||||
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| extension:approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| extension:lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| extension:effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| extension:topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
 extension:relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
 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 |
SΣ | 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 | |||||
 extension:nonCanonicalReference |
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 | URI | |||
| Substance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1From the FHIR Standard | ||||
| Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-categoryFrom the FHIR Standard | ||||
| Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codeFrom the FHIR Standard | ||||
| Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codeFrom the FHIR Standard | ||||
| Substance.ingredient.substance[x]:substanceReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
| 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 CRMISubstanceDefinition
Summary
Mandatory: 1 element
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
| Path | Conformance | ValueSet | URI |
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1From the FHIR Standard | |
| Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codeFrom the FHIR Standard | |
| Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codeFrom the FHIR Standard |
| 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() |
Differential View
This structure is derived from CRMISubstanceDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Substance |
1..1 | CRMISubstanceDefinition | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:date |
S | 1..1 | dateTime | Date last changed URL: http://hl7.org/fhir/StructureDefinition/artifact-date | ||||
| extension:contact |
S | 0..* | ContactDetail | Contact details for the publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-contact | ||||
| extension:useContext |
S | 0..* | UsageContext | The context that the content is intended to support URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext | ||||
| extension:jurisdiction |
S | 0..* | CodeableConcept | Intended jurisdiction for artifact (if applicable) URL: http://hl7.org/fhir/StructureDefinition/artifact-jurisdiction Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| extension:purpose |
S | 0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose | ||||
| extension:usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| extension:copyright |
S | 0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright | ||||
| extension:copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| extension:approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| extension:lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| extension:effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| extension:topic |
S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| extension:author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| extension:editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| extension:reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| extension:endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| extension:relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| 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 |
SΣ | 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 | |||||
| extension:nonCanonicalReference |
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 | URI | |||
| Substance.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1From the FHIR Standard | ||||
| Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-categoryFrom the FHIR Standard | ||||
| Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codeFrom the FHIR Standard | ||||
| Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codeFrom the FHIR Standard | ||||
| Substance.ingredient.substance[x]:substanceReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
| 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 CRMISubstanceDefinition
Summary
Mandatory: 1 element
Must-Support: 19 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-08-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
