Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Shareable Substance

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablesubstance Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: CRMIShareableSubstance
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.79

Enforces the minimum information set for the substance metadata required by HL7 and other organizations that share and publish substances

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Substance C 1..1 CRMISubstanceDefinition A homogeneous material with a definite composition
Constraints: shr-1
Substance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Substance.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Substance.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Substance.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Substance.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Substance.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Substance.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Substance.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Substance.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Substance.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Substance.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Substance.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Substance.Slices for modifierExtension This element is a modifier element. 1..* Extension Extension
Slice: Unordered, Open by value:url
Substance.Slices for modifierExtension.modifierExtension:status This element is a modifier element. This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Substance.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique identifier
Substance.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
Substance.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What substance this is
Binding: SubstanceCode (example): Substance codes.
Substance.description This element must be supported. This element is included in summaries. 1..1 string Textual description of the substance, comments
Substance.ingredient This element must be supported. This element is included in summaries. 0..* BackboneElement Composition information about the substance
Substance.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Substance.ingredient.Slices for substance[x] This element must be supported. This element is included in summaries. 1..1 A component of the substance
Slice: Unordered, Closed by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Substance.ingredient.Slices for substance[x].substanceCodeableConcept CodeableConcept
Substance.ingredient.Slices for substance[x].substanceReference Reference(Substance)
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference This element must be supported. This element is included in summaries. 0..1 Reference(Substance) A component of the substance
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension Content/Rules for all slices
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension.extension:nonCanonicalReference This element must be supported. 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.status Base required FHIRSubstanceStatus 📍4.0.1 FHIR Std.
Substance.code Base example Substance Code 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x] Base example Substance Code 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x]:substanceCodeableConcept Base example Substance Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
shr-1 error Substance If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

This structure is derived from CRMISubstanceDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Substance C 1..1 CRMISubstanceDefinition A homogeneous material with a definite composition
Constraints: shr-1
Substance.Slices for extension Content/Rules for all slices
Substance.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Substance.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Substance.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Substance.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Substance.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Substance.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Substance.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Substance.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Substance.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Substance.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Substance.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Substance.Slices for modifierExtension Content/Rules for all slices
Substance.Slices for modifierExtension.modifierExtension:status This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Substance.description This element must be supported. 1..1 string Textual description of the substance, comments

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error Substance If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Substance C 1..1 CRMISubstanceDefinition A homogeneous material with a definite composition
Constraints: shr-1
Substance.id This element is included in summaries. 0..1 id Logical id of this artifact
Substance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Substance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Substance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Substance.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
Substance.contained 0..* Resource Contained, inline Resources
Substance.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Substance.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Substance.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Substance.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Substance.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Substance.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Substance.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Substance.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Substance.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Substance.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Substance.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Substance.Slices for modifierExtension This element is a modifier element. 1..* Extension Extension
Slice: Unordered, Open by value:url
Substance.Slices for modifierExtension.modifierExtension:status This element is a modifier element. This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Substance.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique identifier
Substance.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
Substance.category This element is included in summaries. 0..* CodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
Substance.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What substance this is
Binding: SubstanceCode (example): Substance codes.
Substance.description This element must be supported. This element is included in summaries. 1..1 string Textual description of the substance, comments
Substance.instance This element is included in summaries. 0..* BackboneElement If this describes a specific package/container of the substance
Substance.instance.id 0..1 string Unique id for inter-element referencing
Substance.instance.extension 0..* Extension Additional content defined by implementations
Substance.instance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Substance.instance.identifier This element is included in summaries. 0..1 Identifier Identifier of the package/container
Substance.instance.expiry This element is included in summaries. 0..1 dateTime When no longer valid to use
Substance.instance.quantity This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Amount of substance in the package
Constraints: sqty-1
Substance.ingredient This element must be supported. This element is included in summaries. 0..* BackboneElement Composition information about the substance
Substance.ingredient.id 0..1 string Unique id for inter-element referencing
Substance.ingredient.extension 0..* Extension Additional content defined by implementations
Substance.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Substance.ingredient.quantity This element is included in summaries. 0..1 Ratio Optional amount (concentration)
Substance.ingredient.Slices for substance[x] This element must be supported. This element is included in summaries. 1..1 A component of the substance
Slice: Unordered, Closed by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Substance.ingredient.Slices for substance[x].substanceCodeableConcept CodeableConcept
Substance.ingredient.Slices for substance[x].substanceReference Reference(Substance)
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference This element must be supported. This element is included in summaries. 0..1 Reference(Substance) A component of the substance
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.id 0..1 string Unique id for inter-element referencing
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension Content/Rules for all slices
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension.extension:nonCanonicalReference This element must be supported. 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.type This element is included in summaries. 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).
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.display This element is included in summaries. 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Substance.status Base required FHIRSubstanceStatus 📍4.0.1 FHIR Std.
Substance.category Base extensible Substance Category Codes 📍4.0.1 FHIR Std.
Substance.code Base example Substance Code 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x] Base example Substance Code 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x]:substanceReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x]:substanceCodeableConcept Base example Substance Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
shr-1 error Substance If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
sqty-1 error Substance.instance.quantity The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Substance C 1..1 CRMISubstanceDefinition A homogeneous material with a definite composition
Constraints: shr-1
Substance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Substance.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Substance.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Substance.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Substance.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Substance.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Substance.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Substance.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Substance.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Substance.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Substance.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Substance.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Substance.Slices for modifierExtension This element is a modifier element. 1..* Extension Extension
Slice: Unordered, Open by value:url
Substance.Slices for modifierExtension.modifierExtension:status This element is a modifier element. This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Substance.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique identifier
Substance.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
Substance.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What substance this is
Binding: SubstanceCode (example): Substance codes.
Substance.description This element must be supported. This element is included in summaries. 1..1 string Textual description of the substance, comments
Substance.ingredient This element must be supported. This element is included in summaries. 0..* BackboneElement Composition information about the substance
Substance.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Substance.ingredient.Slices for substance[x] This element must be supported. This element is included in summaries. 1..1 A component of the substance
Slice: Unordered, Closed by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Substance.ingredient.Slices for substance[x].substanceCodeableConcept CodeableConcept
Substance.ingredient.Slices for substance[x].substanceReference Reference(Substance)
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference This element must be supported. This element is included in summaries. 0..1 Reference(Substance) A component of the substance
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension Content/Rules for all slices
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension.extension:nonCanonicalReference This element must be supported. 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.status Base required FHIRSubstanceStatus 📍4.0.1 FHIR Std.
Substance.code Base example Substance Code 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x] Base example Substance Code 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x]:substanceCodeableConcept Base example Substance Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
shr-1 error Substance If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Differential View

