CommonProduct
Class DrugIngredient

“Relates a product (typically medicine) to a substance which it contains as an ingredient. Ingredients can be specified for medicines or other products, including devices, but they always mean the same thing: a material (here: chemical substance) in the make-up of the main product, not a structural part or content of a container, and not a material added later into a device for operation. For medicines and food this is obvious. For devices, an example for ingredient would be latex in a chest tube (but not an inhalant in a nebulizer device).” – HL7 Version 3 (Role->Ingredient).
"Identifies a particular constituent of interest in the product." - HL7 FHIR, Medication.ingredient

Attributes
«IVL_TS» Period effectiveTime effectiveTime

“Sometimes used to indicate the ingredient is no longer used but was in the product during the time given. Notice that as product information is maintained over time, other information may also be outdated, and this time range may not be the most complete manner to keep this history information. If the effectiveTime is not specified (as it would usually be the case), the meaning is that there is no specific limit of validity of the ingredient information, and that the information is indeed valid at the time it was originally composed.” – HL7 Version 3 (Role.effectiveTime).

Substance ingredientSubstance ingredientSubstance

Pointer to the Substance used as an ingredient in the medication.
"The Substance entity is used to describe any material that functions as an ingredient of the Medicine." - HL7 Version 3.
"The actual ingredient - either a substance (simple ingredient) or another medication." - HL7 FHIR, Medication.ingredient.item[x]

Boolean isActiveMoiety isActiveMoiety

Moiety: "One of two or more parts into which something may be divided, such as the various parts of a vitamin or molecule." - The American Heritage Stedman's Medical Dictionary.
This property indicates whether the ingredient represented by this class is an "active ingredient" of the medication.
"Indication of whether this ingredient affects the therapeutic action of the drug." - HL7 FHIR, Medication.ingredient.isActive

Boolean isAdjuvant isAdjuvant

Adjuvant: "a) A pharmacological agent added to a drug, predictably affecting the action of the drug's active ingredient. b) An immunological vehicle for enhancing antigenicity, such as a water-in-oil emulsion in which antigen solution is emulsified in mineral oil. Also called immunoadjuvant." - The American Heritage Stedman's Medical Dictionary.

This property indicates whether the ingredient represented by this class is acting as an adjuvant with respect to the complete medication.

Boolean isAntigen isAntigen

Antigen: "Any of various substances, including toxins, bacteria, and the cells of transplanted organs, that when introduced into the body stimulate the production of antibodies. Also called allergen , immunogen." - The American Heritage Stedman's Medical Dictionary.

This property indicates whether the ingredient represented by this class is an antigen.

Boolean isConfidential isConfidential

“Used to indicate that the manufacturer considers the presence of the ingredient a trade secret. This could be the case for inactive ingredients.” – HL7 Version 3 (Role.confidentialityCode).

Boolean isDiluent isDiluent

Diluent: "A substance that dilutes the strength of a solution or mixture." - The American Heritage Stedman's Medical Dictionary.

This property indicates whether the ingredient represented by this class is acting as an diluent with respect to the complete medication.

Boolean isPreservative isPreservative

Preservative: "A substance added to food products or to organic solutions to prevent decomposition due to chemical change or bacterial action." - The American Heritage Stedman's Medical Dictionary.

This property indicates whether the ingredient represented by this class is acting as an preservative with respect to the complete medication.

MedicinalProduct medicinalProduct medicinalProduct

Pointer to products produced and marketed as a medicine or drug which contain the referencing ingredient.

«RTO_PQ» Ratio quantity quantity

“A ratio specifying the strength of the ingredient as amount of ingredient substance (numerator) in amount of medicine (denominator). For example, a 50 mg tablet contains 50 mg in 1 tablet; a 50 mg per 5 mL syrup contains 50 mg in 5 mL. Note that for countable dose forms ("eaches") no unit is required in the denominator, i.e., the denominator is a dimensionless number with unit 1 (one, the unity). The fact that the dose is per tablet, capsule, or whatever the dose form may be is recorded in the formCode of the scoping product, not in a unit of measureConstraint. The quantity expressed by Role quantity numerator and denominator must always be one of the following kinds of quantity: 1) count; 2) amount of substance; 3) mass; 4) volume; 5) arbitrary unit (representing some extensive property of Entity). In the given context these five quantities can be clearly discriminated by examination of the unit in use. An Entity is either countable (case 1) or not countable, in which case some unit is required (cases 2-4). This must be derivable from the Entity formCode. The dimension of the denominator must be the same as the dimension of all of the quantity numerators of the scoper's (i.e., the product's) played roles (e.g., package content, part of kit, etc.)." – HL7 Version 3 (Role.quantity).
"Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet." - HL7 FHIR, Medication.ingredient.strength


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameDrugIngredient
Name Expression
NamespaceCommonProduct
Owned Template Signature
OwnerCommonProduct
Owning Template Parameter
PackageCommonProduct
Qualified NameFHIM::CommonProduct::DrugIngredient
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 effectiveTime
Public «IVL_TS» Period effectiveTime

