|
| CommonProduct UML Documentation |
CommonProduct
Class LocallyManufacturedProduct
A product that was created by a pharmacist or by a clinician by compounding two or more ingredients. Common examples include mixing medications in flavored syrup for children, reconstituting a dried medication in distilled water, or mixing a medication into a cream for topical application.
| Attributes |
| Additive |  additive |
Pointer to the medication ingredient(s) that are dissolved into or mixed into some medium in order to transport the medication to the intended site or to ease in administration.
|
| «PQ» Quantity | componentCount |
This field indicates the number of ingredients (both active and inactive) that were compounded. This field is marked as derived because it could be calculated from the number of additive and vehicle instances."Count of compound product IDs (both active and inactive) in the compound mixture submitted." - NCPDP Telecommunication (Field 447-EC, Data Dictionary 201104).
|
| String | description |
A name or narrative of the medication being produced. For example, Acetaminophen 120 MG/5ML cherry-flavored Elixir.
|
| «CS» Code | dispenseUnitType |
"Contains the units for the dispense amount as encoded by the pharmacy or treatment supplier. This field is required if the units are not implied by the actual dispense code. This must be in simple units that reflect the actual quantity of the substance dispensed. It does not include compound units." - HL7 Version 2.8, RXC-11."NCPDP standard product billing codes." - NCPDP Telecommunication (Field 451-EG, Data Dictionary 201104).
|
| «CS» Code | doseForm |
"Dosage form of the complete compound mixture." - NCPDP Telecommunication (Field 450-EF, Data Dictionary 201104).
|
| «PQ» TimeQuantity | preparationTime |
"Measurement in minutes for the preparation of the compound." - NCPDP Telecommunication (Field A32-ZW, Data Dictionary 201104).
|
| Vehicle | vehicle |
Pointer to the ingredient(s) into which the active medication is dissolved or mixed in order to transport the medication to the intended site or to ease in administration.
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | LocallyManufacturedProduct |
| Name Expression | |
| Namespace | CommonProduct |
| Owned Template Signature | |
| Owner | CommonProduct |
| Owning Template Parameter | |
| Package | CommonProduct |
| Qualified Name | FHIM::CommonProduct::LocallyManufacturedProduct |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
additive
Public Additive additive
-
Pointer to the medication ingredient(s) that are dissolved into or mixed into some medium in order to transport the medication to the intended site or to ease in administration.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | pharmacyManufacturedProduct_additive |
| Association End | |
| Class | LocallyManufacturedProduct |
| 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 | additive |
| Name Expression | |
| Namespace | LocallyManufacturedProduct |
| Opposite | |
| Owner | LocallyManufacturedProduct |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CommonProduct::LocallyManufacturedProduct::additive |
| Stereotype | |
| Template Parameter | |
| Type | Additive |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
componentCount
Public «PQ» Quantity componentCount
-
This field indicates the number of ingredients (both active and inactive) that were compounded. This field is marked as derived because it could be calculated from the number of additive and vehicle instances."Count of compound product IDs (both active and inactive) in the compound mixture submitted." - NCPDP Telecommunication (Field 447-EC, Data Dictionary 201104).
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LocallyManufacturedProduct |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | false |
| Is Derived | true |
| 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 | componentCount |
| Name Expression | |
| Namespace | LocallyManufacturedProduct |
| Opposite | |
| Owner | LocallyManufacturedProduct |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CommonProduct::LocallyManufacturedProduct::componentCount |
| Stereotype | |
| Template Parameter | |
| Type | «PQ» Quantity |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
description
Public String description
-
A name or narrative of the medication being produced. For example, Acetaminophen 120 MG/5ML cherry-flavored Elixir.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LocallyManufacturedProduct |
| 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 | description |
| Name Expression | |
| Namespace | LocallyManufacturedProduct |
| Opposite | |
| Owner | LocallyManufacturedProduct |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CommonProduct::LocallyManufacturedProduct::description |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
dispenseUnitType
Public «CS» Code dispenseUnitType
-
"Contains the units for the dispense amount as encoded by the pharmacy or treatment supplier. This field is required if the units are not implied by the actual dispense code. This must be in simple units that reflect the actual quantity of the substance dispensed. It does not include compound units." - HL7 Version 2.8, RXC-11."NCPDP standard product billing codes." - NCPDP Telecommunication (Field 451-EG, Data Dictionary 201104).
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LocallyManufacturedProduct |
| 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 | dispenseUnitType |
| Name Expression | |
| Namespace | LocallyManufacturedProduct |
| Opposite | |
| Owner | LocallyManufacturedProduct |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CommonProduct::LocallyManufacturedProduct::dispenseUnitType |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
doseForm
Public «CS» Code doseForm
-
"Dosage form of the complete compound mixture." - NCPDP Telecommunication (Field 450-EF, Data Dictionary 201104).
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LocallyManufacturedProduct |
| 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 | doseForm |
| Name Expression | |
| Namespace | LocallyManufacturedProduct |
| Opposite | |
| Owner | LocallyManufacturedProduct |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CommonProduct::LocallyManufacturedProduct::doseForm |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
preparationTime
Public «PQ» TimeQuantity preparationTime
-
"Measurement in minutes for the preparation of the compound." - NCPDP Telecommunication (Field A32-ZW, Data Dictionary 201104).
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | LocallyManufacturedProduct |
| 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 | preparationTime |
| Name Expression | |
| Namespace | LocallyManufacturedProduct |
| Opposite | |
| Owner | LocallyManufacturedProduct |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CommonProduct::LocallyManufacturedProduct::preparationTime |
| Stereotype | |
| Template Parameter | |
| Type | «PQ» TimeQuantity |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
vehicle
Public Vehicle vehicle
-
Pointer to the ingredient(s) into which the active medication is dissolved or mixed in order to transport the medication to the intended site or to ease in administration.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | pharmacyManufacturedProduct_vehicle |
| Association End | |
| Class | LocallyManufacturedProduct |
| 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 | vehicle |
| Name Expression | |
| Namespace | LocallyManufacturedProduct |
| Opposite | |
| Owner | LocallyManufacturedProduct |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::CommonProduct::LocallyManufacturedProduct::vehicle |
| Stereotype | |
| Template Parameter | |
| Type | Vehicle |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
|
| CommonProduct UML Documentation |