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 Publishable Substance

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablesubstance Version: 3.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

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: pub-1
Substance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Substance.meta.Slices for extension Content/Rules for all slices
Substance.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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 1..* 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:date This element must be supported. 1..1 dateTime Date last changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
Substance.Slices for extension.extension:contact This element must be supported. 0..* ContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
Substance.Slices for extension.extension:useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext
Substance.Slices for extension.extension:jurisdiction This element must be supported. 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.
Substance.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
Substance.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Substance.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Substance.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Substance.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Substance.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Substance.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Substance.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Substance.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Substance.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Substance.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Substance.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Substance.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Substance.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
Substance.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Substance.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Substance.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Substance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
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.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.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
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()
pub-1 error Substance If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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: pub-1
Substance.meta
Substance.meta.Slices for extension Content/Rules for all slices
Substance.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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:date This element must be supported. 1..1 dateTime Date last changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
Substance.Slices for extension.extension:contact This element must be supported. 0..* ContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
Substance.Slices for extension.extension:useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext
Substance.Slices for extension.extension:jurisdiction This element must be supported. 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.
Substance.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
Substance.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Substance.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Substance.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Substance.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Substance.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Substance.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Substance.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Substance.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Substance.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Substance.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Substance.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Substance.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Substance.Slices for extension.extension:relatedArtifact.value[x]
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Substance.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Substance.identifier This element must be supported. 0..* Identifier Unique identifier

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error Substance If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Substance C 1..1 CRMISubstanceDefinition A homogeneous material with a definite composition
Constraints: pub-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.meta.id 0..1 string Unique id for inter-element referencing
Substance.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Substance.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Substance.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Substance.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Substance.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Substance.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Substance.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Substance.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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 1..* 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:date This element must be supported. 1..1 dateTime Date last changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
Substance.Slices for extension.extension:contact This element must be supported. 0..* ContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
Substance.Slices for extension.extension:useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext
Substance.Slices for extension.extension:jurisdiction This element must be supported. 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.
Substance.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
Substance.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Substance.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Substance.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Substance.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Substance.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Substance.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Substance.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Substance.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Substance.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Substance.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Substance.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Substance.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Substance.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
Substance.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
Substance.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
Substance.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Substance.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Substance.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
Substance.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
Substance.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Substance.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
Substance.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
Substance.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
Substance.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Substance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
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 is included in summaries. 0..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.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Substance.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Substance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Substance.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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()
pub-1 error Substance If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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: pub-1
Substance.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Substance.meta.Slices for extension Content/Rules for all slices
Substance.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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 1..* 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:date This element must be supported. 1..1 dateTime Date last changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
Substance.Slices for extension.extension:contact This element must be supported. 0..* ContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
Substance.Slices for extension.extension:useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext
Substance.Slices for extension.extension:jurisdiction This element must be supported. 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.
Substance.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
Substance.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Substance.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Substance.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Substance.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Substance.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Substance.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Substance.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Substance.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Substance.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Substance.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Substance.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Substance.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Substance.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
Substance.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Substance.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Substance.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Substance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
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.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.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
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()
pub-1 error Substance If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').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: pub-1
Substance.meta
Substance.meta.Slices for extension Content/Rules for all slices
Substance.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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:date This element must be supported. 1..1 dateTime Date last changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
Substance.Slices for extension.extension:contact This element must be supported. 0..* ContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
Substance.Slices for extension.extension:useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext
Substance.Slices for extension.extension:jurisdiction This element must be supported. 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.
Substance.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
Substance.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Substance.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Substance.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Substance.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Substance.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Substance.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Substance.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Substance.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Substance.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Substance.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Substance.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Substance.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Substance.Slices for extension.extension:relatedArtifact.value[x]
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Substance.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Substance.identifier This element must be supported. 0..* Identifier Unique identifier
Substance.code This element must be supported. 1..1 CodeableConcept What substance this is

doco Documentation for this format

Constraints

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

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Substance C 1..1 CRMISubstanceDefinition A homogeneous material with a definite composition
Constraints: pub-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.meta.id 0..1 string Unique id for inter-element referencing
Substance.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Substance.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
Substance.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Substance.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Substance.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Substance.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Substance.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Substance.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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 1..* 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:date This element must be supported. 1..1 dateTime Date last changed
URL: http://hl7.org/fhir/StructureDefinition/artifact-date
Substance.Slices for extension.extension:contact This element must be supported. 0..* ContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-contact
Substance.Slices for extension.extension:useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext
Substance.Slices for extension.extension:jurisdiction This element must be supported. 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.
Substance.Slices for extension.extension:purpose This element must be supported. 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
Substance.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
Substance.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
Substance.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
Substance.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
Substance.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
Substance.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
Substance.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
Substance.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
Substance.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
Substance.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
Substance.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
Substance.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
Substance.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
Substance.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
Substance.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
Substance.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
Substance.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
Substance.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Substance.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
Substance.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
Substance.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
Substance.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
Substance.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
Substance.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
Substance.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
Substance.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
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 is included in summaries. 0..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.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Substance.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Substance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Substance.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍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()
pub-1 error Substance If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
sqty-1 error Substance.instance.quantity The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron