This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: CRMI SubstanceDefinition

Represents the definition of a substance, suitable for use in various contexts

Usage:

• Examples for this Resource Profile: Substance/artifact-reference-example

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
artifactVersion	S	0..1	string	Business version of the artifact 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
Slices for extension				Content/Rules for all slices
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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
artifactVersion	S	0..1	string	Business version of the artifact 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
Slices for extension				Content/Rules for all slices
artifactReference	S	0..1	uri	The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Substance.status	required	FHIRSubstanceStatus http://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard
Substance.code	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
Substance.ingredient.substance[x]	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard

Constraints

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. Additional Bindings Purpose AllLanguages Max Binding
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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
artifactVersion	S	0..1	string	Business version of the artifact 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

Terminology Bindings

Path	Conformance	ValueSet	URI
Substance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Substance.status	required	FHIRSubstanceStatus http://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard
Substance.category	extensible	SubstanceCategoryCodes http://hl7.org/fhir/ValueSet/substance-category from the FHIR Standard
Substance.code	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
Substance.ingredient.substance[x]	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
Substance.ingredient.substance[x]:substanceReference.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

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:

• http://hl7.org/fhir/StructureDefinition/artifact-url
• http://hl7.org/fhir/StructureDefinition/artifact-version
• http://hl7.org/fhir/StructureDefinition/artifact-uriReference

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Substance.ingredient.substance[x]

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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
artifactVersion	S	0..1	string	Business version of the artifact 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
Slices for extension				Content/Rules for all slices
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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
artifactVersion	S	0..1	string	Business version of the artifact 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
Slices for extension				Content/Rules for all slices
artifactReference	S	0..1	uri	The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Substance.status	required	FHIRSubstanceStatus http://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard
Substance.code	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
Substance.ingredient.substance[x]	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard

Constraints

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. Additional Bindings Purpose AllLanguages Max Binding
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 artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url
artifactVersion	S	0..1	string	Business version of the artifact 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

Terminology Bindings

Path	Conformance	ValueSet	URI
Substance.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Substance.status	required	FHIRSubstanceStatus http://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard
Substance.category	extensible	SubstanceCategoryCodes http://hl7.org/fhir/ValueSet/substance-category from the FHIR Standard
Substance.code	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
Substance.ingredient.substance[x]	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
Substance.ingredient.substance[x]:substanceReference.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

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:

• http://hl7.org/fhir/StructureDefinition/artifact-url
• http://hl7.org/fhir/StructureDefinition/artifact-version
• http://hl7.org/fhir/StructureDefinition/artifact-uriReference

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Substance.ingredient.substance[x]

Maturity: 1

Other representations of profile: CSV, Excel, Schematron