Skip to main content

Ingredient

An ingredient of a manufactured item or pharmaceutical product. If the element is present, it must have either a @value, an @id, or extensions

type Ingredient implements Resource {
  identifier: Identifier
  status: String
  for: [Reference]
  role: CodeableConcept
  function: [CodeableConcept]
  allergenicIndicator: Boolean
  manufacturer: [IngredientManufacturer]
  substance: IngredientSubstance
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields​

Ingredient.identifier ● Identifier object​

The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.

Ingredient.status ● String scalar​

The status of this ingredient. Enables tracking the life-cycle of the content.

Ingredient.for ● [Reference] list object​

The product which this ingredient is a constituent part of.

Ingredient.role ● CodeableConcept object​

A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.

Ingredient.function ● [CodeableConcept] list object​

A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: antioxidant, alkalizing agent.

Ingredient.allergenicIndicator ● Boolean scalar​

If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.

Ingredient.manufacturer ● [IngredientManufacturer] list object​

The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.

Ingredient.substance ● IngredientSubstance object​

The substance that comprises this ingredient.

Ingredient.text ● Narrative object​

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Ingredient.contained ● [Resource] list interface​

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Ingredient.extension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Ingredient.modifierExtension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Ingredient.id ● String scalar​

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Ingredient.meta ● Meta object​

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Ingredient.implicitRules ● Uri scalar​

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Ingredient.language ● String scalar​

The base language in which the resource is written.

Interfaces​

Resource interface​

This is the base resource type for everything.

Returned By​

Ingredient query ● IngredientCreate mutation ● IngredientList query ● IngredientUpdate mutation