Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
HMedOrderH This table stores history of medication order data
Column Name Column Datatype Column Null Option Column Comment
ObjectIDintNOT NULL The object ID of the medication order object. This field is always a primary key for the associated table
InstanceHFCIDsmallintNOT NULL The HFC(Healthcare Foundation Class) ID of the object(1131). Note: The value specified in the ObjectID field and in this field enables unique indentification of an object across the application
RecordIdintNULL The record ID. Not valued in this table. Column exists as part of persistence framework implementation
Descriptionvarchar(1)NULL User-defined information provided by the modules in the application. Note: The length of this field varies with tables. Not valued
IsDeletedtinyintNOT NULL When set to 1, the object is deleted. Note: The presence of this field in tables depends on the configuration at the time of table design
IsVersionedtinyintNOT NULL When set to True, the object is modified. Once this field is set to True, you cannot reset it to False. If this field is set to True in the table, another table with the name HMedOrderH _Ver is created. Note: The presence of this field in the table depends on the configuration at the time of table design. Allowable Values: 0 - False, 1 - True
CreatedUserIdintNULL The object ID of the user who created the object. This field is linked to HSUser table to get details about the user.
CreationTimesmalldatetimeNULL The date and time when the object was created
ValidFromdatetimeNOT NULL The Date/Time from when the current record became valid
ValidTodatetimeNULL The Date/Time the current record became invalid
InternalIDintNULL The object ID of the order as specified in HOrder table
ExternalIDvarchar(6)NULL The ID of the order sent by the pharmacy system
MedOrderStatustinyintNOT NULL The status of the medical order
Allowable Values:
0 - medosDraft
1 - medosInactive
2 - medosActive
3 - medosSuspendedFromInactive
4 - medosSuspendedFromActive
5 - medosSuspendedFromInProgress
6 - medosInProgress
7 - medosInvalid
8 - medosCancelled
9 - medosDiscontinued
10 - medosComplete
11 - MedosPendingActivation
OrderAsWrittenvarchar(650)NOT NULL The vital information pertaining to an order and as written by the physician
MedOrderTypetinyintNOT NULL The type of medical order
Allowable Values:
0 - medotSimpleMed
1 - medotComplexMed
2 - medotSlidingDoseMed
3 - medotTaperDoseMed
4 - medotDifferDoseMed
5 - medotExtraDoseMed
6 - medotRegularIV
7 - medotPCAIV
8 - medotFreeText
9 - medotRX
StartDateTimedatetimeNOT NULL The date and time from when the order is valid
StopDateTimedatetimeNULL The date and time when the order is no longer valid
MedOrderStatusModifiervarchar(30)NULL The modifier associated with the medical order status. A modifier that the medical order status has been altered by specific circumstances, but unchanged in its definition or code
DurationintNULL The duration for which the order was valid
DischargeIndicatortinyintNOT NULL When set to 1, the patient has been discharged or will be discharged soon. Allowable Values: 0 - Not a prescription order, 1 - Prescription(take home) order
IVMethodCodetinyintNULL The code associated with the method by which IV is administered to the patient
Allowable Values:
0 - PUSH
1 - ALTLVP(Alternating LVP)
2 - ALTTPN
3 - KVO
4 - PLAIN
5 - LVP
6 - TPN
7 - PIGBCK(Piggyback)
8 - ENTRL
9 - PLIRR(Plain Irrigation)
10 - IRR(Irrigation)
PRNIndicatortinyintNOT NULL When set to 1, the medication can be administered to the patient, if needed. Allowable Values: 0 - Non-PRN order, 1 - PRN order(PRN means medication can be administered as needed)
PriorityCodetinyintNOT NULL The code associated with the priority of the order. Allowable Values: 0 - medpriStat, 1 - medpriRoutine, 2 - medpriStatRoutine
TotalVolumevarchar(30)NULL The volume of an IV bottle
TotalVolumeUnitStringvarchar(20)NULL The unit of the total volume of the bottle from which IV was administered. For example, ml
Ratevarchar(8)NULL The drip rate of the IV to be administered
RateUnitStringvarchar(20)NULL The unit of the drip rate of the IV to be administered
RunInvarchar(8)NULL The period for which the IV should be administered
Refillsvarchar(4)NULL The number of refills that the pharmacist can use to expedite the order
Directionsvarchar(256)NULL The directions(such as shake well before administering) specified by the physician to process the order
CoSignLevelRequiredintNOT NULL A signature is required from an authority, of a certain level, other than the one specified to activate the order
PerformedByPatienttinyintNOT NULL When set to 1, the order is carried out by the patient himself. Allowable Values: 0 - Order is not carried out by patient, 1 - Order is carried out by patient
RequestedBy_oidintNULL Object ID of the user who requested the medication order(HStaff)
SignedBy_oidintNULL Object ID of the user who signed the medication order(HStaff)
EnteredBy_oidintNOT NULL Object ID of the user who entered details about the medication order(HStaff)
Patient_oidintNOT NULL Object ID for the Patient(HPatient)
PatientVisit_oidintNULL Object ID for the Patient's Visit(HPatientVisit)
MedOrderSet_oidintNOT NULL Object ID for the medication order set containing the current order(HMedOrderSet)
DurationUnitStringvarchar(9)NULL The unit of the duration of the medication order
CalculatedStopDateTimedatetimeNOT NULL The calculated end date and time of the order
PRNReasonvarchar(64)NULL The reason for carrying out a PRN order. A PRN order that the medication is administered only if necessary
PCAAdditionalDosevarchar(20)NULL The additional dose that the patient can give themselves with one push. PCA(Patient Controlled Analgesic) is a type of IV medication order where the patient controls the amount of analgesic or painkiller that is dispensed. A special pump regulates the given amount
Reasonvarchar(120)NULL The reason for carrying out the order
PrintPrescriptiontinyintNOT NULL When set to 1, the prescription will be printed when the order associated with it is signed. Allowable Values: 0 - Prescription will not be printed, 1 - Prescription will be printed
SubstitutiontinyintNOT NULL When set to 1, the component, associated with the order, can be substituted. The components may be substituted for clinical reasons, as a hospital policy, or because of preference for certain brands. Allowable Values: 0, 1 Key of allowable values: 0 - Substitution allowed, 1 - Substitution not allowed
SubstitutionReasonvarchar(64)NULL The reason for substituting the component associated with the order
RunInUnitStringvarchar(20)NULL The unit for the total infusion run-in time of the bottle in which IV was administered
TitrateInstructionvarchar(32)NULL The instructions that should be followed when administering an IV that is titrated. For example, Run in till patient condition stabilizes
ChemoIndicatortinyintNOT NULL The order is a Chemo order. Allowable Values: 0 - Not an Chemo order, 1 - Chemo order
PCAAdditionalDoseUnitStringvarchar(20)NULL The unit of the additional dose that the patient can give himself with one push
PCADelayIntervalvarchar(12)NULL The time interval between two pushes to administer dose
PCADelayIntervalUnitStringvarchar(20)NULL The unit of the time interval between two pushes to administer dose
PCALockoutDosevarchar(20)NULL The maximum dose that the patient can administer himself with one push
PCALockoutDoseUnitStringvarchar(20)NULL The unit of the maximum dose that the patient can administer himself with one push
PCALockoutTimevarchar(12)NULL The maximum time the patient can take to administer himself a dose with one push. The amount of dose(as specified in PCALockoutDose field) can never exceed the lock out time
PCALockoutTimeUnitStringvarchar(20)NULL The unit of the maximum time the patient can take to administer a dose to himself with one push
RequestorUnit_oidintNULL The object ID of the unit that requested the medication order
ProviderUnit_oidintNULL The object ID of the unit that the provider was assigned to
NbrOfSignaturesintNOT NULL The number of signatures required to activate the order
PRNConditionvarchar(32)NULL The conditions for carrying out a PRN order
LinkTypetinyintNULL The type of relation to the original order. Allowable Values: 0, 1, or NULL Key of allowable values: 0 - medoltRevise, 1 - medoltRenew
TotalVolumeUnitCodevarchar(16)NULL The code associated with the unit of the total volume of the bottle from which IV was administered
RateUnitCodevarchar(16)NULL The code associated with the unit of the drip rate of the bottle from which IV was administered
RunInUnitCodevarchar(16)NULL The code associated with the unit for the total infusion run-in time of the bottle in which IV was administered
PCALockoutTimeUnitCodevarchar(16)NULL The code associated with the unit of the maximum time the patient can take to administer himself a dose with one push
PCALockoutDoseUnitCodevarchar(20)NULL The code associated with the maximum dose that the patient can administer himself with one push
PCADelayIntervalUnitCodevarchar(16)NULL The code associated with the time interval between two pushes to administer dose
PCAAdditionalDoseUnitCodevarchar(20)NULL The code associated with the unit of the additional dose that the patient can give himself with one push
DurationUnitCodeintNULL The code associated with the unit of the duration of the medication service
OrderTypeFormIDintNULL The form ID of the order type level form
OrderTypeFormInstDTdatetimeNULL The date and time when the order type level form is instantiated
DepTypeFormIdintNULL The form ID of the department level form
DepTypeFormInstDTdatetimeNULL The date and time when the department level form is instantiated
MustReviewtinyintNOT NULL When set to 1, That the medication order must be reviewed. Allowable Values: 0 - Need not be reviewed, 1 - Must be reviewed
ActSignedNumberintNOT NULL The number of signatures that are counted to activate the order
CoSignedNumberintNOT NULL The number of countersignatures that are counted to activate the order
IsCoSignedtinyintNOT NULL When set to 1, the order is countersigned by an authorized signatory other than the specified signatory. Allowable Values: 0 - Not countersigned, 1 - Countersigned
ActivateLevelRequiredintNOT NULL The level of signature required to activate the order
CoSignRequiredtinyintNOT NULL When set to 1, That the order needs to be countersigned to be activated. Allowable Values: 0 - Need not be countersigned, 1 - Need to be countersigned
IsDripIVtinyintNULL When set to 1, The order is a drip IV order. Allowable Values: 0, 1, or NULL Key of allowable values: 0 - Not a drip IV order, 1 - Drip IV order
DripIVStartingDosevarchar(30)NULL The dose required to start a medication service
DripIVStartingDoseUnitStringvarchar(20)NULL The unit of the dose required to start a medication service
DripIVStartingDoseUnitCodevarchar(20)NULL The code associated with the unit of the dose required to start a medication service
PriorityStringvarchar(20)NULL The priority of the medication service. Allowable Values: STAT, Routine, STATRoutine, or NULL
PCALoadingDosevarchar(30)NULL The initial dose for the PCA(Patient Controlled Analgesic) order
PCALoadingDoseUnitStringvarchar(20)NULL The unit of the dose for the PCA order
PCALoadingDoseUnitCodevarchar(20)NULL The code associated with the unit of the dose for the PCA order
IVMethodStringvarchar(32)NULL Indicates an explanatory text of the IV method used for UI presentation
IsCreatedFromOrderSettinyintNOT NULL When set to 1, the order is created for an order set. Allowable Values: 0 - Not created from order set, 1 - Created from order set
OriginalOrderIDintNULL The order ID before the order is modified
IsRenewedtinyintNOT NULL When set to 1, That the order is renewed. Allowable Values: 0 - Not renewed, 1 - Renewed
OrderHistoryGroupIDintNULL The object ID of the group that contains the order history(such as modifications made to the order)
MedFunctionCodetinyintNOT NULL The code associated with the medication functions that can be carried out on orders.
Allowable values:
0 - Undefined
1 - Acknowledged
2 - Discontinue
3 - Suspend
5 - Resume
6 - Renew
7 - Revise
8 - Complete
10 - InProgress
12 - Cosign
14 - Cancel
19 - NewOrder
20 - CosignAdministration
21 - ChartAdministration
22 - MoveVisit
23 - MergePatient
24 - Invalid
25 - Active
30 - Validate
42 - RejectCosign
43 - FutureDiscontinue
44 - TrueRevise
45 - DoNotRenew
46 - Continue
52 - Review
53 - ShiftIV
54 - Shift
55 - ReviewEUHomeMeds
MedOrderStatusDateTimedatetimeNULL The date and time when the status of the order is recorded
RuleInvokeCounterintNOT NULL The counter on how many times the rule has been invoked for the order
RequestStringvarchar(64)NULL The reason for requesting the order
RequestCodeintNULL The code associated with the reason for requesting the order
VerbalIndicatortinyintNULL When set to 1, That the order is a verbal order. Allowable Values: 0 - Not a verbal order, 1 - Verbal order
ServiceRequestedBy_StaffNamevarchar(188)NULL The name of the staff who has requested the service
ServiceRequestorHCU_HCUAbbrevvarchar(75)NULL The healthcare unit that is the requestor of the service
ProblemStringvarchar(64)NULL The name of the problem(patient's ailment) associated with the order
ProblemCodeintNULL The code associated with the problem
DispensedAmountvarchar(32)NULL The dosage of medication that should be dispensed to the patient
WorkstationIDvarchar(30)NULL The ID of the workstation from where the user placed, managed, or revised the order
AdministeredOvervarchar(30)NULL The rate at which the IV order is administered. This field is used to calculate the rate by the following formula. Rate = AdministeredVolume(ml) / AdministeredOver(hr)
AdministeredOverUnitvarchar(20)NULL The unit of the administered-over time for the IV order
AdministeredOverUnitCodevarchar(16)NULL The code associated with the unit of the administered-over time for the IV order
AdministeredVolumevarchar(30)NULL The volume of the administered IV order
AdministeredVolumeUnitvarchar(20)NULL The unit of the volume of the administered IV order
AdministeredVolumeUnitCodevarchar(16)NULL The code associated with the unit of the volume of the administered IV order
EndTypetinyintNOT NULL The manner in which the order ends.
Allowable Values: 0 - Open-ended order
1 - On(ended by stop date/time)
2 - For Days(ended by duration)
3 - For Doses(ended by doses)
StartOnEventvarchar(64)NULL Name of the event
RevisedByOIDintNULL The object ID of the object(such as patient, order, etc.). This field is always a primary key for the associated table
RevisedByVarchar(30)NULL Name of the user who revised the medication order
PatientActualWeightvarchar(6)NULL Actual weight of the patient
PatientActualWeightUnitCodevarchar(16)NULL Actual weight of the patient, always stored in kg(kilograms)
PatientActualWeightDateTimesmalldatetimeNULL Date/Time that the patient's actual weight was collected
DosingWeightvarchar(6)NULL Weight that was used in weight-based dosing calculations
DosingWeightUnitCodevarchar(16)NULL Unit code of the weight value used in weight-based dosing calculation(lbs,oz,kg,g,etc...)
DosingWeightDateTimesmalldatetimeNULL Date/Time that the patient's dosing weight was collected
PrevDosingWeightvarchar(6)NULL The patient's previous dosing weight
PrevDosingWeightUnitCodevarchar(16)NULL The patient's previous dosing weight unit code
PatientActualHeightDateTimesmalldatetimeNULL The Date/Time that the patient's actual height was collected
DosingHeightDateTimesmalldatetimeNULL The Date/Time that the patient's dosing height was collected
MaxDosevarchar(30)NULL Maximum dose allowed for this drug as defined by First Data Bank
MaxDoseUnitCodevarchar(20)NULL Unit code of the maximum dose allowed for this drug
BSAvarchar(10)NULL Body surface area of the patient
BSAUnitCodevarchar(16)NULL Unit Code for the patient's body surface area
CalculatedDosevarchar(30)NULL Dose as calculated using dosing weight/height
CalculatedDoseUnitCodevarchar(16)NULL Unit code of dose as calculated using dosing weight/height
PatientActualHeightvarchar(6)NULL The actual height of the patient
PatientActualHeightUnitCodevarchar(16)NULL The unit code for the actual height of the patient
PrevDosingWeightDateTimeSmalldatetimeNULL The Date/Time the previous dosing weight was collected
DosingHeightvarchar(6)NULL Height of the patient used in height based dosing calculations
DosingHeightUnitCodevarchar(16)NULL Unit Code of the patient's height used in height based dosing calculations
PrevDosingHeightvarchar(6)NULL The patient's previous dosing height
PrevDosingHeightUnitCodevarchar(16)NULL The unit code for the patient's previous dosing height
PrevDosingHeightDateTimeSmalldatetimeNULL The Date/Time the previous dosing height was collected
ModifiedCalculatedDoseVarchar(30)NULL The calculated dose that has been manually modified by the user
ModifiedRateVarchar(15)NULL The rate of administration that has been modified by the user
ModifiedCalcDoseUnitCodeVarchar(20)NULL The unit code for the modified dose
PendingStatusDateTimesmalldatetimeNULL The Date/Time the order was pending
MedOrderSetNameVarchar(30)NULL Name of the orderset associated with the order
IsRevisabletinyintNot Null Flag indicating whether or not the order is revisable
The field can have following values:
0 - The order can not be revised because the drug code is not defined in service catalog, but is defined in the Drug Vendor Content
1 - The order can be revised
2 - The order can not be revised because either Pharmacy has not sent acknoweldgement for True Revise order function(function code 44) or has sent negative acknowledgement
IsOwnMedtinyintNot Null Flag indicating whether or not the order is its own med or not
CalculatedVolumeVarchar(30)NULL This field will store the calculated volume for Bolus IV orders when doing weight-based calculation for the IV
CalculatedVolumeUnitCodeVarchar(20)NULL This field will store the unit code for the calculated volume, such as mL or L
IVCategorysmallintNULL This field stores the category/type of regular IV. IV categories are Regular, Maintenance and Bolus. Allowable Values: 1 - Regular, 2 - Bolus , 3 - Maintenance
IVMaintenanceFactorsmallintNULL This field stores the multiplication factor for the maintenance fluid IV. Allowable Values: 0 = None, 1 = Full maintenance, 3 = One-third maintenance, 5 = One-half maintenance, 7 = Two-thirds Maintenance, 9 = One and half Maintenance, 11 = 2 Maintenance
IVCategoryStringvarchar(32)NULL This field stores the string description of the category/type of regular IV. IV categories are Regular, Maintenance and Bolus
IVMaintenanceFactorStringvarchar(32)NULL This field stores the string description of the multiplication factor for the maintenance fluid IV. IV Maintenance factors are: None, Full maintenance, One-third maintenance, One-half maintenance, Two-thirds Maintenance, One and half Maintenance, 2 Maintenance
AutoProfileIndicatorvarchar(16)NULL The auto-profiling status of an order.
Allowable values:
NOTEVAL - Order has not been evaluated by Rx to determine if it can be auto-profiled or not
NOTQUAL - Order dose not qualify to be auto-profiled as determined on Soarian
QUALRXEVALPEND - Transient setting used when Rx has been called to evaluate order but Soarian DB hasn't been updated yet
QUALRXEVALFAIL - Order was evaluated by Rx and has failed validation
QUALRXEVALSUCC - Transient setting used when Rx has passed validation of the order but Soarian DB hasn't been updated yet
QUALRXPOSTFAIL - Order was sent to Rx to be saved as an auto-profiled order and the save has failed
AUTOPROFILED - Order has been qualified and successfully auto-profiled by Rx
SessionIdINTNULL This field stores the sessionid and will be use to create the link between hmedorderh and hordertransitionrecord table
SessionId and SessionStartDateTime need to be used as a composite key
In order to guarantee uniqueness, when using SessionId for look up, include SessionStartDateTime as well
IsNonFormularytinyintNULL Allowable Values(0=Drug is in formulary, 1=Drug is in service catalog, but marked as not formulary, 2=Drug is external drug base). Valued only for International customers, otherwise NULL
IsControlledSubstancetinyintNULL Allowable Values(0 - Drug is not a controlled substance, 1 - Drug is a controlled substance). Valued only for International customers, otherwise NULL
ChangeNosmallintNULL The number of times the order has changed. Used to properly sequence the history information
DosingWeightSrcAbbrvarchar(16)NULL The Finding Abbreviation for the finding that was used to value the dosing weight
DosingWeightSrcDispNamevarchar(64)NULL The Finding Display name for the finding that was used to value the dosing weight
RetrospectiveReviewIndicatorvarchar(16)NULL The possible states for an order regarding Retrospective Review
Allowable values:
NULL or 'NOTNEEDED' - The order does NOT qualify for Retrospective Review
'NEEDED' - The order qualifies for Retrospective Review
'DONE' - The order was Retrospective Reviewed
NonFormularyReasonvarchar(64)NULL The reason for Non Formulary orders(should be null when IsNonFormulary is 0)
NonWtAdministeredVolumevarchar(30)NULL The non-weight based admin volume(admin volume per day)
NonWtAdminVolumeUnitCodevarchar(16)NULL The unit code for the non-weight based admin volume
NonWtAdminVolumeUnitStringvarchar(20)NULL The presentation value for units for non-weight based admin volume
SessionStartDateTimedatetimeNULL The start date time of the session. This is the date time used when the order goes into session.
SessionId and SessionStartDateTime need to be used as a composite key.
In order to guarantee uniqueness, always look up SessionStartDateTime in conjunction with SessionId.
OriginalCalculatedDosevarchar(30)NULL Original calculated dose
OriginalCalculatedDoseUnitCodevarchar(16)NULL Original calculated dose unit
DoseAdjustmentPercentagesmallintNULL Percentage differential between the calculated and modified dose
LastCngDtimeDATETIMENOT NULLCurrent Universal Time Coordinate or Greenwich Mean Time
MTPIDvarchar(36)NULL MTPID(IHE IT Medication Treatment Plan Identifier) used to uniquely identify a prescription within the Swiss Portal

Return to Table-Index

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