type: resource-definitionsresource: Ingredient

Ingredient Definitions

Ingredient

An ingredient of a manufactured item or pharmaceutical product

Definition: An ingredient of a manufactured item or pharmaceutical product.

Cardinality: 0..*

Constraints: ing-1 | error | If an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allergen information should be documented in that resource | Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

Mappings: idmp=Ingredient; w5=administrative.medication

Ingredient.identifier

An identifier or code by which the ingredient can be referenced

Definition: 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.

Cardinality: 0..1

Type: Identifier

Summary: true

Mappings: idmp=n/a; w5=FiveWs.class

Ingredient.status

draft | active | retired | unknown

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

Comments: Allows filtering of ingredient that are appropriate for use versus not.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)

Mappings: idmp=n/a

Ingredient.for

The product which this ingredient is a constituent part of

Definition: The product which this ingredient is a constituent part of.

Cardinality: 0..*

Type: Reference(MedicinalProductDefinition, AdministrableProductDefinition, ManufacturedItemDefinition)

Summary: true

Mappings: idmp=n/a

Ingredient.role

Purpose of the ingredient within the product, e.g. active, inactive

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

Cardinality: 1..1

Type: CodeableConcept

Binding: example:ingredient-role

Summary: true

Mappings: idmp=Ingredient.Ingredient Role

Ingredient.function

Precise action within the drug product, e.g. antioxidant, alkalizing agent

Definition: 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.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:ingredient-function

Summary: true

Mappings: idmp=n/a

Ingredient.group

A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink

Definition: A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.

Cardinality: 0..1

Type: CodeableConcept

Summary: true

Mappings: idmp=n/a

Ingredient.allergenicIndicator

If the ingredient is a known or suspected allergen

Definition: 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 describe that (rather than just a code), the allergen information should go there, not here.

Meaning if Missing: If this value is not present, there is no statement being made about whether this is an allergen or not. No inference can be made

Conditions: ing-1

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: idmp=Ingredient.Allergenic Indicator

Ingredient.comment

A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying

Definition: A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.

Cardinality: 0..1

Type: markdown

Summary: false

Mappings: idmp=n/a

Ingredient.manufacturer

An organization that manufactures this ingredient

Definition: 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.

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: idmp=Ingredient.manufacturer

Ingredient.manufacturer.role

allowed | possible | actual

Definition: The way in which this manufacturer is associated with the ingredient. For example whether it is a possible one (others allowed), or an exclusive authorized one for this ingredient. Note that this is not the manufacturing process role.

Cardinality: 0..1

Type: code

Binding: required:ingredient-manufacturer-role

Summary: true

Mappings: idmp=Ingredient.Manufacturer / Establishment (Organisation)

Ingredient.manufacturer.manufacturer

An organization that manufactures this ingredient

Definition: An organization that manufactures this ingredient.

Cardinality: 1..1

Type: Reference(Organization)

Summary: true

Mappings: idmp=Ingredient.Manufacturer / Establishment (Organisation)

Ingredient.substance

The substance that comprises this ingredient

Definition: The substance that comprises this ingredient.

Conditions: ing-1

Cardinality: 1..1

Type: BackboneElement

Summary: true

Mappings: idmp=Ingredient.Substance

Ingredient.substance.code

A code or full resource that represents the ingredient substance

Definition: A code or full resource that represents the ingredient's substance.

Conditions: ing-1

Cardinality: 1..1

Type: CodeableReference

Binding: example:substance-codes

Summary: true

Mappings: idmp=Substance.Substance

Ingredient.substance.strength

The quantity of substance, per presentation, or per volume or mass, and type of quantity

Definition: The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. The allowed repetitions do not represent different strengths, but are different representations - mathematically equivalent - of a single strength.

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: idmp=Specified Substance.Strength

Ingredient.substance.strength.presentation[x]

The quantity of substance in the unit of presentation

Definition: The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item. Unit of presentation refers to the quantity that the item occurs in e.g. a strength per tablet size, perhaps 'per 20mg' (the size of the tablet). It is not generally normalized as a unitary unit, which would be 'per mg').

Cardinality: 0..1

Type: Ratio, RatioRange, CodeableConcept, Quantity

Summary: true

Mappings: idmp=Strength.Strength (Presentation)

Ingredient.substance.strength.textPresentation

Text of either the whole presentation strength or a part of it (rest being in Strength.presentation as a ratio)

Definition: A textual representation of either the whole of the presentation strength or a part of it - with the rest being in Strength.presentation as a ratio.

Cardinality: 0..1

Type: string

Summary: true

Mappings: idmp=n/a

Ingredient.substance.strength.concentration[x]

The strength per unitary volume (or mass)

Definition: The strength per unitary volume (or mass).

Cardinality: 0..1

Type: Ratio, RatioRange, CodeableConcept, Quantity

Summary: true

Mappings: idmp=Strength.Strength (Concentration)

Ingredient.substance.strength.textConcentration

Text of either the whole concentration strength or a part of it (rest being in Strength.concentration as a ratio)

Definition: A textual representation of either the whole of the concentration strength or a part of it - with the rest being in Strength.concentration as a ratio.

Cardinality: 0..1

Type: string

Summary: true

Mappings: idmp=n/a

Ingredient.substance.strength.basis

A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt)

Definition: A code that indicates if the strength is, for example, based on the ingredient substance as stated or on the substance base (when the ingredient is a salt).

Cardinality: 0..1

Type: CodeableConcept

Summary: true

Mappings: idmp=n/a

Ingredient.substance.strength.measurementPoint

When strength is measured at a particular point or distance

Definition: For when strength is measured at a particular point or distance. There are products where strength is measured at a particular point. For example, the strength of the ingredient in some inhalers is measured at a particular position relative to the point of aerosolization.

Cardinality: 0..1

Type: string

Summary: true

Mappings: idmp=Strength.Measurement Point

Ingredient.substance.strength.country

Where the strength range applies

Definition: The country or countries for which the strength range applies.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:country

Summary: true

Mappings: idmp=Strength.Country

Ingredient.substance.strength.referenceStrength

Strength expressed in terms of a reference substance

Definition: Strength expressed in terms of a reference substance. For when the ingredient strength is additionally expressed as equivalent to the strength of some other closely related substance (e.g. salt vs. base). Reference strength represents the strength (quantitative composition) of the active moiety of the active substance. There are situations when the active substance and active moiety are different, therefore both a strength and a reference strength are needed.

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: idmp=Strength.Reference Strength