Soarian Clinicals Schema Documentation
  Return to Table-Index

Table Name Table Comment
HPtAllergy Allergies recorded for a Patient
Column Name Column Datatype Column Null Option Column Comment
ObjectIDintNOT NULL Object ID of the Allergy information. Primary key for this table
InstanceHFCIDsmallintNOT NULL Healthcare Foundation Class ID of the object(HFCID = 3406). Note: The value specified in the ObjectID field and in this field enables unique identification of an object across the application
RecordIdintNULL Not used.
Descriptionvarchar(1)NULL Not used.
IsVersionedbitNOT NULL Whether the table data is versioned or not
Allowable values:
0 - No version data captured
1 - version changes available
CreatedUserIdintNULL Object ID of the User who created or updated the Allergy information(HSUser table)
CreationTimesmalldatetimeNULL Date and time(local) when the Allergy information was originally recorded
PatientOIDintNULL Object ID of the Patient(HPatient) for whom the allergy is recorded
PatientVisitOIDintNULL Object ID of the Patient Visit(HPatientVisit) associated with the patient for whom the allergy is recorded. Used to track on which visit allergy information has been created or updated. Move /Merge processing uses this column during move/merge processing.
AlgNamevarchar(120)NOT NULL Name of the allergy. Values can be Free Text, First Data Bank(FDB) Description, HAllergyCatalog entries or User Defined on Pharmacy System
AlgCodevarchar(32)NOT NULL Code associated with the allergy. Value in AlgType determines the possible values of this column. When AlgType:
99CDN(User defined drug product) - US only, 5 digit numeric code(DRUG_CODE column of Pharmacy table PDM)
99DRG(Drug Product)
US - First Data Bank's(FDB) Med Name ID(mnid column of the MedKnowledge Framework(MKF) table fdb_drugname)
EU - ID Berlin's Drug Product Code
99FTX(Free Text) - Defaults to the uppercase value of AlgName
99GRP(Group)
US - First Data Bank's(FDB) allergen group code(agid column of the MedKnowledge Framework(MKF) table fdb_allergengroup)
EU - ID Berlin's Drug Group Code
99ING(Ingredient)
US - First Data Bank's(FDB) ingredient code(hicseqno from Med Knowledge Framework(MKF) table fdb_ingredient)
EU - ID Berlin's Drug Ingredient Code
99LCD(Longitudinal Care Record [LCR] allergy) - US Only, code for the LCR Allergy
99NON(Coded non-Drug) - AllergyCode column of HAllergyCatalog table.
NOTE: In the US, AllergyCode column in the table HAllergyCatalog must be valued with the uppercase value of the AllergyName, if not, Pharmacy will reject the allergy
99USR(User defined Ingredient) - US only, 3 digit numeric code in range 900-999(ALLERGY_CODE columnn of Pharmacy table PHMDA)
AlgCategoryNamevarchar(20)NOT NULL Name of the Category to which the allergy belongs
Allowable values:
Animal
Contraindication
Drug
Environment
Food
Miscellaneous
Plant
Pollen
AlgCategoryCodevarchar(6)NOT NULL Code associated with the Category Name to which the allergy belongs
Allowable values:
AA - Animal
DA - Drug
EA - Environment
FA - Food
LA - Pollen
MA - Miscellaneous
MC - Contraindication
PA - Plant
AlgTypevarchar(8)NULL Type associated with the Allergy, which identifies free text or in which table the allergy code is defined. Valued only if DAM configuration is used.
Allowable Values:
99CDN - User defined drug product. US Only(Can only be created on Pharmacy - Pharmacy table PDM). Treated as free text allergy on Soarian
99DRG - Drug product(Example: Percocet, Tylenol, etc.).
99FTX - Free text allergy
99GRP - Group(Example: Cephalosporins)
99ING - Ingredient(Example: Acetaminophen)
99LCD - Longitudinal Care Record(LCR) coded allergies. US Only(Sent from LCR). Treated as free text allergy on Soarian
99NON - Coded Non-Drug Allergy
99USR - User defined ingredient. US only(Can only be created on Pharmacy - Pharmacy table PHMDA). Treated as free text allergy on Soarian
AlgStatusCodevarchar(1)NOT NULL Status of the Allergy information
Allowable Values:
E - Erroneous
C - Active/Confirmed
I - Inactive
N - Not selected. Column will only have this value when one of the No Known situational allergies(No Known Allergies, No Known Drug Allergies, or No Known Food Allergies) was created by the system
AlgOnsetvarchar(30)NULL Allergy Onset comment entered by the user
ClinicianCommentvarchar(250)NULL Comment entered by the Soarian user for the Allergy
AlgPrevFTNamevarchar(50)NULL Free Text Allergy Name for allergy replaced(from Pharmacy) by a National Drug Data File(NDDF) coded allergy
PrevFT fields are used to capture this event so that the history can be followed
ReportedByvarchar(32)NULL Source of the allergy information. Free text.
EnteredByvarchar(188)NOT NULL Name of User entering allergy information(HSUser)
EnteredByUserIDvarchar(12)NULL Object ID of the user(HSUser)
EnteredByOIDintNULL Object ID of the user who entered the details about the allergy.(HSUser)
EnteredDTdatetimeNOT NULL Date and time(local) the allergy information in this row was created or updated in the application
RevisionDTdatetimeNULL Date and time(local) the allergy was revised in the application
RxCommentvarchar(250)NULL Comments received from Pharmacy when Allergy is of Type 99FTX, 99GRP, 99LCD, 99NON
AlgPrevFTCodevarchar(32)NULL Free Text Allergy Code for allergy replaced(from Pharmacy) by a National Drug Data File(NDDF) coded allergy
PrevFT fields are used to capture this event so that the history can be followed
AlgPrevFTTypevarchar(8)NULL Free Text Allergy Type for allergy replaced(from Pharmacy) by a National Drug Data File(NDDF) coded allergy
PrevFT fields are used to capture this event so that the history can be followed
EnteredByExtSysIdvarchar(16)NULL External system ID for the entering source. Text. Valued when allergy has been created or updated from an external source.
IsLatesttinyintNOT NULL Whether or not this is the latest Allergy information
Allowable values:
0 - A modification to the allergy information has been made and this is not the most recent information
1 - This is the most recent allergy information
IsMergedtinyintNOT NULL Whether or not the Allergy information has been merged
Allowable values:
0 - Allergy information has not been merged
1 - Allergy information has been merged
RevisionReasonvarchar(60)NULL User entered reason for modifying the allergy information
LastCngDtimedatetimeNULL Date time of last update(UTC).

Return to Table-Index

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