| CommonProduct UML Documentation |
Summary:AttributesCommentsProperties | Detail:Attributes |
Represents a saleable unit of a medicinal product. This unit will typically (but not necessarily) contain a number of doses of medicine in one package, e.g., a 30 tablet bottle, a 20 ml tube. This class exists because different size containers will have different inventory codes and it is the packaged product that is generally associated with the manufacturing lot in which it was produced. For example, a 30 count bottle will have a different NDC than a 60 count bottle. Also, for manufacturing practicalities, the manufacturing lot and expiration date are on the bottle, not on each tablet."A product in a container, or package. Represents the entirety of a product that has been packaged in a container for sale or supply; this representation of the Packaged Medicine may be in its real or actual form as something made, or described more conceptually, generically, or virtually, but it must represent a product contained in a package." - HL7 V3Note that an important difference exists between the FHIM Packaged Medicinal Product and the nascent FHIR Medication.Package construct in that the FHIM does not adequately describe those situations where one has more than one drug form in the same package. For example, a package that has both an injectable liquid and a lotion. The FHIR Medication.Package appears to separate the contents better. The FHIM may in the future incorporate a separation of the drug forms into separate classes.
Attributes | ||
«CS» Code | capType |
“The type of container cap. In some cases, it is important for this to be consistent with decapping, piercing or other automated manipulation. Notions such as "child-proof cap" or "resealable bag" may also be indicated here.” - HL7 Version 3 (PackagedProduct.capTypeCode). |
«CS» Code | code |
This property is used to identify the packaged product (or “sale-able item”), using any coding system except the National Drug Code (NDC), as we have created a separate property for NDC. HL7 and NCPDP both have a single property (which could be multi-valued) to hold any and all such codes in one place, but in the FHIM, we identify the NDC separately due to its importance in federal implementations.“The item code for a packaged product (e.g., complete National Drug Code [NDC] in the U.S.)” - HL7 Version 3 (PackagedProduct.code)."Code to identify the type of product ID contained in CDI03 [Product ID]." - ASAP Standard for PDMP, CDI02: Product ID Qualifier. Possible values include: NDC; UPC; HRI; UPN; DIN."Full product identification as indicated in CDI02 [Product ID Qualifier], including leading zeros without punctuation." - ASAP Standard for PDMP, CDI03: Product ID |
«CS» Code | codeModifier |
This property is used to further identify the packaged product (or “sale-able item”), when the coding system used in the “code” property uses separate code modifiers. |
String | description |
“A text description of the packaged product. This may include a discussion of the container.” - HL7 Version 3 (PackagedProduct.desc). |
Labeler | labeler |
Pointer to an organization that repackages medicinal products for sale. |
MedicinalProduct | medicinalProduct |
Pointer to a product produced and marketed as a medicine or drug. |
String | name |
“A name for the packaged product, usually the same as the name of the product (except where the name contains some reference to the packaging (e.g., "tempo super-pack", "tic-tac easy-box")).” - HL7 Version 3 (PackagedProduct.name). |
«CS» Code | nationalDrugCode |
"Each drug product listed under Section 510 of the Federal Food, Drug, and Cosmetic Act is assigned a unique 10-digit, 3-segment number. This number, known as the National Drug Code (NDC), identifies the labeler/vendor, product, and trade package size." - FDA. |
«PQ» Quantity | packageCapacity |
"Contains the size of package to be dispensed." - HL7 Version 2.8, RXD-22."Contains the units in which [packageCapacity] is denominated. The advertised number of units in the manufacturer's package, i.e., the package as it comes from the supplier." - HL7 Version 2.8, RXD-23.“Captures the number of product units the package would contain if fully loaded.” - HL7 Version 3 (PackagedProduct.capacityQuantity)."Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc)." - HL7 FHIR, Medication.amount |
«CS» Code | packageType |
“The package type, such as box or bottle.” - HL7 Version 3 (PackagedProduct.formCode)."The kind of container that this package comes as." - HL7 FHIR, Medication.package.container |
MedicinalProductInstance | productInstance |
Pointer to instances (e.g., particular bottles) of a Packaged Medicinal Product, which will be identified by a serial number or a lot number. For example, if the Packaged Medicinal Product represents all 30-count bottles of Acme Aspirin, this property points to a specific bottle manufactured on Jan. 27th 2016. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | PackagedMedicinalProduct |
Name Expression | |
Namespace | CommonProduct |
Owned Template Signature | |
Owner | CommonProduct |
Owning Template Parameter | |
Package | CommonProduct |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «CS» Code capType
“The type of container cap. In some cases, it is important for this to be consistent with decapping, piercing or other automated manipulation. Notions such as "child-proof cap" or "resealable bag" may also be indicated here.” - HL7 Version 3 (PackagedProduct.capTypeCode).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PackagedMedicinalProduct |
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 | capType |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::capType |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code code
This property is used to identify the packaged product (or “sale-able item”), using any coding system except the National Drug Code (NDC), as we have created a separate property for NDC. HL7 and NCPDP both have a single property (which could be multi-valued) to hold any and all such codes in one place, but in the FHIM, we identify the NDC separately due to its importance in federal implementations.“The item code for a packaged product (e.g., complete National Drug Code [NDC] in the U.S.)” - HL7 Version 3 (PackagedProduct.code)."Code to identify the type of product ID contained in CDI03 [Product ID]." - ASAP Standard for PDMP, CDI02: Product ID Qualifier. Possible values include: NDC; UPC; HRI; UPN; DIN."Full product identification as indicated in CDI02 [Product ID Qualifier], including leading zeros without punctuation." - ASAP Standard for PDMP, CDI03: Product ID
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PackagedMedicinalProduct |
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 | code |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::code |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code codeModifier
This property is used to further identify the packaged product (or “sale-able item”), when the coding system used in the “code” property uses separate code modifiers.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PackagedMedicinalProduct |
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 | codeModifier |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::codeModifier |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public String description
“A text description of the packaged product. This may include a discussion of the container.” - HL7 Version 3 (PackagedProduct.desc).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PackagedMedicinalProduct |
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 | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::description |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Labeler labeler
Pointer to an organization that repackages medicinal products for sale.
Aggregation | None |
Alias | |
Association | packagedMedicinalProduct_labeler |
Association End | |
Class | PackagedMedicinalProduct |
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 | labeler |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::labeler |
Stereotype | |
Template Parameter | |
Type | Labeler |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public MedicinalProduct medicinalProduct
Pointer to a product produced and marketed as a medicine or drug.
Aggregation | None |
Alias | |
Association | medicinalProduct_packagedMedicinalProduct |
Association End | |
Class | PackagedMedicinalProduct |
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 | medicinalProduct |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | packagedMedicinalProduct |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::medicinalProduct |
Stereotype | |
Template Parameter | |
Type | MedicinalProduct |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String name
“A name for the packaged product, usually the same as the name of the product (except where the name contains some reference to the packaging (e.g., "tempo super-pack", "tic-tac easy-box")).” - HL7 Version 3 (PackagedProduct.name).
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PackagedMedicinalProduct |
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 | name |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::name |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code nationalDrugCode
"Each drug product listed under Section 510 of the Federal Food, Drug, and Cosmetic Act is assigned a unique 10-digit, 3-segment number. This number, known as the National Drug Code (NDC), identifies the labeler/vendor, product, and trade package size." - FDA.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PackagedMedicinalProduct |
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 | nationalDrugCode |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::nationalDrugCode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «PQ» Quantity packageCapacity
"Contains the size of package to be dispensed." - HL7 Version 2.8, RXD-22."Contains the units in which [packageCapacity] is denominated. The advertised number of units in the manufacturer's package, i.e., the package as it comes from the supplier." - HL7 Version 2.8, RXD-23.“Captures the number of product units the package would contain if fully loaded.” - HL7 Version 3 (PackagedProduct.capacityQuantity)."Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc)." - HL7 FHIR, Medication.amount
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PackagedMedicinalProduct |
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 | packageCapacity |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::packageCapacity |
Stereotype | |
Template Parameter | |
Type | «PQ» Quantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code packageType
“The package type, such as box or bottle.” - HL7 Version 3 (PackagedProduct.formCode)."The kind of container that this package comes as." - HL7 FHIR, Medication.package.container
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | PackagedMedicinalProduct |
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 | packageType |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::packageType |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public MedicinalProductInstance productInstance
Pointer to instances (e.g., particular bottles) of a Packaged Medicinal Product, which will be identified by a serial number or a lot number. For example, if the Packaged Medicinal Product represents all 30-count bottles of Acme Aspirin, this property points to a specific bottle manufactured on Jan. 27th 2016.
Aggregation | None |
Alias | |
Association | packagedMedicinalProduct_productInstance |
Association End | |
Class | PackagedMedicinalProduct |
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 | productInstance |
Name Expression | |
Namespace | PackagedMedicinalProduct |
Opposite | packagedMedicinalProduct |
Owner | PackagedMedicinalProduct |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::CommonProduct::PackagedMedicinalProduct::productInstance |
Stereotype | |
Template Parameter | |
Type | MedicinalProductInstance |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Comments |
| CommonProduct UML Documentation |
Summary:AttributesCommentsProperties | Detail:Attributes |