R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

8.17.6 Resource Substance - Detailed Descriptions

Orders and Observations Work GroupMaturity Level: 2 Trial Use 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.

Control1..1
Substance.identifier
Element IdSubstance.identifier
Definition

Unique identifier for the substance.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
Comments

This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.

Substance.status
Element IdSubstance.status
Definition

A code to indicate if the substance is actively used.

Control0..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.

Control0..*
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.

Control1..1
Terminology BindingSubstance Code (Example)
TypeCodeableConcept
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.

Control0..1
Typestring
Summarytrue
Substance.instance
Element IdSubstance.instance
Definition

Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.

Control0..*
Meaning if MissingIf this element is not present, then the substance resource describes a kind of substance
Summarytrue
Substance.instance.identifier
Element IdSubstance.instance.identifier
Definition

Identifier associated with the package/container (usually a label affixed directly).

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
Substance.instance.expiry
Element IdSubstance.instance.expiry
Definition

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

Control0..1
TypedateTime
Summarytrue
Substance.instance.quantity
Element IdSubstance.instance.quantity
Definition

The amount of the substance.

Control0..1
TypeSimpleQuantity
Summarytrue
Substance.ingredient
Element IdSubstance.ingredient
Definition

A substance can be composed of other substances.

Control0..*
Summarytrue
Substance.ingredient.quantity
Element IdSubstance.ingredient.quantity
Definition

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

Control0..1
TypeRatio
Summarytrue
Substance.ingredient.substance[x]
Element IdSubstance.ingredient.substance[x]
Definition

Another substance that is a component of this substance.

Control1..1
Terminology BindingSubstance Code (Example)
TypeCodeableConcept|Reference(Substance)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue