FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.20 Resource Substance - Content

Biomedical Research and Regulation icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: No defined compartments

A homogeneous material with a definite composition.

This is a base resource that represents raw materials used to represent a packaged or measured amount of a known substance (e.g. bottle, jar, packet, drum) that is not in a consumable form nor associated directly with a patient. For example, the materials used for a medication that are not yet in an administrable form.

The resource can be used to represent either a kind of a substance - e.g. a formulation commonly used for treating patients (a "definitional" use of Substance), or it can be used to describe a particular package of a known substance (an "instance" use of Substance).

The composition of the material can be specified in terms of a mix of other materials, including with precise amounts if required.

A Substance may be identifiable as precise as the specific container it is stored in, while more commonly it would be based on a combination of lot number, quantity, and package type.

A medication is a substance that is packaged and used as an administered medication. The medication resource uses the substance resource to represent the actual ingredients of a medication. This resource can represent an instance of a substance or a definition (type, kind) of one. See also the SubstanceDefinition resource, which is purely definitional.

A SubstanceDefinition describes the common characteristics of the substance, including those needed for regulatory agencies.

A NutritionProduct distinguishes from a Substance in that a nutrition product is primary consumable purpose is for its nutritional effect.

A BiologicallyDerivedProduct distinguishes from a Substance in that a BiologicallyDerivedProduct has its origins in a biological entity and needs to carry the source’s characteristics to enable matching and compatibility with the biological target to which it will be transfused or implanted, as well as traceability to the source.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Substance TU DomainResource A homogeneous material with a definite composition

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Unique identifier

... instance ?!Σ 1..1 boolean Is this an instance of a substance or a kind of one
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: FHIRSubstanceStatus (Required)
... code Σ 1..1 CodeableReference(SubstanceDefinition) What substance this is
Binding: Substance Code (Example)
... description Σ 0..1 markdown Textual description of the substance, comments
... expiry Σ 0..1 dateTime When no longer valid to use
... quantity Σ 0..1 SimpleQuantity Amount of substance in the package
... ingredient Σ 0..* BackboneElement Composition information about the substance

.... quantity Σ 0..1 Ratio Optional amount (concentration)
.... substance[x] Σ 1..1 A component of the substance
Binding: Substance Code (Example)
..... substanceCodeableConcept CodeableConcept
..... substanceReference Reference(Substance)

doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

Path ValueSet Type Documentation
Substance.status FHIRSubstanceStatus Required

A code to indicate if the substance is actively used.

Substance.category SubstanceCategoryCodes Extensible

Substance category codes

Substance.code SubstanceCode Example

This value set contains concept codes for specific substances. It includes codes from SNOMED icon where concept is-a 105590001 (Substance (substance))

Substance.ingredient.substance[x] SubstanceCode Example

This value set contains concept codes for specific substances. It includes codes from SNOMED icon where concept is-a 105590001 (Substance (substance))

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
category token The category of the substance Substance.category
code token The code of the substance or ingredient Substance.code.concept | (Substance.ingredient.substance.ofType(CodeableConcept))
code-reference reference A reference to the defining substance Substance.code.reference
expiry date Expiry date of package or container of substance Substance.expiry
identifier token Unique identifier for the substance Substance.identifier
quantity quantity Amount of substance in the package Substance.quantity
status token active | inactive | entered-in-error Substance.status
substance-reference reference A component of the substance (Substance.ingredient.substance.ofType(Reference))
(Substance)