Skip to main content

HS.SDA3.CodeTableDetail.DrugProduct

serial class HS.SDA3.CodeTableDetail.DrugProduct extends HS.SDA3.CodeTableTranslated

Despite having several extended properties, DrugProduct is still only
matched on Code, Description, and SDACodingStandard in the Viewer Cache.
Properties of the PHCDrgMast will only be set on add or if an inbound
DrugProduct matches an existing PHCDrgMast, but not exactly (capitalization
of Code or Description differs, for example). Properties of the PHCDrgForm
(besides match properties) are always updated when a DrugProduct is
inserted into the Viewer Cache. Properties of the PHCFormDoseEquiv are
included in the matching on PHCDrgForm, so will never be updated, only
inserted.

Property Inventory

Properties

property ATCCode as HS.SDA3.CodeTableDetail.ATCCode;
If the DrugProduct is dispensed as an individual product, this is the ATC
(Anatomic Therapeutic Chemical) code for the product.

SDATableName=ATCCode, ViewerClass=User.HS.PHCSubCat
VIEWERLIB: User.HS.PHCDrgMast(PHCDPHCSCDR)
Property methods: ATCCodeGet(), ATCCodeGetObject(), ATCCodeGetObjectId(), ATCCodeGetSwizzled(), ATCCodeIsEmpty(), ATCCodeIsValid(), ATCCodeNewObject(), ATCCodeSet(), ATCCodeSetObject(), ATCCodeSetObjectId(), ATCCodeUnSwizzle()
property BaseQty as HS.SDA3.Numeric;
If the DrugProduct is dispensed as a Package, this is the quantity (per
dispensing unit) that will be dispensed. For example, BaseQty=3,
BaseUnits=ml, PackageSize=4, PackageSizeUnits=syringes could be a
dispensing unit of a strip of 4x3ml syringes.

VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(PHCDFBaseQty)
Property methods: BaseQtyDisplayToLogical(), BaseQtyGet(), BaseQtyIsValid(), BaseQtyLogicalToDisplay(), BaseQtyNormalize(), BaseQtySet(), BaseQtyXSDToLogical()
property BaseUnits as HS.SDA3.CodeTableDetail.UoM;
If the DrugProduct is dispensed as a package, this is the units of the
BaseQty that will be dispensed. For example, BaseQty=3, BaseUnits=ml,
PackageSize=4, PackageSizeUnits=syringes could be a dispensing unit of a
strip of 4x3ml syringes.

SDATableName=UoM, ViewerClass=User.HS.CTUOM
VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(PHCDFCTUOMDR)
Property methods: BaseUnitsGet(), BaseUnitsGetObject(), BaseUnitsGetObjectId(), BaseUnitsGetSwizzled(), BaseUnitsIsEmpty(), BaseUnitsIsValid(), BaseUnitsNewObject(), BaseUnitsSet(), BaseUnitsSetObject(), BaseUnitsSetObjectId(), BaseUnitsUnSwizzle()
property Code as HS.SDA3.StrippedString (MAXLEN = 32000);
VIEWERLIB: User.HS.PHCDrgMast(PHCDCode)
Property methods: CodeDisplayToLogical(), CodeGet(), CodeIsValid(), CodeLogicalToDisplay(), CodeLogicalToOdbc(), CodeNormalize(), CodeSet(), CodeSystemVersionIdDisplayToLogical(), CodeSystemVersionIdGet(), CodeSystemVersionIdIsValid(), CodeSystemVersionIdLogicalToDisplay(), CodeSystemVersionIdLogicalToOdbc(), CodeSystemVersionIdNormalize(), CodeSystemVersionIdSet(), CodeXSDToLogical()
property Description as HS.SDA3.StrippedString (MAXLEN = 32000);
VIEWERLIB: User.HS.PHCDrgMast(PHCDName)
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet(), DescriptionXSDToLogical()
property DispensedQuantity as HS.SDA3.Quantity;
The quantity of the drug product that was dispensed, expressed as a quantity with units of measure.
Property methods: DispensedQuantityGet(), DispensedQuantityGetObject(), DispensedQuantityGetObjectId(), DispensedQuantityGetSwizzled(), DispensedQuantityIsEmpty(), DispensedQuantityIsValid(), DispensedQuantityNewObject(), DispensedQuantitySet(), DispensedQuantitySetObject(), DispensedQuantitySetObjectId(), DispensedQuantityUnSwizzle()
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
If the DrugProduct is dispensed as an individual product or as a
substitute (generic) product, this is the form of the product.

