Ingredient
A component of a product and the role it plays, with the substance it is made of.
- Kind
- Concrete class
- Attributes
- 5, 4 required
- NCI code
- C51981
Official definition
Any component that constitutes a part of a compounded substance or mixture.
In practice
In a protocol document: The composition of the investigational product.
Attributes
5 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. |
| rolerequired | Code | cardinality 1 | The intended use of the ingredient within the context of the compounded substance or mixture.Values: FHIR value set: Ingredient Role |
| substancerequired | Substance | cardinality 1 | A USDM relationship between the Ingredient and Substance classes that identifies the substance associated with the ingredient. |
| 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 Ingredient
The attributes a JSON file must carry for a Ingredient, 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.
Ingredient, required attributes only
{
"id": "Ingredient_1",
"role": Code,
"substance": Substance,
"instanceType": "Ingredient"
}
Where Ingredient is used
These classes hold or point to a Ingredient.
- AdministrableProduct.ingredientsnested
Related classes
Other classes in interventions and products: