Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
HChargeHold This table stores the Charge/Credit which needs to be processed raising Soarian_Billing event to eventually form HL7_P03 Transaction.
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 4502. 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 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 HChargeHold_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.
TypetinyintNOT NULL Type of the Charge Record
Allowable Values
0 - Charge
1 - Credit
ChargeCodevarchar(32)NULL CDM(Charge Description Master Code) number passed on the Soarian_Billing event
Departmentvarchar(10)NULL Department where service was requested/performed
Diagnosisvarchar(30)NULL Diagnosis code(ICD) of patient's problem for which the Charge record was created
QuantitysmallintNULL quantity to apply to Charge/Credit
Pricefloat(53)NULL price override
ChargeDatesmalldatetimeNULL Date/time the charge took place
ServiceDatesmalldatetimeNULL Date/time the service took place
ChargeEnteredDTimeMinssmalldatetimeNULL The datetime at which the charge was entered into system.
ServiceDescriptionvarchar(64)NULL Description of the service
ServiceDescriptionOverridevarchar(64)NULL Service description override
Modifier1varchar(20)NULL CPT(Current Procedure Terminology) modifier 1
Modifier2varchar(20)NULL CPT Modifier 2
Modifier3varchar(20)NULL CPT Modifier 3
Modifier4varchar(20)NULL CPT Modifier 4
PatientOIDintNOT NULL ObjectId of the patient(HPatient)
VisitOIDintNULL ObjectId for the patient's visit(HPatientVisit)
OrderOIDintNULL ObjectId of HOrder(if charge is linked to an order )
ServiceDetailOIDintNULL ObjectId of HserviceDetail
EnteredByUserOIDintNULL User objectId who entered the Charge/Credit
ProvidedByStaffOIDintNULL ObjectId of the staff who provided service
ABN_codetinyintNULL ABN(Advanced Beneficiary Notice) code passed on the Soarian_Billing event
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
CPT_codevarchar(20)NULL CPT(Current Procedure Terminology) code
RequestedByStaffOIDintNULL ObjectId of requestor staff
BillDetailOIDintNULL Identifier to Billing Configuration used when creating the Charge / Credit.
OccOIDbigintNULL ObjectId of HOccurrenceOrder. Note: Not all environments / databases will have the datatype of BIGINT. Some will remain with the INT datatype.
ComponentBillingIndicatortinyintNOT NULL Indicator that a service requires component billing for the professional and/or technical components
Allowable Values
0 - Total Price - No specific billing component(TP)
1 - Technical component(TF)
2 - Professional component(PF)
3 - Technical And Professional component(TFPF)
PDMCodevarchar(32)NULL Professional Component Master Code(aka PDM#) - to be sent to the billing system receiving the professional component charges
SupervisedByStaffOIDintNULL ObjectId of supervised by staff
ChargeSourcevarchar(10)NOT NULL The source of the charge(MC - Manual Charge, ORD - Orders, SPW - ServiceProviderWorkspace, etc.) . Usually to identify from which part of the system the charge was created
IsTempVisitsmallintNOT NULL Indicates if this charge was raised for Temporary visit which is not identifiable by the billing systems
Allowable Values
0 - No
1 - Yes , setting this flag on the charge record with prevent HL7_P03 transaction to be raised for this record
ServiceEndDatesmalldatetimeNULL The date/time service ended for time charges
DurationsmallintNULL Duration of the service for time charges
TimeChargeIndicatorsmallintNOT NULL Indicator to determine if it is a time based charge or not
Allowable values
0 - Not Time based charge
1 - Is Time based charge
ChgHoldCreditOIDintNULL ObjectId of charge from Hold table that was credited
ChgAuditCreditOIDintNULL ObjectId of charge from Audit table that was credited
AllowManualCreditChar(1)NULL Indicates if a manual credit is allowed. This is only applicable for row which represents a Charge(ie Type = 0 )
Allowable Values
Y - for a charge row which allows manual credit
N - for a charge row which doesn't allow manual credit
C - for a credit row(Type = 1)
RequestorUnitAbbrVarchar(10)NULL Abbreviation of the unit requesting the charge
ChargeSourceObjIdintNULL A unique context for the charge source(such as assessment id)
ChargeSourceLinkIdvarchar(500)NULL A unique identifier for the charge(such as observation oid) within context of ChargeSourceObjId
LastCngDtimeDATETIMENOT NULLCurrent Universal Time Coordinate or Greenwich Mean Time

Return to Table-Index

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