CommonProduct
Class MedicinalProduct

Medicinal Product: Any substance or combination of substances presented for treating or preventing disease or with a view to making a medical diagnosis or to restoring, correcting or modifying physiological functions in human beings or in animals. – adapted from UK Nursing and Midwifery Council Directive 65/65/EEC
Represents a product produced and marketed as a medicine or drug. This class represents the product irrespective of the container size in which it is packaged. For example, if a product is marketed in bottles of 30 tablets and bottles of 60 tablets, this class describes the product (i.e., the tablets and the characteristics of those tablets), whereas the Packaged Medicinal Product class describes the characteristics peculiar to each kind of saleable product.

Attributes
String auxilliaryLabel auxilliaryLabel

Contains remarks to personnel handling the medication. Examples include: Do not freeze, Keep refrigerated, Do not use after [a certain] date, Do not take if pregnant.

«CS» Code controlledSubstanceSchedule controlledSubstanceSchedule

A code that represents the special regulations of a drug based upon its degree of potential abuse and level of jurisdictional control. In the United States, this property contains the "DEA Schedule" as specified by the Drug Enforcement Administration (DEA) in accordance with the Controlled Substance Act. The DEA Schedule contains a number between 1 and 5, with 1 representing the most controlled drugs (illegal drugs) and 5 representing the least controlled drugs. In addition a value of 0 is valid for drugs having no schedule.
"Value defining the DEA schedule of the medication." - NCPDP Script (Field 7996, Data Dictionary 201104)

DrugClass drugClass drugClass

Pointer to categorizations of the medication. Medications may be classified by various characteristics including Mechanism of Action, Mode of Action, Therapeutic Effect, Chemical Action, Pharmacokinetics, etc.

GenericMedicine genericMedicine genericMedicine

"The non-proprietary, generic substance as which the same medicines is known in the literature independent of a specific manufacturer." - HL7 V3

DrugIngredient ingredient ingredient

"Relates a product (typically a medicine) to a substance which it contains as an ingredient." - HL7 Version 3.
"Identifies a particular constituent of interest in the product." - HL7 FHIR, Medication.ingredient

«CS» Code investigationalNewDrugId investigationalNewDrugId

The unique identifier for the manufacturer's investigational new drug.

Boolean isOverTheCounter isOverTheCounter

Indicates whether this medication is sold over the counter.

«CS» Code newDrugApplicationId newDrugApplicationId

The unique identifier for the manufacturer's new drug application for this medicine.

PackagedMedicinalProduct packagedMedicinalProduct packagedMedicinalProduct

Pointer to a saleable unit of a medicinal product. For example, if a product is marketed in bottles of 30 tablets and bottles of 60 tablets, this property points to the two saleable units, which describe the characteristics peculiar to each kind of saleable product (i.e., the 30 count and the 60 count bottles).

Attributes inherited from FHIM::CommonProduct::Product FHIM::CommonProduct::Product
brandName brandName, description description, equivalentTo equivalentTo, fdaProductCode fdaProductCode, formCode formCode, handlingCode handlingCode, kind kind, manufacturer manufacturer, riskCode riskCode, shelfLife shelfLife, specializationOf specializationOf, status status

Properties:

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

Attribute Details

 auxilliaryLabel
Public String auxilliaryLabel

Contains remarks to personnel handling the medication. Examples include: Do not freeze, Keep refrigerated, Do not use after [a certain] date, Do not take if pregnant.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedicinalProduct
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*
NameauxilliaryLabel
Name Expression
NamespaceMedicinalProduct
Opposite
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::auxilliaryLabel
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 controlledSubstanceSchedule
Public «CS» Code controlledSubstanceSchedule