This structure is derived from CRMISubstanceDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Substance C 1..1 CRMISubstanceDefinition A homogeneous material with a definite composition
Constraints: shr-1
Substance.Slices for extension Content/Rules for all slices
Substance.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Substance.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Substance.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Substance.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Substance.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Substance.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Substance.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Substance.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Substance.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Substance.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Substance.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Substance.Slices for modifierExtension Content/Rules for all slices
Substance.Slices for modifierExtension.modifierExtension:status This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Substance.description This element must be supported. 1..1 string Textual description of the substance, comments

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error Substance If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Substance C 1..1 CRMISubstanceDefinition A homogeneous material with a definite composition
Constraints: shr-1
Substance.id This element is included in summaries. 0..1 id Logical id of this artifact
Substance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Substance.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Substance.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Substance.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
Substance.contained 0..* Resource Contained, inline Resources
Substance.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Substance.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Substance.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Substance.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Substance.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Substance.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Substance.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Substance.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Substance.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Substance.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Substance.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Substance.Slices for modifierExtension This element is a modifier element. 1..* Extension Extension
Slice: Unordered, Open by value:url
Substance.Slices for modifierExtension.modifierExtension:status This element is a modifier element. This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Substance.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique identifier
Substance.status This element is a modifier element. This element is included in summaries. 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.
Substance.category This element is included in summaries. 0..* CodeableConcept What class/type of substance this is
Binding: SubstanceCategoryCodes (extensible): Category or classification of substance.
Substance.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept What substance this is
Binding: SubstanceCode (example): Substance codes.
Substance.description This element must be supported. This element is included in summaries. 1..1 string Textual description of the substance, comments
Substance.instance This element is included in summaries. 0..* BackboneElement If this describes a specific package/container of the substance
Substance.instance.id 0..1 string Unique id for inter-element referencing
Substance.instance.extension 0..* Extension Additional content defined by implementations
Substance.instance.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Substance.instance.identifier This element is included in summaries. 0..1 Identifier Identifier of the package/container
Substance.instance.expiry This element is included in summaries. 0..1 dateTime When no longer valid to use
Substance.instance.quantity This element is included in summaries. C 0..1 SimpleQuantity(4.0.1) Amount of substance in the package
Constraints: sqty-1
Substance.ingredient This element must be supported. This element is included in summaries. 0..* BackboneElement Composition information about the substance
Substance.ingredient.id 0..1 string Unique id for inter-element referencing
Substance.ingredient.extension 0..* Extension Additional content defined by implementations
Substance.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Substance.ingredient.quantity This element is included in summaries. 0..1 Ratio Optional amount (concentration)
Substance.ingredient.Slices for substance[x] This element must be supported. This element is included in summaries. 1..1 A component of the substance
Slice: Unordered, Closed by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Substance.ingredient.Slices for substance[x].substanceCodeableConcept CodeableConcept
Substance.ingredient.Slices for substance[x].substanceReference Reference(Substance)
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference This element must be supported. This element is included in summaries. 0..1 Reference(Substance) A component of the substance
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.id 0..1 string Unique id for inter-element referencing
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension Content/Rules for all slices
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.Slices for extension.extension:nonCanonicalReference This element must be supported. 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.type This element is included in summaries. 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).
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Substance.ingredient.Slices for substance[x].substance[x]:substanceReference.display This element is included in summaries. 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Substance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Substance.status Base required FHIRSubstanceStatus 📍4.0.1 FHIR Std.
Substance.category Base extensible Substance Category Codes 📍4.0.1 FHIR Std.
Substance.code Base example Substance Code 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x] Base example Substance Code 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x]:substanceReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Substance.ingredient.​substance[x]:substanceCodeableConcept Base example Substance Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
shr-1 error Substance If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
sqty-1 error Substance.instance.quantity The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron