OverviewTopPackageElement
CommonProduct UML Documentation

CommonProduct

The FHIM Common Product Model contains those classes necessary to describe manufactured goods that are used in the health domain. These products can potentially be ordered, purchased, consumed, administered, maintained, and/or disposed of in the course of providing healthcare or conducting public health – related activities (e.g., food safety, disease outbreak detection and management). In addition, these products may themselves be the subject of laboratory tests for sterilization testing.
This domain closely follows the HL7 V3 Common Product Model which is intended to address all of the above uses but also is used to describe products from a regulatory viewpoint. In an EHR, much of this information would be retrieved from a knowledge base such as RxNorm or GUDID. For example, if you know you have a Pfizer Lipitor 40 MG Tablet, you know that it is in a tablet form and that it contains 40 mg of Atorvastatin, which is an HMG-CoA Reductase Inhibitor. All this can be found out by accessing RxNorm, therefore you may not store this information in an EHR or send it in a message. Nevertheless, the FHIM includes these structures in order to provide a consistent way to represent these concepts as regardless of how the information is obtained, systems will still need to reason over these concepts.

CommonProduct
biologicProduct biologicRequest biologicProduct biologicRequest biologicProduct biologicProduct biologicRequest biologicRequest biologicRequest_biologicProduct Polyline coordinates describing hotspot on the image manipulation Property manipulation Property manipulation manipulation Property Property biologicProductInstance_manipulation Polyline coordinates describing hotspot on the image parent Property parent Property parent parent Property Property biologicProductInstance_parent Polyline coordinates describing hotspot on the image biologicProductInstance biologicProduct biologicProductInstance biologicProduct biologicProductInstance biologicProductInstance biologicProduct biologicProduct biologicProduct_biologicProductInstance Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image implantedDevice Property implantedDevice Property implantedDevice implantedDevice Property Property patient_implantedDevice Polyline coordinates describing hotspot on the image substanceIngredient Property substanceIngredient Property substanceIngredient substanceIngredient Property Property substance_substanceIngredient Polyline coordinates describing hotspot on the image substanceInstance Property substanceInstance Property substanceInstance substanceInstance Property Property substance_substanceInstance Polyline coordinates describing hotspot on the image ingredientSubstance Property ingredientSubstance Property ingredientSubstance ingredientSubstance Property Property substanceIngredient_ingredientSubstance Polyline coordinates describing hotspot on the image foodIngredient Property foodIngredient Property foodIngredient foodIngredient Property Property foodProduct_foodIngredient Polyline coordinates describing hotspot on the image device Property device Property device device Property Property deviceUseStatement_device Polyline coordinates describing hotspot on the image location Property location Property location location Property Property deviceInstance_location Polyline coordinates describing hotspot on the image owner Property owner Property owner owner Property Property deviceInstance_owner Polyline coordinates describing hotspot on the image udi Property udi Property udi udi Property Property deviceInstance_udi Polyline coordinates describing hotspot on the image patient Property patient Property patient patient Property Property deviceInstance_patient Polyline coordinates describing hotspot on the image deviceCalibration Property deviceCalibration Property deviceCalibration deviceCalibration Property Property deviceMetric_deviceCalibration Polyline coordinates describing hotspot on the image parent Property parent Property parent parent Property Property deviceMetric_parent Polyline coordinates describing hotspot on the image source Property source Property source source Property Property deviceMetric_source Polyline coordinates describing hotspot on the image Dependency Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image ingredientSubstance Property ingredientSubstance Property ingredientSubstance ingredientSubstance Property Property foodIngredient_ingredientSubstance Polyline coordinates describing hotspot on the image manufacturingLot Property manufacturingLot Property manufacturingLot manufacturingLot Property Property foodProductInstance_manufacturingLot Polyline coordinates describing hotspot on the image foodProductInstance foodProduct foodProductInstance foodProduct foodProductInstance foodProductInstance foodProduct foodProduct foodProduct_foodProductInstance Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image deviceInstance Property deviceInstance Property deviceInstance deviceInstance Property Property implantedDevice_deviceInstance Polyline coordinates describing hotspot on the image productionSpecification Property productionSpecification Property productionSpecification productionSpecification Property Property deviceComponent_productionSpecification Polyline coordinates describing hotspot on the image parent Property parent Property parent parent Property Property deviceComponent_parent Polyline coordinates describing hotspot on the image source Property source Property source source Property Property deviceComponent_source Polyline coordinates describing hotspot on the image deviceComponent Property deviceComponent Property deviceComponent deviceComponent Property Property deviceInstance_deviceComponent Polyline coordinates describing hotspot on the image organization Property organization Property organization organization Property Property deviceInstance_organization Polyline coordinates describing hotspot on the image reprocessor Property reprocessor Property reprocessor reprocessor Property Property deviceInstance_reprocessor Polyline coordinates describing hotspot on the image organization Property organization Property organization organization Property Property labeler_organization Polyline coordinates describing hotspot on the image organization Property organization Property organization organization Property Property manufacturer_organization Polyline coordinates describing hotspot on the image manufacturingLot Property manufacturingLot Property manufacturingLot manufacturingLot Property Property deviceInstance_manufacturingLot Polyline coordinates describing hotspot on the image manufacturingLot Property manufacturingLot Property manufacturingLot manufacturingLot Property Property medicinalProductInstance_manufacturingLot Polyline coordinates describing hotspot on the image productInstance Property productInstance Property productInstance productInstance Property Property administeredDrug_productInstance Polyline coordinates describing hotspot on the image pharmacyManufacturedProduct Property pharmacyManufacturedProduct Property pharmacyManufacturedProduct pharmacyManufacturedProduct Property Property administeredDrug_pharmacyManufacturedProduct Polyline coordinates describing hotspot on the image productInstance Property productInstance Property productInstance productInstance Property Property medicinalProductInstance_productInstance Polyline coordinates describing hotspot on the image drugPricing Property drugPricing Property drugPricing drugPricing Property Property medicinalProductInstance_drugPricing Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image productInstance Property productInstance Property productInstance productInstance Property Property additive_productInstance Polyline coordinates describing hotspot on the image additive Property additive Property additive additive Property Property pharmacyManufacturedProduct_additive Polyline coordinates describing hotspot on the image productInstance Property productInstance Property productInstance productInstance Property Property vehicle_productInstance Polyline coordinates describing hotspot on the image vehicle Property vehicle Property vehicle vehicle Property Property pharmacyManufacturedProduct_vehicle Polyline coordinates describing hotspot on the image pharmacyManufacturedProduct Property pharmacyManufacturedProduct Property pharmacyManufacturedProduct pharmacyManufacturedProduct Property Property dispensedDrug_pharmacyManufacturedProduct Polyline coordinates describing hotspot on the image productInstance Property productInstance Property productInstance productInstance Property Property dispensedDrug_productInstance Polyline coordinates describing hotspot on the image ingredientSubstance Property ingredientSubstance Property ingredientSubstance ingredientSubstance Property Property drugIngredient_ingredient Polyline coordinates describing hotspot on the image ingredient medicinalProduct ingredient medicinalProduct ingredient ingredient medicinalProduct medicinalProduct medicinalproduct_ingredient Polyline coordinates describing hotspot on the image deviceInstance device deviceInstance device deviceInstance deviceInstance device device device_deviceInstance Polyline coordinates describing hotspot on the image productInstance packagedMedicinalProduct productInstance packagedMedicinalProduct productInstance productInstance packagedMedicinalProduct packagedMedicinalProduct packagedMedicinalProduct_productInstance Polyline coordinates describing hotspot on the image labeler Property labeler Property labeler labeler Property Property packagedMedicinalProduct_labeler Polyline coordinates describing hotspot on the image manufacturer Property manufacturer Property manufacturer manufacturer Property Property packagedMedicinalProduct_manufacturer Polyline coordinates describing hotspot on the image packagedMedicinalProduct medicinalProduct packagedMedicinalProduct medicinalProduct packagedMedicinalProduct packagedMedicinalProduct medicinalProduct medicinalProduct medicinalProduct_packagedMedicinalProduct Polyline coordinates describing hotspot on the image genericMedicine product genericMedicine product genericMedicine genericMedicine product product medicinalproduct__genericMedicine Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image drugClass Property drugClass Property drugClass drugClass Property Property medicinalproduct_drugClass Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image product Property product Property product product Property Property orderablePharmacyItem_product Polyline coordinates describing hotspot on the image specializationOf Property specializationOf Property specializationOf specializationOf Property Property product_specializationOf Polyline coordinates describing hotspot on the image equivalentTo Property equivalentTo Property equivalentTo equivalentTo Property Property product_EquivalentTo Polyline coordinates describing hotspot on the image request quantity RequestedBiologic time description Manipulation storage processing identifier collection BiologicProductInstance availabilityStatus category BiologicProduct quantity SubstanceIngredient quantity identifier expiry SubstanceInstance quantity FoodIngredient timing reasonReference reasonCode derivedFrom bodySite basedOn DeviceUseStatement name jurisdiction issuer entryType deviceIdentifier carrierHRF carrierAIDC UniqueDeviceIdentifier Patient time state kind DeviceCalibration unit operationalStatus measurementPeriod kind identifier color category DeviceMetric Transseptal Needle Tapercut Needle Swaged Needle Suture Needle Stop Needle Spatula Needle Silverman Needle Scalp Vein Needle Round Bodied Needle Rosenthal Needle Reverse Cutting Needle Reverdin's Needle Menghini Needle Ligature Needle Hypodermic Needle Hagedorn's Needle Fistula Needle Discission Needle Cataract Needle Blunt-point Needle Atraumatic Needle Aspiration Biopsy Needle Aspirating Needle Aneurysm Needle Acupuncture Needle NeedleType type length gauge Needle Comment FoodProductInstance FoodProduct specType productionSpec componentId ProductionSpecification isReusedDevice isReprocessedDevice implantDate explantDate ImplantedDevice softwareName parameterGroup operationalStatus measurementPrinciple lastSystemChange languageCode kind identifier DeviceComponent Comment Comment Comment Comment Comment Comment identifier Reprocessor telecom name kind isActive alias address Organization Comment Comment Comment Comment telecom serviceType name identifier dateRange category address ServiceDeliveryLocation lotSize lotId expirationDate ManufacturingLot administrationTagId administeredBarcodeId AdministeredDrug dateActivated ProductActivation basisOfCostDetermination DrugPricing activity NuclearMedicine amount Additive volume Vehicle preparationTime doseForm dispenseUnitType description componentCount LocallyManufacturedProduct dispenseTagId isCompounded DispensedDrug status kind identifier description category Substance quantity isPreservative isDiluent isConfidential isAdjuvant isAntigen isActiveMoiety effectiveTime DrugIngredient url status safety softwareName note localRemoteControlState identifier dateManufactured dateLastCalibrated dateDisposed dateAcquired contact alertLevel DeviceInstance unitPrice storageCondition identifier MedicinalProductInstance identifier Labeler mvx name identifier Manufacturer packageType packageCapacity nationalDrugCode name description codeModifier code capType PackagedMedicinalProduct newDrugApplicationId isOverTheCounter investigationalNewDrugId controlledSubstanceSchedule auxilliaryLabel MedicinalProduct version name modelName modelId commonDeviceName cataloglId Device code DrugClass OrderablePharmacyItem code MaterialCategory name code GenericMedicine status shelfLife riskCode kind handlingCode formCode fdaProductCode description brandName Product Comment

Classifiers
Additive Additive
AdministeredDrug AdministeredDrug
BiologicProduct BiologicProduct
BiologicProductInstance BiologicProductInstance
Device Device
DeviceCalibration DeviceCalibration
DeviceComponent DeviceComponent
DeviceInstance DeviceInstance
DeviceMetric DeviceMetric
DeviceUseStatement DeviceUseStatement
DispensedDrug DispensedDrug
DrugClass DrugClass
DrugIngredient DrugIngredient
DrugPricing DrugPricing
FoodIngredient FoodIngredient
FoodProduct FoodProduct
FoodProductInstance FoodProductInstance
GenericMedicine GenericMedicine
ImplantedDevice ImplantedDevice
Labeler Labeler
LocallyManufacturedProduct LocallyManufacturedProduct
Manipulation Manipulation
Manufacturer Manufacturer
ManufacturingLot ManufacturingLot
MaterialCategory MaterialCategory
Medication Product Form Value Set Medication Product Form Value Set
Medication Type Value Set Medication Type Value Set
Medication Vehicle Value Set Medication Vehicle Value Set
MedicinalProduct MedicinalProduct
MedicinalProductInstance MedicinalProductInstance
Needle Needle
NeedleType NeedleType
NuclearMedicine NuclearMedicine
OrderablePharmacyItem OrderablePharmacyItem
PackagedMedicinalProduct PackagedMedicinalProduct
Product Product
ProductActivation ProductActivation
ProductionSpecification ProductionSpecification
Reprocessor Reprocessor
RequestedBiologic RequestedBiologic
Substance Substance
SubstanceIngredient SubstanceIngredient
SubstanceInstance SubstanceInstance
UniqueDeviceIdentifier UniqueDeviceIdentifier
Vehicle Vehicle
VocabContext VocabContext

Diagrams
CommonProduct CommonProduct

Properties:

Alias
Keywords
NameCommonProduct
Name Expression
NamespaceFHIM
Nesting PackageFHIM
Owned Template Signature
OwnerFHIM
Owning Template Parameter
Qualified NameFHIM::CommonProduct
Stereotype
Template Parameter
VisibilityPublic
OverviewTopPackageElement
CommonProduct UML Documentation