Release 5 Ballot
AdministrationThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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
| Biomedical Research and Regulation 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. |
| Short Display | A homogeneous material with a definite composition |
| Cardinality | 0..* |
| Type | DomainResource |
| Summary | false |
| Substance.identifier | |
| Element Id | Substance.identifier |
| Definition | Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly). |
| Short Display | Unique identifier |
| 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.instance | |
| Element Id | Substance.instance |
| Definition | A boolean to indicate if this an instance of a substance or a kind of one (a definition). |
| Short Display | Is this an instance of a substance or a kind of one |
| Cardinality | 1..1 |
| Type | boolean |
| Is Modifier | true (Reason: Not known why this is labelled a modifier) |
| Summary | true |
| Substance.status | |
| Element Id | Substance.status |
| Definition | A code to indicate if the substance is actively used. |
| Short Display | active | inactive | entered-in-error |
| 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. |
| Short Display | What class/type of substance this is |
| 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. |
| Short Display | What substance this is |
| Cardinality | 1..1 |
| Terminology Binding | Substance Code (Example) |
| Type | CodeableReference(SubstanceDefinition) |
| 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. |
| Short Display | Textual description of the substance, comments |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| Substance.expiry | |
| Element Id | Substance.expiry |
| Definition | When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. |
| Short Display | When no longer valid to use |
| Cardinality | 0..1 |
| Type | dateTime |
| Summary | true |
| Substance.quantity | |
| Element Id | Substance.quantity |
| Definition | The amount of the substance. |
| Short Display | Amount of substance in the package |
| Cardinality | 0..1 |
| Type | SimpleQuantity |
| Summary | true |
| Substance.ingredient | |
| Element Id | Substance.ingredient |
| Definition | A substance can be composed of other substances. |
| Short Display | Composition information about the substance |
| Cardinality | 0..* |
| Summary | true |
| Substance.ingredient.quantity | |
| Element Id | Substance.ingredient.quantity |
| Definition | The amount of the ingredient in the substance - a concentration ratio. |
| Short Display | Optional amount (concentration) |
| 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. |
| Short Display | A component of the substance |
| Cardinality | 1..1 |
| Terminology Binding | Substance Code (Example) |
| Type | CodeableConcept|Reference(Substance) |
| [x] Note | See Choice of Datatypes for further information about how to use [x] |
| Summary | true |
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:11+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change