“Sometimes used to indicate the ingredient is no longer used but was in the product during the time given. Notice that as product information is maintained over time, other information may also be outdated, and this time range may not be the most complete manner to keep this history information. If the effectiveTime is not specified (as it would usually be the case), the meaning is that there is no specific limit of validity of the ingredient information, and that the information is indeed valid at the time it was originally composed.” – HL7 Version 3 (Role.effectiveTime).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameeffectiveTime
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::effectiveTime
Stereotype
Template Parameter
Type«IVL_TS» Period
Upper1
Upper Value(1)
VisibilityPublic


 ingredientSubstance
Public Substance ingredientSubstance

Pointer to the Substance used as an ingredient in the medication.
"The Substance entity is used to describe any material that functions as an ingredient of the Medicine." - HL7 Version 3.
"The actual ingredient - either a substance (simple ingredient) or another medication." - HL7 FHIR, Medication.ingredient.item[x]

Constraints:
Properties:

AggregationNone
Alias
AssociationdrugIngredient_ingredient
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameingredientSubstance
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::ingredientSubstance
Stereotype
Template Parameter
TypeSubstance
Upper1
Upper Value(1)
VisibilityPublic


 isActiveMoiety
Public Boolean isActiveMoiety

Moiety: "One of two or more parts into which something may be divided, such as the various parts of a vitamin or molecule." - The American Heritage Stedman's Medical Dictionary.
This property indicates whether the ingredient represented by this class is an "active ingredient" of the medication.
"Indication of whether this ingredient affects the therapeutic action of the drug." - HL7 FHIR, Medication.ingredient.isActive

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameisActiveMoiety
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::isActiveMoiety
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isAdjuvant
Public Boolean isAdjuvant

Adjuvant: "a) A pharmacological agent added to a drug, predictably affecting the action of the drug's active ingredient. b) An immunological vehicle for enhancing antigenicity, such as a water-in-oil emulsion in which antigen solution is emulsified in mineral oil. Also called immunoadjuvant." - The American Heritage Stedman's Medical Dictionary.

This property indicates whether the ingredient represented by this class is acting as an adjuvant with respect to the complete medication.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisAdjuvant
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::isAdjuvant
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isAntigen
Public Boolean isAntigen

Antigen: "Any of various substances, including toxins, bacteria, and the cells of transplanted organs, that when introduced into the body stimulate the production of antibodies. Also called allergen , immunogen." - The American Heritage Stedman's Medical Dictionary.

This property indicates whether the ingredient represented by this class is an antigen.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisAntigen
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::isAntigen
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isConfidential
Public Boolean isConfidential

“Used to indicate that the manufacturer considers the presence of the ingredient a trade secret. This could be the case for inactive ingredients.” – HL7 Version 3 (Role.confidentialityCode).

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NameisConfidential
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::isConfidential
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isDiluent
Public Boolean isDiluent

Diluent: "A substance that dilutes the strength of a solution or mixture." - The American Heritage Stedman's Medical Dictionary.

This property indicates whether the ingredient represented by this class is acting as an diluent with respect to the complete medication.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisDiluent
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::isDiluent
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 isPreservative
Public Boolean isPreservative

Preservative: "A substance added to food products or to organic solutions to prevent decomposition due to chemical change or bacterial action." - The American Heritage Stedman's Medical Dictionary.

This property indicates whether the ingredient represented by this class is acting as an preservative with respect to the complete medication.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameisPreservative
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::isPreservative
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 medicinalProduct
Public MedicinalProduct medicinalProduct

Pointer to products produced and marketed as a medicine or drug which contain the referencing ingredient.

Constraints:
Properties:

AggregationNone
Alias
Associationmedicinalproduct_ingredient
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamemedicinalProduct
Name Expression
NamespaceDrugIngredient
Oppositeingredient
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::medicinalProduct
Stereotype
Template Parameter
TypeMedicinalProduct
Upper*
Upper Value(*)
VisibilityPublic


 quantity
Public «RTO_PQ» Ratio quantity

“A ratio specifying the strength of the ingredient as amount of ingredient substance (numerator) in amount of medicine (denominator). For example, a 50 mg tablet contains 50 mg in 1 tablet; a 50 mg per 5 mL syrup contains 50 mg in 5 mL. Note that for countable dose forms ("eaches") no unit is required in the denominator, i.e., the denominator is a dimensionless number with unit 1 (one, the unity). The fact that the dose is per tablet, capsule, or whatever the dose form may be is recorded in the formCode of the scoping product, not in a unit of measureConstraint. The quantity expressed by Role quantity numerator and denominator must always be one of the following kinds of quantity: 1) count; 2) amount of substance; 3) mass; 4) volume; 5) arbitrary unit (representing some extensive property of Entity). In the given context these five quantities can be clearly discriminated by examination of the unit in use. An Entity is either countable (case 1) or not countable, in which case some unit is required (cases 2-4). This must be derivable from the Entity formCode. The dimension of the denominator must be the same as the dimension of all of the quantity numerators of the scoper's (i.e., the product's) played roles (e.g., package content, part of kit, etc.)." – HL7 Version 3 (Role.quantity).
"Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet." - HL7 FHIR, Medication.ingredient.strength

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassDrugIngredient
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namequantity
Name Expression
NamespaceDrugIngredient
Opposite
OwnerDrugIngredient
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::DrugIngredient::quantity
Stereotype
Template Parameter
Type«RTO_PQ» Ratio
Upper1
Upper Value(1)
VisibilityPublic

Comments