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.
Ingredient, CDISC USDM 4.0, NCI C51981

In practice

In a protocol document: The composition of the investigational product.

Attributes

5 attributes, 4 of them required by the USDM API schema.

AttributeTypeCard.Definition
idrequiredstringcardinality 1The identifier of this object, unique within the file.
rolerequiredCodecardinality 1The intended use of the ingredient within the context of the compounded substance or mixture.Values: FHIR value set: Ingredient Role
substancerequiredSubstancecardinality 1A USDM relationship between the Ingredient and Substance classes that identifies the substance associated with the ingredient.
extensionAttributesExtensionAttributecardinality 0..*Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model.
instanceTyperequiredstringcardinality 1The 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.

Other classes in interventions and products:

← All 86 classes