This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). 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
Orders and Observations Work Group | Maturity Level: 2 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the Substance resource.
Substance | |
Element Id | Substance |
Definition | A homogeneous material with a definite composition. |
Cardinality | 0..* |
Type | DomainResource |
Substance.identifier | |
Element Id | Substance.identifier |
Definition | Unique identifier for the substance. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Summary | true |
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 Id | Substance.status |
Definition | A code to indicate if the substance is actively used. |
Cardinality | 0..1 |
Terminology Binding | FHIRSubstanceStatus (Required) |
Type | code |
Is Modifier | true (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) |
Summary | true |
Substance.category | |
Element Id | Substance.category |
Definition | A code that classifies the general type of substance. This is used for searching, sorting and display purposes. |
Cardinality | 0..* |
Terminology Binding | Substance Category Codes (Extensible) |
Type | CodeableConcept |
Summary | true |
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 Id | Substance.code |
Definition | A code (or set of codes) that identify this substance. |
Cardinality | 1..1 |
Terminology Binding | Substance Code (Example) |
Type | CodeableConcept |
Summary | true |
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 Id | Substance.description |
Definition | A description of the substance - its appearance, handling requirements, and other usage notes. |
Cardinality | 0..1 |
Type | string |
Summary | true |
Substance.instance | |
Element Id | Substance.instance |
Definition | Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance. |
Cardinality | 0..* |
Meaning if Missing | If this element is not present, then the substance resource describes a kind of substance |
Summary | true |
Substance.instance.identifier | |
Element Id | Substance.instance.identifier |
Definition | Identifier associated with the package/container (usually a label affixed directly). |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..1 |
Type | Identifier |
Summary | true |
Substance.instance.expiry | |
Element Id | Substance.instance.expiry |
Definition | When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. |
Cardinality | 0..1 |
Type | dateTime |
Summary | true |
Substance.instance.quantity | |
Element Id | Substance.instance.quantity |
Definition | The amount of the substance. |
Cardinality | 0..1 |
Type | SimpleQuantity |
Summary | true |
Substance.ingredient | |
Element Id | Substance.ingredient |
Definition | A substance can be composed of other substances. |
Cardinality | 0..* |
Summary | true |
Substance.ingredient.quantity | |
Element Id | Substance.ingredient.quantity |
Definition | The amount of the ingredient in the substance - a concentration ratio. |
Cardinality | 0..1 |
Type | Ratio |
Summary | true |
Substance.ingredient.substance[x] | |
Element Id | Substance.ingredient.substance[x] |
Definition | Another substance that is a component of this substance. |
Cardinality | 1..1 |
Terminology Binding | Substance Code (Example) |
Type | CodeableConcept|Reference(Substance) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |