| CommonProduct UML Documentation |
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/EECRepresents 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 |
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 |
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 |
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 |
"The non-proprietary, generic substance as which the same medicines is known in the literature independent of a specific manufacturer." - HL7 V3
|
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
|
«CS» Code | investigationalNewDrugId |
The unique identifier for the manufacturer's investigational new drug.
|
Boolean | isOverTheCounter |
Indicates whether this medication is sold over the counter.
|
«CS» Code | newDrugApplicationId |
The unique identifier for the manufacturer's new drug application for this medicine.
|
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 |
brandName, description, equivalentTo, fdaProductCode, formCode, handlingCode, kind, manufacturer, riskCode, shelfLife, specializationOf, status |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | MedicinalProduct |
Name Expression | |
Namespace | CommonProduct |
Owned Template Signature | |
Owner | CommonProduct |
Owning Template Parameter | |
Package | CommonProduct |
Qualified Name | FHIM::CommonProduct::MedicinalProduct |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
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:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | auxilliaryLabel |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::auxilliaryLabel |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | controlledSubstanceSchedule |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::controlledSubstanceSchedule |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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:
-
Aggregation | None |
Alias | |
Association | medicinalproduct_drugClass |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | drugClass |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::drugClass |
Stereotype | |
Template Parameter | |
Type | DrugClass |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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:
-
Aggregation | None |
Alias | |
Association | medicinalproduct__genericMedicine |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | genericMedicine |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | product |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::genericMedicine |
Stereotype | |
Template Parameter | |
Type | GenericMedicine |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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:
-
Aggregation | None |
Alias | |
Association | medicinalproduct_ingredient |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1..* |
Name | ingredient |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | medicinalProduct |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::ingredient |
Stereotype | |
Template Parameter | |
Type | DrugIngredient |
Upper | * |
Upper Value | (*) |
Visibility | Public |
investigationalNewDrugId
Public «CS» Code investigationalNewDrugId
-
The unique identifier for the manufacturer's investigational new drug.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | investigationalNewDrugId |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::investigationalNewDrugId |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
isOverTheCounter
Public Boolean isOverTheCounter
-
Indicates whether this medication is sold over the counter.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | isOverTheCounter |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::isOverTheCounter |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
newDrugApplicationId
Public «CS» Code newDrugApplicationId
-
The unique identifier for the manufacturer's new drug application for this medicine.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | newDrugApplicationId |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::newDrugApplicationId |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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:
-
Aggregation | None |
Alias | |
Association | medicinalProduct_packagedMedicinalProduct |
Association End | |
Class | MedicinalProduct |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | packagedMedicinalProduct |
Name Expression | |
Namespace | MedicinalProduct |
Opposite | medicinalProduct |
Owner | MedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProduct::packagedMedicinalProduct |
Stereotype | |
Template Parameter | |
Type | PackagedMedicinalProduct |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| CommonProduct UML Documentation |