Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
HMedDrugService This table stores the Drug Details imported from Drug Database (FDB-US , ID-Berlin etc) and links to Service Definition in Soarian's Service Catalog
Column Name Column Datatype Column Null Option Column Comment
ObjectIDintNOT NULL Object Identifier of this record. This field is a primary key for the associated table.
InstanceHFCIDsmallintNOT NULL Healthcare Foundation Class(HFC) Identifier of the object.HFCID of this object is 1143. The value specified in the ObjectID field and in this field enables unique identification of an object instance across the application.
RecordIdintNULL Not Valued in this table. Column exists as part of persistence framework implementation.
Descriptionvarchar(1)NULL Not Valued in this table. Column exists as part of persistence framework implementation.
IsDeletedtinyintNOT NULL Specifies whether the record is soft deleted.
Allowable Values
0 - Active
1 - Marked as Deleted.
Note: The presence of this field in tables depends on the configuration at the time of table design.
IsVersionedbitNOT NULL Whether the table data is Versioned or not.
Allowable Values:
0 - No version data captured.
1 - Version changes available in _Ver table.
Once this field is set to 1, you cannot reset it to 0. If value is 1 , the current row represents the latest state , and all version data will be present in another table with the name HMedDrugService_Ver.
Note: The presence of this field in tables depends on the configuration at the time of table design.
CreatedUserIdintNULL Object ID of the logged in user who created this record.
This field is linked to HSUser table to get details about the user. For more information see description of HSUser table
CreationTimesmalldatetimeNULL Date and time when the record is created.
StartDateTimedatetimeNOT NULLDate and time when the drug service is active from Soarian's Service Catalog.
GenericNamevarchar(95)NOT NULLGeneric name of the medication. The generic name is populated from Drug Database(NDDF - National Drug Data File for US Clients , ID-Berlin for EU Clients). All drug services have generic names.
StopDateTimedatetimeNULL Date and time when the drug service is no longer valid.
BrandNamevarchar(65)NULL Brand name of the medication.
All medications have a generic name and a brand name. The brand name is populated from Drug Database(NDDF - National Drug Data File for US Clients , ID-Berlin for EU Clients) . All packaged medications have brand names.
OfficialDrugCodevarchar(32)NULL Nationally(or regionally) recognized drug identifier for a dispensable packaged drug.
IsClinicallyEquivalentbitNULL When set to 1, indicates that the drug code has a suffix and it can be removed without changing its meaning.
Allowable Value
0 - False
1 - True
DrugCodevarchar(32)NOT NULLUnique code associated with the medication.
DrugLeveltinyintNOT NULLLevel of description for the medication.
Allowable Values:
0 - medDrugBrand
1 - medDrugRoute
2 - medDrugForm
3 - medDrugStrength
4 - medDrugPackage
5 - medDrugNDC
ObsoleteDateTimedatetimeNULL Date and time when the drug service is no longer available for selection or processing.
DrugServiceStatustinyintNOT NULLStatus of the drug service.
Allowable Values:
0 - Active
1 - Inactive
2 - Obsolete
DrugTypetinyintNOT NULLType of medication.
Allowable Values:
0 - meddtMed
1 - meddtSolution
2 - meddtAdditive
3 - meddtMedAdditive
4 - MeddtPremix
VitalsToCollectvarchar(170)NULL Abbreviation set for the vitals required to be collected prior to administering the medication. These vitals must be collected before the nurse administers the medication. Refer to the following abbreviation set for a vital collected and the associated description.
Allowable Values:
BP - Blood Pressure
PULSE - Pulse
TEMP - Temperature
RS - Respiration
BS - Blood Sugar
PS - Pain Scale
PSL - Pain Scale Location
PackageNamevarchar(128)NULL Packaged name of the medication.
PackageSizevarchar(32)NULL Package size of the medication.
PackageUnitStringvarchar(20)NULL Package unit of the medication.This field will contain internationalized string.
PackageUnitCodevarchar(16)NULL Code associated with the package unit of the medication. Value won't be internationalized and business logic can be written on the coded values.
Suppliervarchar(32)NULL Supplier of the medication.The supplier is populated from Drug Database
Strengthvarchar(15)NULL Strength of the medication. If the strength of a medication is high, it indicates that the medication has higher capability.
As an example, Bob takes 250 mg erythromycin four times a day to cure his throat infection. If Bob's doctor increases the drug strength to 500 mg, he will then take it only twice a day.
StrengthUnitStringvarchar(20)NULL Unit of the strength of the medication.This field will contain internationalized string.
StrengthUnitCodevarchar(16)NULL Code associated with the unit of the strength of the medication. Value won't be internationalized and business logic can be written on the coded values.
RouteCodevarchar(15)NULL Code associated with the route. The route indicates the manner in which the medication should be taken. This route is populated from Drug Database.
DoseFormvarchar(32)NULL Form of dosage of the medication. eg Tablet, Capsule etc
EnteredBy_oidintNULL ObjectID of the user who entered this record in Soarian Catalog. Usually this field is valued when Catalog is being updated using Med Formulary transactions from Pharmacy system.
HealthCareUnit_oidintNULL ObjectID of HealthCareUnit where the Detail of the Service is configured. Usually all medications are configured only at Enterprise level.
Service_oidintNOT NULLValue stored as a result of a one-to-one relationship between HMedDrugService and HService.
CatalogIDintNOT NULLCatalog Identifier of the record in HMedDrugCatalogues that contains information about the drug database vendor.
Parent_oidintNULL ObjectID stored as a result of a self relationship in HMedDrugService. Routed Med will have this field valued as null , where as Package Med created out of the Routed Med will have the ObjectID of Routed Med in this field. One routed drug can have many packaged drugs.
FormularyStatusvarchar(64)NULL Formulary status of the medication. The formulary status indicates if the medication is under investigation or is in use in the hospital.
Allowable Values:
Formulary
Non-formulary
Investigation
Therap Eval.
InappropriateRoutesvarchar(MAX)NULL List of delimited routes that are inappropriate for administering the medication. The delimiter used is "\".
DrugServiceNamevarchar(128)NOT NULLUnique name of the drug service in Soarian Catalog.
DrugServiceAbbreviationvarchar(16)NOT NULLAbbreviation of the unique name of the drug service in Soarian Catalog.
DrugClassvarchar(2)NULL Indicates the classification that determines how narcotic the medication is.
GenericOrBrandNametinyintNOT NULLWhen set to 1, indicates that the drug service is a brand level(packaged) service.
Allowable Values:
0 - Generic
1 - Packaged(Brand)
AdminCoSignRequiredtinyintNOT NULLWhen set to 1, indicates that cosignatory's signature is required to carry out the drug service.
Allowable Values:
0 - Cosignatory's signature not required
1 - Cosignatory's signature required
AdminCoSignRequiredReasonvarchar(64)NULL Reason why the cosignatory's signature is required to carry out the drug service.
RouteStringvarchar(64)NULL Manner in which the medication should be taken. This route is populated from Drug Database.
TheraputicCodevarchar(8)NULL Classification system of how the medication is used.
OAWOverridetinyintNULL DEFAULT(0 Indicates the name that would be used for the Order as written concatenation on the picklist.
Allowable Values:
0 - Generic name or brand name
1 - Service name
ServiceTypeOIDintNOT NULLOne to one relationship with the service type(HServiceType) associated with this entry
ServiceSubTypeoidintNULL One to one relationship with the service sub type associated with this entry
RoundingRulechar(6)NOT NULL Rule on how rounding will be applied for the calculated volume.
Allowable Values:
None
Up
Down
NoOfDigitsAfterDecimalsmallintNOT NULLSpecifies how many numbers appear on the right side of the decimal.
VolumeVarchar(6)NULL Total volume of medication required to carry out the service.
VolumeUnitVarchar(12)NULL Unit of the total volume of medication required to carry out the service. For example, ml(milliliters)
VolumeUnitCodeVarchar(16)NULL Unit code of the volume.
DefaultUnitchar(1)NULL Specifies whether the default unit for this medication is Strength or Volume
Allowable Values:
D - Strength
V - Volume
LimitSearchToNameOnlysmallintNOT NULL Specifies how this medication record is searched in Clinical work flow
Allowable Values:
0 - Full Search
1 - Limited to servicename
IsAutoProfiledtinyintNOT NULL The drug product is enabled for auto-profiling.
Allowable values
0 - No
1 - Yes
IsUnitDoseDispensedtinyintNOT NULL The drug product is available in the automatic dispensing system.
Allowable values
0 - No
1 - Yes
2 - Undetermined
DeliverySourcevarchar(3)Not Null Specifies how drug is stocked.
Allowable values
AN:filled from ancillary dept stock
FL:filled from floor stock.
RetrospectiveReviewReqdtinyintNULL Indicates if the drug product is enabled for Retrospective Review.
Allowable values
NULL or 0 - No
1 - Yes
FormularyStatusCodesmallintNULL To store the ItemCode from HDataDictionaryItem table, of the formulary status.
Allowable values
0 - Formulary
1 - Non-formulary
2 - Investigation
3 - Therap Eval.
IndicationRequiredCodetinyintNULL Mandatory-ness setting for Indication.
Allowable value
2 - Mandatory
1 - Optional
0 or NULL - Not Available
ATCCodeUSvarchar(8)NULL Drug's Anatomical Therapeutic Chemical(ATC) Classification code, as developed by the World Health Organization(WHO).
Note: This column is only used in a US environment because the TheraputicCode column(which contains the ATC code in a European environment) may contain FDB's Hierarchical Specific Therapeutic Class Code(HIC3).
LastCngDtimeDATETIMENOT NULLCurrent Universal Time Coordinate or Greenwich Mean Time

Return to Table-Index

  Soarian Clinicals Schema Documentation  
Copyright © 2023, Oracle and/or its affiliates