SDATableName=DrugProductForm, ViewerClass=User.HS.PHCForm
VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(PHCDFPHCFDR)
Property methods: FormGet(), FormGetObject(), FormGetObjectId(), FormGetSwizzled(), FormIsEmpty(), FormIsValid(), FormNewObject(), FormSet(), FormSetObject(), FormSetObjectId(), FormUnSwizzle()
property Generic as HS.SDA3.CodeTableDetail.Generic;
If the DrugProduct is dispensed as a substitute (generic) product, this is
the active substance of the product.

SDATableName=Generic, ViewerClass=User.HS.PHCGeneric
VIEWERLIB: User.HS.PHCDrgMast(PHCDGenericDR)
Property methods: GenericGet(), GenericGetObject(), GenericGetObjectId(), GenericGetSwizzled(), GenericIsEmpty(), GenericIsValid(), GenericNewObject(), GenericSet(), GenericSetObject(), GenericSetObjectId(), GenericUnSwizzle()
property Identifier1 as %String (MAXLEN = 220);
If the DrugProduct is dispensed as an individual product, this is an
alternative identifier for the product.

VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(PHCDFOfficialCode)
Property methods: Identifier1DisplayToLogical(), Identifier1Get(), Identifier1IsValid(), Identifier1LogicalToDisplay(), Identifier1LogicalToOdbc(), Identifier1Normalize(), Identifier1Set()
property Identifier2 as %String (MAXLEN = 220);
If the DrugProduct is dispensed as an individual product, this is an
alternative identifier for the product.

VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(PHCDFRegionCodeFDB)
Property methods: Identifier2DisplayToLogical(), Identifier2Get(), Identifier2IsValid(), Identifier2LogicalToDisplay(), Identifier2LogicalToOdbc(), Identifier2Normalize(), Identifier2Set()
property LabelName as %String (MAXLEN = 220);
VIEWERLIB: User.HS.PHCDrgMast(PHCDLabelName1)
Property methods: LabelNameDisplayToLogical(), LabelNameGet(), LabelNameIsValid(), LabelNameLogicalToDisplay(), LabelNameLogicalToOdbc(), LabelNameNormalize(), LabelNameSet()
property OfficialCode as %String (MAXLEN = 220);
If the DrugProduct is dispensed as a package, this is the official (e.g.
government or standard) ID of the package.

VIEWERLIB: User.HS.PHCDrgMast(PHCDOfficialCode)
Property methods: OfficialCodeDisplayToLogical(), OfficialCodeGet(), OfficialCodeIsValid(), OfficialCodeLogicalToDisplay(), OfficialCodeLogicalToOdbc(), OfficialCodeNormalize(), OfficialCodeSet()
property PackageSize as HS.SDA3.Numeric;
If the DrugProduct is dispensed as a package, this is the number of items
in the package. For example, BaseQty=3, BaseUnits=ml, PackageSize=4,
PackageSizeUnits=syringes could be a dispensing unit of a strip of 4x3ml
syringes.

VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(PHCDFPackageSizeQty)
Property methods: PackageSizeDisplayToLogical(), PackageSizeGet(), PackageSizeIsValid(), PackageSizeLogicalToDisplay(), PackageSizeNormalize(), PackageSizeSet(), PackageSizeUnitsGet(), PackageSizeUnitsGetObject(), PackageSizeUnitsGetObjectId(), PackageSizeUnitsGetSwizzled(), PackageSizeUnitsIsEmpty(), PackageSizeUnitsIsValid(), PackageSizeUnitsNewObject(), PackageSizeUnitsSet(), PackageSizeUnitsSetObject(), PackageSizeUnitsSetObjectId(), PackageSizeUnitsUnSwizzle(), PackageSizeXSDToLogical()
property PackageSizeUnits as HS.SDA3.CodeTableDetail.PackageSizeUoM;
If the DrugProduct is dispensed as a package, this is the units of the
items in the package. For example, BaseQty=3, BaseUnits=ml, PackageSize=4,
PackageSizeUnits=syringes could be a dispensing unit of a strip of 4x3ml
syringes.

