Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
HMedDispOrderH This table stores the dispensed medication order historical data
Column Name Column Datatype Column Null Option Column Comment
ObjectIDINTNOT NULL The object ID of the dispensed medication order
InstanceHFCIDSMALLINTNOT NULL The HFC(Healthcare Foundation Class) ID of the object(1133). Note: The value specified in the ObjectID field and in this field enables unique identification of an object across the application
RecordIdINTNULL The record ID. Not valued in this table. Column exists as part of the 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 Indicates whether the record is soft deleted. Allowable Values: 0 - Active, 1 - Marked as Deleted
IsVersionedTINYINTNOT NULL Indicates whether the record was modified through the persistent layer after its initial creation. Once this field is set to True, you cannot reset it to False. If this field is set to True in a table, another table with the name HMedDispOrderH_Ver is created. Allowable Values: 0 - False, 1 - True
CreatedUserIdINTNULL The Object ID of the user who created the object. This field is linked to the HSUser table to get details about the user.
CreationTimeSMALLDATETIMENULL The date and time when the object was created
ValidFromDATETIMENOT NULL The Date/Time when the medication prescribed to the patient became valid
ValidToDATETIMENULL The Date/Time when the medication prescribed to the patient is no longer valid
InternalIDINTNULL Object ID of the order(HOrder)
ExternalIDVARCHAR(6)NULL Identifier sent in by a third-party Pharmacy application as part of an inbound transaction
MedOrderStatusTINYINTNOT NULL The status of the 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
ReasonVARCHAR(32)NULL Reason for modifying the order
StartDateTimeDATETIMENOT NULL Date and time when the order became valid
CalculatedStopDateTimeDATETIMENOT NULL Date and time when the order component is no longer valid. Calculated based on system preferences
OrderAsWrittenVARCHAR(650)NOT NULL Text describing medication orders that can be dispensed. The medication order details are contained in the text
MedOrderTypeTINYINTNOT NULL Type of the medication order
Allowable Values:
0 - medotSimpleMed
1 - medotComplexMed
2 - medotSlidingDoseMed
3 - medotTaperDoseMed
4 - medotDifferDoseMed
5 - medotExtraDoseMed
6 - medotRegularIV
7 - medotPCAIV
8 - medotFreeText(NA)
9 - medotRX(NA)
IVMethodCodeTINYINTNULL Code assigned to the different methods to administer IVs.
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)
TotalVolumeVARCHAR(30)NULL Total volume of the bottle from which the IV was administered
RateVARCHAR(8)NULL Drip rate of the bottle from which the IV was administered
RateUnitStringVARCHAR(20)NULL Unit of the drip rate of the bottle from which the IV was administered. For example, ml/h
RunInVARCHAR(8)NULL Total infusion run-in time of the bottle from which the IV was administered
PRNIndicatorTINYINTNOT NULL When set to 1, indicates that the medication can be administered to the patient as desired. Allowable Values: 0 - Non-PRN order, 1 - PRN order
PerformedByPatientTINYINTNOT NULL When set to 1, indicates the medication is administered by the patient himself
Allowable Values:
0 - Medication is not administered by patient himself
1 - Medication is administered by patient himself
PriorityCodeTINYINTNOT NULL Code assigned to the priority of the medication order. Allowable Values: 0 - medpriStat, 1 - medpriRoutine, 2 - medpriStatRoutine
PatientVisit_oidINTNOT NULL Object ID for the Patient's Visit(HPatientVisit)
Patient_oidINTNOT NULL Object ID for the Patient(HPatient)
AcknowledgedBy_oidINTNULL Object Id for the staff who acknowledged the medication(HStaff)
TotalVolumeUnitStringVARCHAR(20)NULL Unit of the total volume of the bottle from which the IV was administered. ex. ml
PCAAdditionalDoseVARCHAR(20)NULL 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.
PCAAdditionalDoseUnitStringVARCHAR(20)NULL Unit of the additional dose that the patient can give himself with one push
PCADelayIntervalINTNULL Time interval between two pushes to administer dose
RequestedBy_oidINTNULL Object ID for the staff that requested the medication(HStaff).
Will be Null when the RequestedBy information on the inbound transaction from the Pharmacy System does not match any entries in HStaff(ex. free text name)
PCADelayIntervalUnitStringVARCHAR(20)NULL Unit of the time interval between two pushes to administer dose
PCALockoutDoseVARCHAR(20)NULL Maximum dose that the patient can administer himself with one push
PCALockoutDoseUnitStringVARCHAR(20)NULL Unit of the maximum dose that the patient can administer himself with one push
PCALockoutTimeINTNULL Maximum time the patient can take to administer himself a dose with one push. The amount of dose(as specified in the PCALockoutDose field) can never exceed the lock out time
PCALockoutTimeUnitStringVARCHAR(20)NULL Unit of the maximum time the patient can take to administer a dose to himself with one push
VitalsToCollectVARCHAR(170)NULL Abbreviation set for the vitals to be collected to carry out the order.
Refer to the following abbreviation set for a vital collected and the associated description
BP - Blood Pressure
PULSE - Pulse
TEMP - Temperature
RS - Respiration
BS - Blood Sugar
PS - Pain Scale
PSL - Pain Scale Location
RunInUnitStringVARCHAR(20)NULL Unit for the total infusion run-in time of the bottle in which the IV was administered
DisplayDoseStringVARCHAR(47)NULL Dose of the medication as displayed to the user
AcknowledgeRequiredTINYINTNOT NULL When set to 1, indicates that the order needs to be acknowledged before any medication is administered. Allowable Values: 0 - Order need not be acknowledged, 1 - Order needs to be acknowledged
AdminCoSignRequiredTINYINTNOT NULL When set to 1, indicates that each administration must be countersigned before it is administered. Allowable Values: 0 - Countersignature not required, 1 - Countersignature required
DirectionsVARCHAR(256)NULL Directions(such as shake well before administering) specified to carry out the order
AcknowledgeDateTimeDATETIMENULL Date and time when the order was acknowledged
RemainingAdmINTNULL Counter to keep track of administrations with an open status. The counter indicates when to change the order status to complete. A value of 0 indicates that the order was created.
NextOccurenceToGenerateDATETIMENULL Date and time of the next occurrence of the order.
TotalVolumeUnitCodeVARCHAR(16)NULL Code associated with the unit of the total volume of the bottle from which the IV was administered
RateUnitCodeVARCHAR(16)NULL Code associated with the unit of the drip rate of the bottle from which the IV was administered
RunInUnitCodeVARCHAR(16)NULL Code associated with the unit for the total infusion run-in time of the bottle from which the IV wa administered
PCALockoutTimeUnitCodeVARCHAR(16)NULL Code associated with the unit of the maximum time the patient can take to administer himself a dose with one push
PCALockoutDoseUnitCodeVARCHAR(20)NULL Code associated with the maximum dose that the patient can administer himself with one push
PCADelayIntervalUnitCodeVARCHAR(16)NULL Code associated with the time interval between two pushes to administer dose
PCAAdditionalDoseUnitCodeVARCHAR(20)NULL Code associated with the unit of the additional dose that the patient can give himself with one push
AdminCoSignRequiredReasonVARCHAR(64)NULL Reason why it is required to countersign each administration before it is administered
PCALoadingDoseVARCHAR(20)NULL Initial dose for the PCA(Patient Controlled Analgesic) order
PCALoadingDoseUnitStringVARCHAR(20)NULL Unit of the dose for the PCA order
PCALoadingDoseUnitCodeVARCHAR(20)NULL Code associated with the unit of the dose for the PCA order
MedOrderStatusDateTimeDATETIMENULL Date and time when the status of the order was recorded
MedOrderStatusSignedBy_oidINTNULL Object ID for the staff signing the status update(HStaff)
MedOrderSet_oidINTNOT NULL Object ID for the order set stored as a result of the one-to-one relationship between HMedDispOrder and HMedOrderSet
MedOrderStatusReasonVARCHAR(120)NULL Reason for the specified order status
MedFunctionCodeTINYINTNOT NULL Code associated with the medication functions that can be carried out on orders to dispense medication to the patient
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
NumberOfAdditivesINTNULL The number of additives
PRNReasonVARCHAR(64)NULL Reason for carrying out a PRN order. A PRN order indicates that the medication is administered only if necessary
PRNConditionVARCHAR(32)NULL Condition in which the PRN order is carried out.
VerbalIndicatorSMALLINTNOT NULL When set to 1, indicates that the order is a verbal order
OrderHistoryGroupIDINTNULL Object ID of the group that contains the order history(such as modifications made to the order)
RequestedBy_StaffNameVARCHAR(188)NULL Name of the staff who requested the service(derived from Hstaff.Name). For orders originating on the Pharmacy System, the RequestedBy_StaffName may also be free text. Mapped to the ORC.12.02 field in the inbound interface
MedOrderSetNameVARCHAR(30)NULL The MedOrderSet abbreviation when MedOrderType is medotComplexMed. For orders originating on the Pharmacy System, the MedOrderSetName is mapped to the RXE.2 field in the inbound interface.
ValidatedByVARCHAR(188)NULL Pharmacist Name who validated the Med Order
ValidatedDateTimeSMALLDATETIMENULL Date Time stamp when the order was validated by pharmacy
HasVaccineCHAR(1)NULL If this Order has a vaccine component.
Allowable Values:
Y - Order has a Vaccine component
N - Order does not have a vaccine component
NULL or empty string - Not Known
DurationINTNULL Duration from Pharmacy to Soarian. Value will be coming ORC-7.3.0 segment
DurationUnitStringVARCHAR(9)NULL DurationUnitString from Pharmacy to Soarian. Value will be coming ORC-7.3.0 segment
Allowable values:
NULL - open ended orders
Days - duration in days
Doses - duration in doses
Seconds - duration in seconds
Minutes - duration in minutes
Hours - duration in hours
Bags - duration in bags
ML - duration in Milliliters
Weeks - duration in weeks
Months - duration in months
Years - duration in years
DurationUnitCodeINTNULL Duration unit code
Allowable values:
0/NULL - open ended orders
1 - Days
2 - Doses
3 - Seconds
4 - Minutes
5 - Hours
6 - Bags
7 - Milliliters
8 - Weeks
9 - Months
10 - Years
LastCngDTimeDATETIMENULL The current Universal Time Coordinate or Greenwich Mean Time
DeliverySourceVARCHAR(3)NULL HL7 value indicating where the medication was dispensed from. Default of FL(floorstock) / AN(ancillary dept stock)
IsUnitDoseDispensedTINYINTNULL If the drug is capable of being unit dose dispensed or not. Allowable values: 0 - no, 1 - yes, 2 - unknown
HasAdministrationOnStopDateTimeSMALLINTNULL Whether there is an occurrence on the stop date time of the order. This feld is coming from Pharmacy inbound transaction, as 4th position of ORC-07.02.01 field.
Allowable values:
0 - No occurrence on stop date time
1 - Occurrence on stop date time(Set when pharmacy doesn't send OCCURRENCE_ON_STOP_DATE_TIME flag at all)
2 - Order has no occurrences
SkipAdministrationDTimeDATETIMENULL Planned date/time that should not be allowed to be created into an Administration Date/Time
ChangeNoSMALLINTNULL The number of times the order has changed. Used to properly sequence the history information
DispenseStatusVARCHAR(6)NULL Indicates dispense status of medication.
Allowable values:
OPEN - Open
DISP - Dispensed
NODISP - Not dispensed
INPREP - In preparation
DispensedByStaff_oidINTNULL Object ID for the Staff who dispensed the medication(HStaff)
DispensedByStaffNameVARCHAR(188)NULL Name of the staff who dispensed the administration
LastDispenseDTimeDATETIMENULL Date/time the drug for the administration was dispensed
NonFormularyReasonVARCHAR(64)NULL Reason for the Non Formulary order(should be null when IsNonFormulary is 0)

Return to Table-Index

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