Canonical Resource Management Infrastructure Implementation Guide
1.1.0-cibuild - cibuild International flag

Canonical Resource 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 1.1.0-cibuild 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 SubstanceDefinition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-substancedefinition Version: 1.1.0-cibuild
Standards status: Trial-use Maturity Level: 1 Computable Name: CRMISubstanceDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.12

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

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance 0..* Substance A homogeneous material with a definite composition
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... artifactUrl S 0..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... artifactVersion S 0..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used.


ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept What substance this is
Binding: SubstanceCode (example): Substance codes.


ele-1: All FHIR elements must have a @value or children
... ingredient SΣ 0..* BackboneElement Composition information about the substance
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... Slices for substance[x] SΣ 1..1 A component of the substance
Slice: Unordered, Open by type:$this
Binding: SubstanceCode (example): Substance Ingredient codes.


ele-1: All FHIR elements must have a @value or children
..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)
..... substance[x]:substanceReference Σ 0..1 Reference(Substance) A component of the substance
ele-1: All FHIR elements must have a @value or children
...... Slices for extension Content/Rules for all slices
....... artifactReference S 0..1 (Complex) The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
........ extension 0..0
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-reference"
........ value[x] 1..1 uri Value of extension
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Substance.statusrequiredFHIRSubstanceStatus
http://hl7.org/fhir/ValueSet/substance-status|4.0.1
from the FHIR Standard
Substance.codeexampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard
Substance.ingredient.substance[x]exampleSubstanceCode
http://hl7.org/fhir/ValueSet/substance-code
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSubstanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceIf 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-4errorSubstanceIf 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-5errorSubstanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron