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
| 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
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | CRMISubstanceDefinition | A homogeneous material with a definite composition Constraints: shr-1 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |
![]() ![]() ![]() |
1..1 | uri | Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |
![]() ![]() ![]() |
1..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version | |
![]() ![]() ![]() |
0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact | |
![]() ![]() ![]() |
0..1 | url | web-source URL: http://hl7.org/fhir/StructureDefinition/web-source | |
![]() ![]() ![]() |
0..1 | string | Name for this artifact (computer friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-name | |
![]() ![]() ![]() |
1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
![]() ![]() ![]() |
0..1 | boolean | For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental | |
![]() ![]() ![]() |
0..1 | string | Name of the publisher/steward (organization or individual) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
![]() ![]() |
0..* | Identifier | Unique identifier | |
![]() ![]() |
0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | |
![]() ![]() |
1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. | |
![]() ![]() |
1..1 | string | Textual description of the substance, comments | |
![]() ![]() |
0..* | BackboneElement | Composition information about the substance | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
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 | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||
![]() ![]() ![]() ![]() |
0..1 | Reference(Substance) | A component of the substance | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
Documentation for this format | ||||
| 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. |
| 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
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 1..1 | CRMISubstanceDefinition | A homogeneous material with a definite composition Constraints: shr-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |||||
![]() ![]() ![]() |
1..1 | uri | Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |||||
![]() ![]() ![]() |
1..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version | |||||
![]() ![]() ![]() |
0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact | |||||
![]() ![]() ![]() |
0..1 | url | web-source URL: http://hl7.org/fhir/StructureDefinition/web-source | |||||
![]() ![]() ![]() |
0..1 | string | Name for this artifact (computer friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-name | |||||
![]() ![]() ![]() |
1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |||||
![]() ![]() ![]() |
0..1 | boolean | For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental | |||||
![]() ![]() ![]() |
0..1 | string | Name of the publisher/steward (organization or individual) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
![]() ![]() |
0..* | Identifier | Unique identifier | |||||
![]() ![]() |
0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | |||||
![]() ![]() |
0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | |||||
![]() ![]() |
1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. | |||||
![]() ![]() |
1..1 | string | Textual description of the substance, comments | |||||
![]() ![]() |
0..* | BackboneElement | If this describes a specific package/container of the substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Identifier | Identifier of the package/container | |||||
![]() ![]() ![]() |
0..1 | dateTime | When no longer valid to use | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of substance in the package Constraints: sqty-1 | ||||
![]() ![]() |
0..* | BackboneElement | Composition information about the substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Ratio | Optional amount (concentration) | |||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Substance) | A component of the substance | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
Documentation for this format | ||||||||
| 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. |
| 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()
|
This structure is derived from CRMISubstanceDefinition
Summary
Mandatory: 5 elements
Must-Support: 13 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 1..1 | CRMISubstanceDefinition | A homogeneous material with a definite composition Constraints: shr-1 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |
![]() ![]() ![]() |
1..1 | uri | Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |
![]() ![]() ![]() |
1..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version | |
![]() ![]() ![]() |
0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact | |
![]() ![]() ![]() |
0..1 | url | web-source URL: http://hl7.org/fhir/StructureDefinition/web-source | |
![]() ![]() ![]() |
0..1 | string | Name for this artifact (computer friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-name | |
![]() ![]() ![]() |
1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |
![]() ![]() ![]() |
0..1 | boolean | For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental | |
![]() ![]() ![]() |
0..1 | string | Name of the publisher/steward (organization or individual) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
![]() ![]() |
0..* | Identifier | Unique identifier | |
![]() ![]() |
0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | |
![]() ![]() |
1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. | |
![]() ![]() |
1..1 | string | Textual description of the substance, comments | |
![]() ![]() |
0..* | BackboneElement | Composition information about the substance | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
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 | ||
![]() ![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||
![]() ![]() ![]() ![]() |
0..1 | Reference(Substance) | A component of the substance | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |
Documentation for this format | ||||
| 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. |
| 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
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 1..1 | CRMISubstanceDefinition | A homogeneous material with a definite composition Constraints: shr-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
![]() ![]() ![]() |
0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | |||||
![]() ![]() ![]() |
1..1 | uri | Canonical identifier for this artifact, represented as a URI (globally unique) URL: http://hl7.org/fhir/StructureDefinition/artifact-url | |||||
![]() ![]() ![]() |
1..1 | string | Business version of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-version | |||||
![]() ![]() ![]() |
0..1 | Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact | |||||
![]() ![]() ![]() |
0..1 | url | web-source URL: http://hl7.org/fhir/StructureDefinition/web-source | |||||
![]() ![]() ![]() |
0..1 | string | Name for this artifact (computer friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-name | |||||
![]() ![]() ![]() |
1..1 | string | Name for this artifact (human friendly) URL: http://hl7.org/fhir/StructureDefinition/artifact-title | |||||
![]() ![]() ![]() |
0..1 | boolean | For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental | |||||
![]() ![]() ![]() |
0..1 | string | Name of the publisher/steward (organization or individual) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | code | draft | active | retired | unknown URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
![]() ![]() |
0..* | Identifier | Unique identifier | |||||
![]() ![]() |
0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | |||||
![]() ![]() |
0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | |||||
![]() ![]() |
1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. | |||||
![]() ![]() |
1..1 | string | Textual description of the substance, comments | |||||
![]() ![]() |
0..* | BackboneElement | If this describes a specific package/container of the substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Identifier | Identifier of the package/container | |||||
![]() ![]() ![]() |
0..1 | dateTime | When no longer valid to use | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of substance in the package Constraints: sqty-1 | ||||
![]() ![]() |
0..* | BackboneElement | Composition information about the substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Ratio | Optional amount (concentration) | |||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Substance) | A component of the substance | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | The artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
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). | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
Documentation for this format | ||||||||
| 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. |
| 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()
|
This structure is derived from CRMISubstanceDefinition
Summary
Mandatory: 5 elements
Must-Support: 13 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron