| CommonProduct UML Documentation |
CommonProduct
Class MedicinalProductInstance
This class identifies an individual saleable or dispensable unit of medication, and is used to convey information about the actual drug produced, dispensed, or administered. Note that the Id property (commonly known as a serial number) would be used to identify the saleable unit. It is widely anticipated that saleable units will have such Ids in the future, but it is currently not common practice."A product instance is (a) an individual product instance, i.e., an individually identified thing with a serial number; (b) a product lot, i.e., a set of things of the same kind (e.g., 1000 for expressing a number of tablets) or an amorphous mass (e.g., 100 L of a liquid raw material), or (c) any subset, member, or portion of a product lot. The distinction between an individual thing and a lot is made in the quantity attribute, which is set to 1 (one) for individual items, or any number e.g., 1000 or amount 100 L for sets of things or amorphous masses respectively." - HL7 Version 3.
Attributes |
DrugPricing | drugPricing |
Pointer to the methodology was used to calculate the price of a medication.
|
«II» Id | identifier |
"A unique identifier for this instance. If the product instance represents a single individual product (quantity = 1) then this id is also called the "serial number". If the product instance represents a product lot, the id is also called the "lot number"." - HL7 V3"Business identifier for this medication." - HL7 FHIR, Medication.identifier
|
ManufacturingLot | manufacturingLot |
Pointer to the batch or lot in which the medicinal product was manufactured.
|
PackagedMedicinalProduct | packagedMedicinalProduct |
Pointer to a saleable unit of a medicinal product of which the Medicinal Product Instance (e.g., a particular bottle) is an occurrence.
|
String | storageCondition |
Describes the conditions under which the product was stored (e.g., temperature, humidity). This property is currently a string, but will likely be replaced by a structured class in the future.
|
«MO» MonetaryAmount | unitPrice |
This is the price of the medication per dispense unit.
|
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | MedicinalProductInstance |
Name Expression | |
Namespace | CommonProduct |
Owned Template Signature | |
Owner | CommonProduct |
Owning Template Parameter | |
Package | CommonProduct |
Qualified Name | FHIM::CommonProduct::MedicinalProductInstance |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
drugPricing
Public DrugPricing drugPricing
-
Pointer to the methodology was used to calculate the price of a medication.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | medicinalProductInstance_drugPricing |
Association End | |
Class | MedicinalProductInstance |
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 | drugPricing |
Name Expression | |
Namespace | MedicinalProductInstance |
Opposite | |
Owner | MedicinalProductInstance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProductInstance::drugPricing |
Stereotype | |
Template Parameter | |
Type | DrugPricing |
Upper | * |
Upper Value | (*) |
Visibility | Public |
identifier
Public «II» Id identifier
-
"A unique identifier for this instance. If the product instance represents a single individual product (quantity = 1) then this id is also called the "serial number". If the product instance represents a product lot, the id is also called the "lot number"." - HL7 V3"Business identifier for this medication." - HL7 FHIR, Medication.identifier
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicinalProductInstance |
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 | identifier |
Name Expression | |
Namespace | MedicinalProductInstance |
Opposite | |
Owner | MedicinalProductInstance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProductInstance::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
manufacturingLot
Public ManufacturingLot manufacturingLot
-
Pointer to the batch or lot in which the medicinal product was manufactured.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | medicinalProductInstance_manufacturingLot |
Association End | |
Class | MedicinalProductInstance |
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 | manufacturingLot |
Name Expression | |
Namespace | MedicinalProductInstance |
Opposite | |
Owner | MedicinalProductInstance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProductInstance::manufacturingLot |
Stereotype | |
Template Parameter | |
Type | ManufacturingLot |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
packagedMedicinalProduct
Public PackagedMedicinalProduct packagedMedicinalProduct
-
Pointer to a saleable unit of a medicinal product of which the Medicinal Product Instance (e.g., a particular bottle) is an occurrence.
-
Constraints:
-
Properties:
-
storageCondition
Public String storageCondition
-
Describes the conditions under which the product was stored (e.g., temperature, humidity). This property is currently a string, but will likely be replaced by a structured class in the future.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicinalProductInstance |
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 | storageCondition |
Name Expression | |
Namespace | MedicinalProductInstance |
Opposite | |
Owner | MedicinalProductInstance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProductInstance::storageCondition |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
unitPrice
Public «MO» MonetaryAmount unitPrice
-
This is the price of the medication per dispense unit.
-
Constraints:
-
Properties:
-
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | MedicinalProductInstance |
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 | unitPrice |
Name Expression | |
Namespace | MedicinalProductInstance |
Opposite | |
Owner | MedicinalProductInstance |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::MedicinalProductInstance::unitPrice |
Stereotype | |
Template Parameter | |
Type | «MO» MonetaryAmount |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| CommonProduct UML Documentation |