A code that represents the special regulations of a drug based upon its degree of potential abuse and level of jurisdictional control. In the United States, this property contains the "DEA Schedule" as specified by the Drug Enforcement Administration (DEA) in accordance with the Controlled Substance Act. The DEA Schedule contains a number between 1 and 5, with 1 representing the most controlled drugs (illegal drugs) and 5 representing the least controlled drugs. In addition a value of 0 is valid for drugs having no schedule.
"Value defining the DEA schedule of the medication." - NCPDP Script (Field 7996, Data Dictionary 201104)

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedicinalProduct
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
NamecontrolledSubstanceSchedule
Name Expression
NamespaceMedicinalProduct
Opposite
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::controlledSubstanceSchedule
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 drugClass
Public DrugClass drugClass

Pointer to categorizations of the medication. Medications may be classified by various characteristics including Mechanism of Action, Mode of Action, Therapeutic Effect, Chemical Action, Pharmacokinetics, etc.

Constraints:
Properties:

AggregationNone
Alias
Associationmedicinalproduct_drugClass
Association End
ClassMedicinalProduct
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*
NamedrugClass
Name Expression
NamespaceMedicinalProduct
Opposite
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::drugClass
Stereotype
Template Parameter
TypeDrugClass
Upper*
Upper Value(*)
VisibilityPublic


 genericMedicine
Public GenericMedicine genericMedicine

"The non-proprietary, generic substance as which the same medicines is known in the literature independent of a specific manufacturer." - HL7 V3

Constraints:
Properties:

AggregationNone
Alias
Associationmedicinalproduct__genericMedicine
Association End
ClassMedicinalProduct
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
NamegenericMedicine
Name Expression
NamespaceMedicinalProduct
Oppositeproduct
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::genericMedicine
Stereotype
Template Parameter
TypeGenericMedicine
Upper1
Upper Value(1)
VisibilityPublic


 ingredient
Public DrugIngredient ingredient

"Relates a product (typically a medicine) to a substance which it contains as an ingredient." - HL7 Version 3.
"Identifies a particular constituent of interest in the product." - HL7 FHIR, Medication.ingredient

Constraints:
Properties:

AggregationNone
Alias
Associationmedicinalproduct_ingredient
Association End
ClassMedicinalProduct
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..*
Nameingredient
Name Expression
NamespaceMedicinalProduct
OppositemedicinalProduct
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::ingredient
Stereotype
Template Parameter
TypeDrugIngredient
Upper*
Upper Value(*)
VisibilityPublic


 investigationalNewDrugId
Public «CS» Code investigationalNewDrugId

The unique identifier for the manufacturer's investigational new drug.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedicinalProduct
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
NameinvestigationalNewDrugId
Name Expression
NamespaceMedicinalProduct
Opposite
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::investigationalNewDrugId
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 isOverTheCounter
Public Boolean isOverTheCounter

Indicates whether this medication is sold over the counter.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedicinalProduct
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
NameisOverTheCounter
Name Expression
NamespaceMedicinalProduct
Opposite
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::isOverTheCounter
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic


 newDrugApplicationId
Public «CS» Code newDrugApplicationId

The unique identifier for the manufacturer's new drug application for this medicine.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassMedicinalProduct
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
NamenewDrugApplicationId
Name Expression
NamespaceMedicinalProduct
Opposite
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::newDrugApplicationId
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 packagedMedicinalProduct
Public PackagedMedicinalProduct packagedMedicinalProduct

Pointer to a saleable unit of a medicinal product. For example, if a product is marketed in bottles of 30 tablets and bottles of 60 tablets, this property points to the two saleable units, which describe the characteristics peculiar to each kind of saleable product (i.e., the 30 count and the 60 count bottles).

Constraints:
Properties:

AggregationNone
Alias
AssociationmedicinalProduct_packagedMedicinalProduct
Association End
ClassMedicinalProduct
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
NamepackagedMedicinalProduct
Name Expression
NamespaceMedicinalProduct
OppositemedicinalProduct
OwnerMedicinalProduct
Owning Association
Owning Template Parameter
Qualified NameFHIM::CommonProduct::MedicinalProduct::packagedMedicinalProduct
Stereotype
Template Parameter
TypePackagedMedicinalProduct
Upper1
Upper Value(1)
VisibilityPublic