Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
HOrder This table stores the details about an Order for a Service (Medication & Non-Medication) , entered on a Patient in the system.
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 1501. 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.
IsVersionedbitNOT NULL When set to True, the object was modified. Once this field is set to True, you cannot reset it to False. Allowable Values: 0 - False, 1 - True. 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.
OrderIdintNOT NULLThis is system generated unique ID(other than objectID) for the Order which is can be used in printed reports or UI Display
OrderNamevarchar(64)NOT NULL Name of the order. Usually defaulted with ServiceName field of HService table , but can be different if the service is configured to allow changing the Name on Order Detail Form.
OrderReasons_oidintNULL Column not being used.
OrderDescAsWrittenvarchar(300)NOT NULL Order As Written is a long description of the order. For Non-medication order , what goes in OAW can be configured via an OAW config tool available in Administrative Desktop. For Medication orders this is pretty much hard-coded based on different Med Types.
OrderStatusCodetinyintNOT NULL Code associated with the status of the order.
Allowable values
1 - Inactive
2 - Active
3 - In Progress
4 - Complete
5 - Suspend
6 - Cancel
7 - Invalid
8 - Discontinue
10 - Pending Activation
StatusEnteredDateTimesmalldatetimeNOT NULL Date and time when the user charted the order.
OrderStatusModifiervarchar(30)NULL Modifier associated with the order status.
For example, refer to the following order statuses and the associated order status modifiers.
Inactive - Not active
Result Available - In Progress
OrderStatusModifierCodetinyintNULL Code associated with the order status modifier.
OrderAbbreviationvarchar(16)NOT NULL Abbreviation set for the name of the order. Is defaulted from the Abbreviation field of HService table.
OrderTypeAbbrvarchar(30)NOT NULL Abbreviation from HServiceType table of its ServiceType relation with HService from which the Order is created.
Examples of order types are Laboratory and Cardiology.
OrderSubTypeAbbrvarchar(30)NULL Abbreviation from HServiceType table of its ServiceSubType relation with HService from which the Order is created.
An example of an order subtype is a Microbiology test carried out on a sample.
RequestorUnitAbbrvarchar(10)NOT NULL Abbreviation of the healthcare unit that requested the order.
ProviderUnitAbbrvarchar(10)NULL Abbreviation of the healthcare unit that provided the order.
SampleCollectorUnitAbbrvarchar(10)NULL Abbreviation set for the healthcare unit that collected the sample required to carry out the order. Only applicable for services which are configured require specimen collection(eg. Laboratory services).
RequestedByvarchar(188)NULL Name of the staff member who requested the order.
ProvidedByvarchar(188)NULL Name of the healthcare professional who fulfills the order request. For example, Consulting service provider. Note: Only the recent value of this field is stored in the table.
EnteredByvarchar(30)NOT NULL LoginID of the user(HSUser) who entered the order.
EnteredDateTimesmalldatetimeNOT NULL Date and time when the order is entered.
ImmediateOrderOidintNULL ObjectID of another row in HOrder which represents the previous state of the Order.Indicates the order ID. This field is populated for revised, renewed, or resumed order or when in-place update happens on the Order.
When an order is revised, renewed, or resumed, the original is discontinued and a new order is created . In the new order the original Order's ObjectID is stored in this field.
MNCReqdbitNULL When set to True, indicates that a medical necessity check is required to carry out the order.
Allowable Values:
0 or NULL - False
1 - True
StartDateTimesmalldatetimeNULL Date and time when the order starts.
StopDateTimesmalldatetimeNULL Date and time when the order ends.
CalculatedStopDateTimesmalldatetimeNULL Calculated end date and time of the order.
QuantitytinyintNULL Quantity ordered.
UnitOfQuantityvarchar(16)NULL Unit of measure for the quantity ordered.
AcknowledgeRequiredbitNULL When set to True, indicates that an acknowledgment is required when the order is performed.
Allowable Values
0 - False
1 - True
DuplicateOverridenbitNULL When set to True, indicates that the order has been overridden with its duplicates.
Allowable Values
0 - False
1 - True
OrderFunctionCodetinyintNULL Code associated with the last order function performed on the Order.
For allowable values, refer to table HOrderFunction.
IsCoSignedbitNULL When set to True, specifies that this Order has got all the required signatures as configured in Service Catalog.
Allowable Values
0 - False
1 - True
AdditionalSignReqdbitNULL Whether order has co-signature requirement. Usually defaulted from the CosignatureRequired field from HServiceDetail table.
Allowable Values
0 - False
1 - True
SignedNumbertinyintNULL Actual number of signatures acquired on the Order by authorized signatories.
The signature level can be equal to or greater than that is specified in the Service catalog.
IsResultSignedbitNULL Whether all the results associated with the order is signed. An order can have multiple occurrences and an occurrence can have multiple results. When a result is signed as an outcome of an order occurrence, the occurrence level flag is set. When all the occurrences of an order are set with this flag, then the order level field is set.
Allowable Values:
0 - False
1 - True
IsRestrictedbitNULL Whether the order is accessible only to authorized users.
Allowable Values
0 - False
1 - True
OrderablePackagebitNULL Whether order was from an Orderable set or PredefinedMed/IV.
Allowable Values:
0 - False
1 - True
ExamCompletebitNULL Not Valued.
LRIndicatorvarchar(32)NULL Side(left or right) of the patient's body that should be used to carry out the order.
BodySitevarchar(32)NULL Body site where the order is performed.
Priorityvarchar(32)NULL Priority of the order. If an order is of high priority, indicates that it must be performed immediately.
PriorityCodetinyintNULL Indicates the code associated with the priority of the order.
Allowable Values:
0 - Routine
1 - Timing Critical
2 - Now Routine
3 - As Soon As possible
4 - Preoperative
5 - Call Back
6 - Stat
SessionIdintNULL Most recent unique Identifier of the ordering session in which the Order was modifier/created. Very useful for qualifying order for Session level events.
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.
RevisedByvarchar(188)NULL Name of the staff(HStaff) who has modified the order.
RevisedDateTimesmalldatetimeNULL Date and time when the order is modified.
InfectiousbitNULL When set to True, indicates that the sample collected to carry out the order is infectious.
Allowable Values:
0 - False
1 - True
ABNStatustinyintNULL Indicates the status of Advanced Beneficiary Notice(ABN).
Allowable Values:
0 - Service is not subject to medical necessity procedures
1 - Service is subject to medical necessity procedures
2 - Patient has been informed of responsibility and agrees to pay for service
3 - Patient has been informed of responsibility and asks that the payer be billed
4 - Advanced Beneficiary Notice has not been signed
CallBackNumbervarchar(16)NULL Contact number of the staff member who requested the order. If the staff number was not configured , it will get the number of the Medically responsible unit if configured.
Commentvarchar(255)NULL Comments about the order as specified by the user during order entry.
IsDuplicatebitNULL When set to True, indicates that the requested order is a duplicate order.
Allowable Values:
0 - False
1 - True
DupOrder_oidintNULL Object ID of the original order that indicates that the requested order is a duplicate order.
SuggActionForDupvarchar(40)NULL Suggested action for the duplicate order.
OrderHistoryGroupIDintNULL Unique Identifier of the group that contains the order history(such as modifications made to the order). Usually it's ObjectID of the first order which got created before it went through several revisions
OrderAssoTypeCodetinyintNULL Not Valued.
AssoOrder_oidintNULL Not Valued
IsExpiredbitNULL is a history row. Row with value 1 should never be fetched in normal order processing. Used to keep the history of inplace updates on the Order. Allowable values: 0/Null - Not a history row, 1 - Is a history row
Most of the time updates an order leads to Discontinue and New order . In such cases this field is not marked as true. This field will only be true if any workflow updates the existing order and wants to capture the changes for Order history
ActSignNosmallintNULL Actual number of signatures acquired by authorized signatories for Activating the Order.
Patient_oidintNOT NULL ObjectID of Patient(HPatient) to which the order is associated to.
PatientVisit_oidintNULL ObjectID of PatientVisit(HPatientVisit) to which order is associated to.
ServiceDetail_oidintNOT NULL ObjectID of the Service Detail(HServiceDetail). Links the Order with the Master table of HServiceDetail
RecurrencePattern_oidintNULL ObjectID of the HRecurrenceInstance which stores the recurrence details of the Order.
OrderSuppInfo_oidintNULL ObjectID of the HOrderSuppInfo where supplementary(additional) information of the order is stored.
ExtendedOrder_oidintNULL ObjectID of HExtendedOrder where user-defined attributes of the Order is saved.
ClinicalInfo_oidintNULL DEPRECATED - Not Valued anymore. This used to store ObjectID of HClinicalInformation table which captured other module data like Ht,Wt etc during order entry. After IMA(Inter-Module Adaptability) Feature, this table is replaced with HClinicalInformationEx
ServiceProvider_oidintNULL object id to the healthcareunit providing the order for the service.
ServiceRequestor_oidintNULL object id to the healthcareunit requesting the order for the service.
ChangeNosmallintNULL Number of times the order is modified.
CollectedSample_oidintNULL DEPRECATED - Not Valued anymore. This relations replaced with DefaultCollectedSample_oid
IsAcknowledgedtinyintNOT NULL Whether the order is already acknowledged.
Allowable Values:
0 - No
1 - Yes
OrderTypeIdentifiervarchar(2)NOT NULL Indicates the type of order.
Allowable Values
MD - Medication orders
DG - Non-medication orders
PenOcc2bGensmallintNOT NULL Number of Occurrences pending to be generated on the Order
Allowable Values:
-3 - PRN orders
-2 - Open-ended orders
-1 - Non-recurring order
0 - Recurring order, where all occurrences have been generated.
>0 - Pending occurrences, which need to be generated for a recurring order.
IVMethodTypeCodevarchar(64)NULL Code associated with the type of IV method. The IV method type depends on the options the user selects in the Medical section or the IV section.
OrderTypeCodesmallintNOT NULL ServiceType Code associated with the order. Links to the ServiceTypeCode Field in HServiceType table
Providedby_oidintNULL Object ID associated with the healthcare professional who fulfills the order request. Primarily used for capturing physician's for Consult orders.
TimeChargingReqdbitNULL When set to True, indicates that order is charged based on time.
Allowable Values
0 - False
1 - True
OrdModifierAbbrvarchar(4)NULL Abbreviation set for order Status modifier. An order status modifier is the user-defined name given to a predefined order status.
UnitCodeForQuantityvarchar(16)NULL Code associated with the unit of measure for the quantity ordered.
OrderSetIDintNULL Unique IDentifier to group orders which are placed from within the set. Valued at time of Order entry and is always the objectID of the first Order which got created from the set.
OrderSetAbbrvvarchar(16)NULL Abbreviation set for the order set(HService) from which the order got created.
IsExternalbitNULL Whether the order is sourced externally. For example, an inbound Med order from Pharmacy is an external order.Allowable Values: 0 - False 1 - True
CommonDefNamevarchar(64)NULL Indicates the common definition name to which the order belongs.
TreatmentContexttinyintNULL if the treatment is ongoing or is complete. For existing transaction records, this field stores 0. Orders with Discharge context(i.e 1) are not automatically discontinued/suspended on close of visit.
Allowable Values:
0 - Ongoing
1 - Discharge
IsResultedsmallintNULL When set to -1, indicates that the order, when carried out, cannot yield in any result. The value stored in this field depends on the value stored in TypeofDefinitionCode in HService.
The value stored in IsResulted field is -1 if the value stored in HService.TypeofDefinitionCode field is 0; otherwise, the value stored in IsResulted field is -1.
Allowable Values:
-1 - Order cannot yield in any result
0 - Order can yield in any result
OrderSuppInfoExt_oidintNULL ObjectID of HOrderSuppInfoExt which stores extended supplementary(additional) information about the order .
PresentationIndicatorvarchar(3)NULL Mnemonic for tagging the type of order being carried out. As of now following allowable values are supported
Allowable Values:
CRD(Cardiology orders)
NRS(Nursing orders)
DG(Diagnostic orders)
MedContextvarchar(120)NULL Context in which the medication order is placed.
ExtStaffidvarchar(30)NULL ExternalID field from HStaff table of the healthcare professional requesting this order.
DefaultCollectedSample_oidintNULL ObjectID of HCollectedSample. During order entry the detail of Sample Collection are captured in this object and linked to the Order as a default sample relation. Then when occurrences are created this object is used as a template to create HCollectedSample rows associating the occurrences
DocumentVersion_oidintNULL Not Valued.
OrderSubTypeCodesmallintNULL Service Sub Type Code associated with the order. Links to the ServiceTypeCode Field in HServiceType table
Requestedby_oidintNULL Object ID of the Staff(HStaff) who has requested for the order to be carried out.
ProposedPatientTypetinyintNULL Not Valued.
ScheduleStatustinyintNULL Not Valued.
ProposedMRU_oidintNULL ObjectID of HHealthcareunit. When No-visit Orders are placed this field represents the proposed Medically responsible unit where the order could go.
SupervisedBy_StaffOIDintNULL Object ID of the staff(HStaff) who has supervised the order to be carried out.
SupervisedByStaffvarchar(188)NULL Name of Staff who has supervised the order to be carried out.
HoldTypeVarchar(3)NULL Value of the workflow which put the order on Hold.
Allowable Values:
UIS - Suspended from UI
DCH - Suspended due to Discharge
UID - Already suspended before Discharge
UIB - Suspended due to Bed Removal
UIC - Already suspended order before HL7 A32 message
LOA - Suspended due to Leave of Absence event
A32 - Suspended due to HL7 A32 message
A09 - Suspended due to HL7 A09 message
SrvTypeBLMnemonicChar(3)Null Mnemonics for the service types related to order type specific business logic.
For allowable values, refer to table HServiceType
SrvSubTypeBLMnemonicChar(3)Null Mnemonics for the service sub types who are having related business logic.
For allowable values, refer to table HServiceType
PersonalFavoriteOidintNULL Identifier of Personal favorite that was used to create this order.
IsFutureDCtinyintNULL Whether the Order was Discontinued with a Future Date time
Allowable Values:
0 - False
1 - True
AgeWeightClassificationCHAR(3)NULL Age/weight classification of the patient.
Either NULL for old orders(predating the introduction of this field), or one of these values
Allowable Values :
'Unk' - Undetermined/unknown
'Ped' - Pediatric
'Adu' - Adult
'Ger' - Geriatric
NotRenewableFlagtinyintNULL flag indicating the order is renewable or not
Allowable Values:
NULL - for existing orders
0 - for new orders
1 - when order is marked 'Do Not Renew' from OAE worklist
IsLinkedtinyintNULL Whether or not the Order is a part of a Linked Collection/Set
DisplayAsOrderSetOidintNULL in a case of Sort By Order Set, this order will be sorted/grouped along with other Orders from the Set referenced by this Oid
SessionStartDateTimedatetimeNULL Start date time of the ordering 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.
ConvOrdStDtTOffsetvarchar(30)NULL Formula of Offset for the start time for a service within a convenience orderset . This is defaulted on the order so that the same formula can be applied in workflows like Activation of Pending Order.
LastCngDtimeDATETIMENOT NULLCurrent Universal Time Coordinate or Greenwich Mean Time

Return to Table-Index

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