Substance
A material of defined composition that an ingredient is made of, with its strengths, dictionary codes, and optionally the reference substance its strength is expressed against.
- Kind
- Concrete class
- Attributes
- 9, 4 required
- NCI code
- C45306
Official definition
Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.
Attributes
9 attributes, 4 of them required by the USDM API schema.
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file. |
| namerequired | string | cardinality 1 | The literal identifier (i.e., distinctive designation) of the substance. |
| label | string | cardinality 0..1 | The short descriptive designation for the substance. |
| description | string | cardinality 0..1 | A narrative representation of the substance. |
| codes | Code | cardinality 0..* | A symbol or combination of symbols which is assigned to the substance.Values: Multiple Biomedical coding dictionaries such as WHODrug, ATC, UNII, etc. |
| strengthsrequired | Strength | cardinality 1..* | A USDM relationship between the Substance and Strength class which provides the values of the strengths of the substance. |
| referenceSubstance | Substance | cardinality 0..1 | A USDM relationship within the Substance class that identifies the association between two substances, one of which is used as a reference for the other. |
| extensionAttributes | ExtensionAttribute | cardinality 0..* | Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model. |
| instanceTyperequired | string | cardinality 1 | The name of the class, carried by every object in a USDM JSON file. Added by the API; not part of the logical model. |
Smallest valid Substance
The attributes a JSON file must carry for a Substance, and the kind of value each takes. This is the shape, with types named in place of values. Everything else in the table above is optional.
Substance, required attributes only
{
"id": "Substance_1",
"name": string,
"strengths": [Strength, …],
"instanceType": "Substance"
}
Where Substance is used
These classes hold or point to a Substance.
- Ingredient.substancenested
- Substance.referenceSubstancenested
Related classes
Other classes in interventions and products: