Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
HRecurrenceInstance This table contains a denormalized record of the recurrence template (Frequency) and Schema used by user to create an recurring order
Column Name Column Datatype Column Null Option Column Comment
The information is then used by Quantity and Time calculation API's(CommonQT APIs) to calculate administration times
ObjectIDintNOT NULL The object ID of the object(such as patient, order, etc.). This field is always a primary key for the associated table.
InstanceHFCIDsmallintNOT NULL The HFC(Healthcare Foundation Class) ID of the object(3104). 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. Modules in the application can use this field to group all objects having something in common and then assign the same RecordId to all the objects. For example, all related information for a patient, such as patient address, patient visits, patient name, etc., can be assigned the same RecordId. The modules can then query on this RecordId to retrieve the related information for that patient
Descriptionvarchar(64)NULL User-defined information provided by the modules in the application. Note: The length of this field varies with tables. Not used
IsDeletedtinyintNOT NULL Indicates whether the record is soft deleted. Allowable Values: 0 - Active , 1 - Marked as Deleted
IsVersionedbitNOT NULL Indicates whether the record was modified through persistent layer after it's 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 HRecurrenceInstance_Ver is created
CreatedUserIdintNULL The Object ID of the user who created the object. This field is linked to HSUser table to get details about the user. For more information on HSUser table
CreationTimesmalldatetimeNULL The date and time when the object is created
OccurrencesintNULL Declares the number of ocurrences the method creates
ParsingSignvarchar(40)NULL Copy of HRecurrenceTemplate.ParsingSign field
PresentationtinyintNULL Defines the presentation order of the dosage method
Allowable values:
0 - Addition
1 - DoseParser
2 - ParserDose
3 - Parser
4 - Dose
RecurrenceMethodtinyintNULL Specifies which basic method is used for this recurrence method
Allowable values:
0 - Repetable
1 - Interval
2 - Unspecified
3 - Once
4 - Simple notation
OccurrenceTimesvarchar(192)NULL Number of times administration is given in 24 hrs . Not applicable for Interval and Unspecified recurrence methods
TimeCalculationMethodtinyintNULL This attribute is an enumeration specifying if the method should calculate the recurrence times and if they should be distributed evenly during the granularity unit.
Allowable values:
0 - NoCalculation
1 - DistributeEvenly
2 - DistributeEvenlyExternalStartTime
ShiftFlagbitNULL Defines if succeeding occurrence will be shifted upon time delay
PRNbitNULL Flag indicating if medication should be administered as needed. Allowable values: 0 - Cannot be administered as needed, 1 - Can be administered as needed
IntervalSecondsintNULL If method interval is being used this attribute describes the interval in seconds
QuantityTypetinyintNULL Defines what kind of quantity is defined
Allowable values:
0 - None
1 - Quantity
2 - ExternalQuantity
3 - PM
ShiftSecondsintNULL If ShiftFlag is 1 this is considered to shift the succeeding occurrence
SchemaNamevarchar(40)NULL Name of RecurrenceSchema
SchemaGranularityPatternvarchar(124)NULL Pattern is a string containing a repeat pattern used with Granularity
e.g.
10 - every second day
1 - every day
SchemaDayOfMonthPatternvarchar(124)NULL Pattern is a string containing a repeat pattern used on day of month(e.g 11000000.... first & second every month)
SchemaDayOfWeekPatternvarchar(42)NULL Pattern is a string containing a repeat pattern used on day of week(e.g 11000000.... mon & tue every week)
SchemaMonthOfYearPatternvarchar(12)NULL Pattern is a string containing a repeat pattern used on month of year.(e.g 11000000.... jan,feb)
SchemaPatternMaskintNULL Defines which of the four pattern will be used
Allowable values:
1 - GranularityPattern
2 - DayOfWeekPattern
3 - DayOfMonthPattern
4 - MonthOfYearPattern
StartDateTimedatetimeNULL The date and time of the recurrence start
StopDateTimedatetimeNULL The end datetime to be set for the RecurrenceInstance object
DurationintNULL The Duration value
TotalOccurrencesintNULL The Total number of ocurrences the connected order will repeat
This field is valued when duration unit is specified in terms of count . eg for 2 doses(meds) , 2 Times(non-meds)
For such units, the duration is to be fetched from this field, instead of the Duration field
For other units like Days, Week etc, this field is not valued, instead Duration field is used
RecurrenceStopTypetinyintNULL The Integer value from the EHRecurrenceStopType enum determining what kind of time unit the duration value is referring to
Allowable values:
0 - None
1 - StopDate
2 - TotalOccurrences
3 - DurationInSeconds
4 - DurationInMinutes
5 - DurationInHours
6 - DurationInDays
7 - DurationInWeeks
Granularity_oidintNOT NULL Object ID of Granularity object(HGranularity)
SchemaTemplateRelationtinyintNOT NULL Type of relation between Schema and Template
Allowable values:
0 - Standard
1 - AlteredSchema
2 - AlteredTemplate
3 - AlteredSchemaAndTemplate
RecurrenceAsWrittenvarchar(300)NULL To capture the Recurrences for an order "As written"
Template_OIDintNULL Object ID of Template object defined at Enterprise Level(HRecurrenceTemplate)
Schema_OIDintNULL Object ID of Schema object defined at Enterprise level(HRecurrenceSchema)
SchemaIntervalPatternVarchar(6)NULL Pattern defined in the RecurrenceSchema
IsContinuousProcessingtinyintNULL Whether selected frequency is of type ContinuousIV or not(1/0)
LastCngDtimeDATETIMENOT NULLCurrent Universal Time Coordinate or Greenwich Mean Time

Return to Table-Index

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