SDATableName=PackageSizeUoM, ViewerClass=User.HS.PHCPack
VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(PHCDFPHCPADR)
Property methods: PackageSizeUnitsGet(), PackageSizeUnitsGetObject(), PackageSizeUnitsGetObjectId(), PackageSizeUnitsGetSwizzled(), PackageSizeUnitsIsEmpty(), PackageSizeUnitsIsValid(), PackageSizeUnitsNewObject(), PackageSizeUnitsSet(), PackageSizeUnitsSetObject(), PackageSizeUnitsSetObjectId(), PackageSizeUnitsUnSwizzle()
property ProductName as %String (MAXLEN = 220);
If the DrugProduct is dispensed as a package, this is the full name or
description of the package.

VIEWERLIB: User.HS.PHCDrgMast(PHCDProductName)
Property methods: ProductNameDisplayToLogical(), ProductNameGet(), ProductNameIsValid(), ProductNameLogicalToDisplay(), ProductNameLogicalToOdbc(), ProductNameNormalize(), ProductNameSet()
property Strength as HS.SDA3.CodeTableDetail.Strength;
If the DrugProduct is dispensed as a substitute (generic) product, this is
the strength (group) of the product.

SDATableName=Strength, ViewerClass=User.HS.PHCStrength VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(PHCDFPHCSDR)
Property methods: StrengthGet(), StrengthGetObject(), StrengthGetObjectId(), StrengthGetSwizzled(), StrengthIsEmpty(), StrengthIsValid(), StrengthNewObject(), StrengthQtyDisplayToLogical(), StrengthQtyGet(), StrengthQtyIsValid(), StrengthQtyLogicalToDisplay(), StrengthQtyNormalize(), StrengthQtySet(), StrengthQtyXSDToLogical(), StrengthSet(), StrengthSetObject(), StrengthSetObjectId(), StrengthUnSwizzle(), StrengthUnitsGet(), StrengthUnitsGetObject(), StrengthUnitsGetObjectId(), StrengthUnitsGetSwizzled(), StrengthUnitsIsEmpty(), StrengthUnitsIsValid(), StrengthUnitsNewObject(), StrengthUnitsSet(), StrengthUnitsSetObject(), StrengthUnitsSetObjectId(), StrengthUnitsUnSwizzle()
property StrengthQty as HS.SDA3.Numeric;
If the DrugProduct is dispensed as an individual product, this is the
quantity part of the strength of the product.

VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(ChildPHCFormDoseEquiv)->User.HS.PHCFormDoseEquiv(EQQty)
Property methods: StrengthQtyDisplayToLogical(), StrengthQtyGet(), StrengthQtyIsValid(), StrengthQtyLogicalToDisplay(), StrengthQtyNormalize(), StrengthQtySet(), StrengthQtyXSDToLogical()
property StrengthUnits as HS.SDA3.CodeTableDetail.UoM;
If the DrugProduct is dispensed as an individual product, this is the
units part of the strength of the product.

SDATableName=UoM, ViewerClass=User.HS.CTUOM
VIEWERLIB: User.HS.PHCDrgMast(ChildPHCDrgForm)->User.HS.PHCDrgForm(ChildPHCFormDoseEquiv)->User.HS.PHCFormDoseEquiv(EQCTUOMDR)
Property methods: StrengthUnitsGet(), StrengthUnitsGetObject(), StrengthUnitsGetObjectId(), StrengthUnitsGetSwizzled(), StrengthUnitsIsEmpty(), StrengthUnitsIsValid(), StrengthUnitsNewObject(), StrengthUnitsSet(), StrengthUnitsSetObject(), StrengthUnitsSetObjectId(), StrengthUnitsUnSwizzle()
If the DrugProduct is dispensed as an individual product, this is the type
of product.

SDATableName=DrugProductType, ViewerClass=User.HS.PHCType
VIEWERLIB: User.HS.PHCDrgMast(PHCDTypeDR)
Property methods: TypeGet(), TypeGetObject(), TypeGetObjectId(), TypeGetSwizzled(), TypeIsEmpty(), TypeIsValid(), TypeNewObject(), TypeSet(), TypeSetObject(), TypeSetObjectId(), TypeUnSwizzle()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab