FHIR CI-Build

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

Biomedical Research and Regulation icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the Substance resource.

Substance
Element IdSubstance
Definition

A homogeneous material with a definite composition.

Short DisplayA homogeneous material with a definite composition
Cardinality0..*
TypeDomainResource
Summaryfalse
Substance.identifier
Element IdSubstance.identifier
Definition

Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).

Short DisplayUnique identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
Substance.instance
Element IdSubstance.instance
Definition

A boolean to indicate if this an instance of a substance or a kind of one (a definition).

Short DisplayIs this an instance of a substance or a kind of one
Cardinality1..1
Typeboolean
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
Summarytrue
Substance.status
Element IdSubstance.status
Definition

A code to indicate if the substance is actively used.

Short Displayactive | inactive | entered-in-error
Cardinality0..1
Terminology BindingFHIRSubstanceStatus (Required)
Typecode
Is Modifiertrue (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summarytrue
Substance.category
Element IdSubstance.category
Definition

A code that classifies the general type of substance. This is used for searching, sorting and display purposes.

Short DisplayWhat class/type of substance this is
Cardinality0..*
Terminology BindingSubstance Category Codes (Extensible)
TypeCodeableConcept
Summarytrue
Comments

The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code.

Substance.code
Element IdSubstance.code
Definition

A code (or set of codes) that identify this substance.

Short DisplayWhat substance this is
Cardinality1..1
Terminology BindingSubstance Code (Example)
TypeCodeableReference(SubstanceDefinition)
Summarytrue
Comments

This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.

Substance.description
Element IdSubstance.description
Definition

A description of the substance - its appearance, handling requirements, and other usage notes.

Short DisplayTextual description of the substance, comments
Cardinality0..1
Typestring
Summarytrue
Substance.expiry
Element IdSubstance.expiry
Definition

When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.

Short DisplayWhen no longer valid to use
Cardinality0..1
TypedateTime
Summarytrue
Substance.quantity
Element IdSubstance.quantity
Definition

The amount of the substance.

Short DisplayAmount of substance in the package
Cardinality0..1
TypeSimpleQuantity
Summarytrue
Substance.ingredient
Element IdSubstance.ingredient
Definition

A substance can be composed of other substances.

Short DisplayComposition information about the substance
Cardinality0..*
Summarytrue
Substance.ingredient.quantity
Element IdSubstance.ingredient.quantity
Definition

The amount of the ingredient in the substance - a concentration ratio.

Short DisplayOptional amount (concentration)
Cardinality0..1
TypeRatio
Summarytrue
Substance.ingredient.substance[x]
Element IdSubstance.ingredient.substance[x]
Definition

Another substance that is a component of this substance.

Short DisplayA component of the substance
Cardinality1..1
Terminology BindingSubstance Code (Example)
TypeCodeableConcept|Reference(Substance)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue