Upload
others
View
1
Download
0
Embed Size (px)
Citation preview
Database DesignBackground Check System
IT Technical Design GuideVersion 01
4/23/2015
Protecting Patients through Background Checks
Table of Contents
1 Overview.............................................................................................................................................. 4
2 Logical Database Design.................................................................................................................... 4
3 BcsLogging Database Overview........................................................................................................5
3.1 BcsLogging Database Schema....................................................................................................5
3.2 BcsLogging Database Table Definitions.......................................................................................6
4 BcsRegistry Database Schema..........................................................................................................6
4.1 California (CA) Registries/Tables.................................................................................................7
4.2 DC Registries/Tables.................................................................................................................10
4.3 Kentucky (KY) Registries/Tables................................................................................................11
4.4 New Mexico (NM) Registries/Tables..........................................................................................13
4.5 Minnesota (MN) Registries/Tables.............................................................................................15
4.6 Nevada (NV) Registries/Tables..................................................................................................17
4.7 Oklahoma (OK) Registries/Tables..............................................................................................18
4.8 Utah (UT) Registries/Tables.......................................................................................................21
4.9 West Virginia (WV) Registries/Tables........................................................................................22
4.10 Office of Inspector General (OIG) List of Excluded Individuals and Entities (LEIE)
Registries/Tables.......................................................................................................................23
5 Bcs Database Overview.................................................................................................................... 24
5.1 Configuration Tables..................................................................................................................24
5.2 Task and Notification Tables......................................................................................................26
5.3 User Management Tables..........................................................................................................28
5.4 Application Tables...................................................................................................................... 30
5.5 Determination Tables.................................................................................................................32
5.6 Registry Tables..........................................................................................................................34
5.7 Employment Tables....................................................................................................................36
5.8 Appeal Tables............................................................................................................................ 39
5.9 Files and Notes Tables...............................................................................................................41
5.10 Rap Back Tables........................................................................................................................43
Database Design Page 2 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.11 Payment Tables.........................................................................................................................45
5.12 Report Tables............................................................................................................................. 47
5.13 Organization Tables...................................................................................................................48
5.14 Queue Management Tables.......................................................................................................50
5.15 Integration Rejection Tables.......................................................................................................52
Database Design Page 3 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
1 OverviewThis database design document will introduce the State Information Technology (IT) team to the structure and definitions of the Background Check System (BCS) databases.
2 Logical Database Design
BCS Source Databases Description
Bcs Contains the core tables for the application
BcsLogging Contains logging information regarding system events such as authentication, as well as data updates
BcsRegistry Contains imported registry data that is used in registry screening
Database Design Page 4 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
3 BcsLogging Database Overview
3.1 BcsLogging Database Schema
Database Design Page 5 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
CategoryCategoryID
CategoryName
CategoryLogCategoryLogID
CategoryID
DataLogDataLogId
TableName
RowIdValue
Action
ColumnName
BeforeValue
AfterValue
IsSystem
LogLogID
EventID
Priority
Severity
Title
Timestamp
MachineName
AppDomainName
ProcessID
ProcessName
ThreadName
Protecting Patients through Background Checks
3.2 BcsLogging Database Table Definitions
Table Table Description
Category Contains the categories of events that are recorded in the Log table
CategoryLog Join table that associates entries in the Log table with the correct category
Log Contains one row for each logged event, such as authentication
DataLog Contains a log of all data inserted or updated in the application
4 BcsRegistry Database SchemaThe BcsRegistry contains one or more tables for each registry that is implemented as a local database lookup. Usually there will be a table and a staging table for each registry. The staging table is loaded first, then moved when no errors are detected.
Database Design Page 6 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
4.1 California (CA) Registries/Tables
Database Design Page 7 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
CaDoj_StagingSourceIdStageAoriCodeSsnLastNameFirstNameMiddleInitialAddressStreetNumberAddressDirectionAddressStreetNameAddressApartmentNum...AddressCityAddressStateAddressZipCodeAddressExtraZipCodeAddressPhoneAkaLastNameAkaFirstNameAkaMiddleInitialAkaAliasDumpDateOfBirthSexCaDriversLicenseOcaDateFpSentDojDojSendDateCjisCodeApplicantTypeFbiCheckRequiredSidStatusCodeInitial
Cadoj_StagingOffenselineOrdinalLineIsCharged
CaDojExport_StagingSourceIdStageAoriCodeSsnLastNameFirstNameMiddleInitialAddressStreetNumberAddressDirectionAddressStreetNameAddressApartmentNum...AddressCityAddressStateAddressZipCodeAddressExtraZipCodeAddressPhoneAkaLastName01AkaFirstName01AkaMiddleInitial01AkaLastName02AkaFirstName02AkaMiddleInitial02AkaLastName03AkaFirstName03AkaMiddleInitial03AkaLastName04AkaFirstName04AkaMiddleInitial04AkaLastName05AkaFirstName05AkaMiddleInitial05AkaLastName06AkaFirstName06AkaMiddleInitial06AkaLastName07AkaFirstName07AkaMiddleInitial07AkaLastName08AkaFirstName08AkaMiddleInitial08
CaRapback_StagingSourceIdStageAoriCodeSsnLastNameFirstNameMiddleInitialAddressStreetNumberAddressDirectionAddressStreetNameAddressApartmentNum...AddressCityAddressStateAddressZipCodeAddressExtraZipCodeAddressPhoneAkaLastNameAkaFirstNameAkaMiddleInitialAkaAliasDumpDateOfBirthSexCaDriversLicenseOcaDateFpSentDojDojSendDateCjisCodeApplicantTypeFbiCheckRequiredSidStatusCodeInitialLsidApplicantTitle
CaRapback_StagingOffenselineOrdinalLineIsCharged
Protecting Patients through Background Checks
Database Design Page 8 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
CaLarsPERIDFirstNameLastNameSSNDOB
CaLars_StagingPERIDFirstNameLastNameSSNDOB
CaNarApplicationIDClassCodeRecordStatusLastNameFirstNameMiddleInitialCertificateIssuedDateCertificateExpirationDateInvestigationFileNoConvictionsFileNoStreetAddressCityStateZipCodeCountyOtherStreetAddressOtherCityOtherStateOtherZipCodeDateOfBirthSocialSecurityNoDriverLicenseNoStateOfDLIssuanceEducationLevelTrainingReceivedExamSuccessfullyCompl...SchoolCodeApplicantSexOpenInvestigationDOJNoLongerIntereste...
CaNar_StagingApplicationIDClassCodeRecordStatusLastNameFirstNameMiddleInitialCertificateIssuedDateCertificateExpirationDateInvestigationFileNoConvictionsFileNoStreetAddressCityStateZipCodeCountyOtherStreetAddressOtherCityOtherStateOtherZipCodeDateOfBirthSocialSecurityNoDriverLicenseNoStateOfDLIssuanceEducationLevelTrainingReceivedExamSuccessfullyCompl...SchoolCodeApplicantSexOpenInvestigationDOJNoLongerIntereste...
CaNar_StatusStatusIDStatusTextStatusDescription
Protecting Patients through Background Checks
Table Description
CaDojExport_Staging Staging table for data exported for CA Department of Justice (DOJ)
CaDoj_Staging Staging table for imported data from CA DOJ
CaDoj_StagingOffenseLine Staging table for imported offense data from CA DOJ
CaNar Contains information imported for the CA Nurse Aide Registry
CaLars Contains information imported for the CA Licensing Administrative-Action Records System
CaNar_Status Lookup table with the Status for each CaNar record
CaNar_Staging Staging table for CA Nurse Aide Registry
CaLars_Staging Staging table for CA Licensing Administrative-Action Records System Registry
CaRapback_Staging Staging table for CA Rap back
CaRapback_StagingOffenseLine Staging table for Offense in CA Rap back
Database Design Page 9 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
4.2 DC Registries/Tables
Table Description
DcNar Contains information imported for the DC Nurse Aide Registry
DcPl Contains information imported for the DC Professional Licenses
DcNar_Staging Staging table for DcNar
DcPl_Staging Staging table for DcPl
Database Design Page 10 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
4.3 Kentucky (KY) Registries/Tables
Database Design Page 11 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Table Description
KyNar_NurseAideAbuseRegistry Contains information imported for the KY Nurse Aide and Home Health Aide Abuse Registry
KyNar_NurseAide Contains information imported for the KY Nurse Aide Registry
KyPhy Contains information imported for the KY Board of Medical Licensure Physician’s registry
KyPhyT Contains information imported for the KY Board of Medical Licensure Temporary Physician’s Registry
KyPhyA Contains information imported for the KY Board of Medical Licensure Assistant Physician’s Registry
KyKbpt Contains information imported for the KY Board of Physical Therapists Registry
KyKbn Contains information imported for the KY Board of Nursing Registry
KyKbn_Staging Staging table for KyKbn
KyKbpt_Staging Staging table for KyKbpt
KyPhyT_Staging Staging table for KyPhyT
KyPhyA_Staging Staging table for KyPhyA
KyPhy_Staging Staging table for KyPhy
Database Design Page 12 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
4.4 New Mexico (NM) Registries/Tables
Database Design Page 13 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Table Description
NmNar Contains information imported for the NM Nurse Aide Registry
NmNar_Staging Staging table for NmNar
NmEar_Incident Lookup Table used for the NM Employee Abuse Registry
NmEar_Employee Lookup Table used for the NM Employee Abuse Registry
Database Design Page 14 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
4.5 Minnesota (MN) Registries/Tables
Database Design Page 15 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
MnEmploymentProviderNumberPersonId
MNNarSSN_NARDOB_NARFIRSTNAME_NARMIDDLENAME_NARMAIDENNAME_NARLASTNAME_NARREGISTERED_NARSTATUS_NARCOMPLAINT_NARADDRESS1_NARADDRESS2_NARCITY_NARZIP_NARSTATE_NARTELEPHONE_NARTYPEAIDE_NARDATE_INACTIVATED_NAR
MNNSLISEntityIDFirstNameMiddleNameLastNameSSNDateOfBirthGenderRaceDriverLicenseNoStudyStatusPerpChars
MNOIGLEIEProviderTypeDescriptionLastNameFirstNameMiddleNameEffectiveDateOfExclusionAddressLine1AddressLine2CitySTZipFEINSSN
MnPersonPersonIdFirstNameMiddleNameLastNameSSNDateOfBirthGenderPhoneEmail
MnProviderProviderNumberLicenseNumberNameFacilityTypeAddress1Address2Address3CityStateZipContactFirstNameContactLastNamePhoneEmailIsActive
Protecting Patients through Background Checks
Table Description
MnEmployment Contains employment information imported from MN NetStudy 1.0
MnNar Contains information imported for the MN Board of Nursing registry
MnOigLeie Contains information imported for the MN Exclusion List registry
MnPerson Contains person information imported from MN NetStudy 1.0
MnProvider Contains provider information imported from MN NetStudy 1.0
MnNslis Contains information imported from MN NetStudy 1.0 / License Holder Online Information Update System (LIS)
Database Design Page 16 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
4.6 Nevada (NV) Registries/Tables
Database Design Page 17 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
NvBonFNameLNameMNameSuffixIDCityStateCertificateNoDescriptionOriginalI ssueDateRenewalDateDisciplineAgainstNurseFlagSSN
NVFacFACILITY_TYPE_CODEOWNERADMINISTRATOR_FIRST_NAMEADMINISTRATOR_MIDDLE_NA...ADMINISTRATOR_LAST_NAMEDBA_NAMEADDRESS_STREETADDRESS_CITYADDRESS_STATEADDRESS_ZIPEMAILTELEPHONE_NUMBERCLOSED_DATEFACILITY_ID
NVLicDietitian[Personnel Id][License Type]Description[Eff Date][Exp Date][Last Name][First Name]AddressCityStateZipDOBSSN
NVLicLab[Personnel Id][License Type]Description[Eff Date][Exp Date][Last Name][First Name]AddressCityStateZipDOBSSN
Protecting Patients through Background Checks
Table Description
NvBon Contains information imported for the NV Board of Nursing registry
NvFac Contains information imported for NV facilities
NvLicDietician Contains information imported for licensed dieticians
NvLicLab Contains information imported for licenses laboratory workers
4.7 Oklahoma (OK) Registries/Tables
Database Design Page 18 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Database Design Page 19 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Table Description
OkVor Contains information imported for the OK Violent Offender Registry
OkSor Contains information imported for the OK Sex Offender Registry
OkNar_Persons LookupType for OkNar - OK Nurse Aide and Non-Technical Service Worker Registry
OkNar_Abuse LookupType for OkNar - OK Nurse Aide and Non-Technical Service Worker Registry
OkNar_ActionType LookupType for OkNar - OK Nurse Aide and Non-Technical Service Worker Registry
OkNar_States LookupType for OkNar - OK Nurse Aide and Non-Technical Service Worker Registry
OkNar_Status LookupType for OkNar - OK Nurse Aide and Non-Technical Service Worker Registry
OkNar_Abuse_History LookupType for OkNar - OK Nurse Aide and Non-Technical Service Worker Registry
Database Design Page 20 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
4.8 Utah (UT) Registries/Tables
Table Description
UtPl Contains information imported for the UT Professional Licenses registry
UtPl_Staging Staging table for UtPl
Database Design Page 21 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
4.9 West Virginia (WV) Registries/Tables
Table Description
WvNar Contains information imported for the WV Nurse Aide registry
WvExcl Contains information imported for the WV Exclusions List registry
Database Design Page 22 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
WvExclNpiNumberFullNameFirstNameMILastNameGenerationCredentialsProviderTypeCityStateExclusionDateReasonForExclusionReinstatementDateReasonForReinstatement
WvExcl_StagingNpiNumberFullNameFirstNameMILastNameGenerationCredentialsProviderTypeCityStateExclusionDateReasonForExclusionReinstatementDateReasonForReinstatement
WVNarIdFirstNameMiddleNameLastNameSSNDOBEvalCodeRegisteredExpiresPlaced
Protecting Patients through Background Checks
Table Description
WvExcl_Staging Staging table for WV Exclusions List registry
4.10 Office of Inspector General (OIG) List of Excluded Individuals and Entities (LEIE) Registries/Tables
Table Description
OigExclusions Contains information imported for the Department of Health and Human Services' OIG Exclusions list
OigExclusionTypes Lookup table with the description of each exclusion type
Oigleie_Staging Staging table for OIG LEIE import
Database Design Page 23 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5 Bcs Database Overview
5.1 Configuration Tables
Database Design Page 24 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Table Description
BulletinMessage Contains messages that will be displayed on the Home page when a user logs in
Database Design Page 25 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
ConfigurationConfigurationIdDepartmentIdConfigurationTypeIdValueIsActive
BulletinMessageBulletinMessageIdDepartmentIdBulletinMessageTyp...MessageBeginDateEndDateSortOrderIsEnabled
BulletinMessageTypeBulletinMessageTyp...NameIsActive
LookupLookupIdLookupTypeIdLookupCodeLookupDescSortOrderIsEnabledIsActive
TextStringTextStringIdCodeIsHtmlNumberReplacem...DescriptionNotificationIdSortOrderIsActive
DepartmentTextStringDepartmentTextStrin...TextStringIdDepartmentIdTextIsActive
ConfigurationTypeConfigurationTypeIdSettingDescriptionDataTypeValidationRegExValidationMessageIsEditableIsActive
LookupTypeLookupTypeIdDepartmentIdStateCodeNameIsEditableIsEncryptedIsActive
LookupEncryptedLookupEncryptedIdLookupTypeIdLookupCodeLookupDescSortOrderIsEnabled
LinkLinkIdDepartmentIdLinkTypeIdUrlNameDescriptionHoverTextSortOrder
LinkTypeLinkTypeIdNameDescriptionIsActive
Protecting Patients through Background Checks
Table Description
BulletinMessageType Lookup table with valid types of bulletin messages, such as Welcome and Bulletin
Configuration Contains configuration setting values that may be changed by a system, such as password strength rules and SMTP server setting
ConfigurationType Lookup table with configuration settings for the Configuration table
DepartmentTextString Contains customizations to text strings for a department
Link Contains information about links that are shown on the Application Forms page
LinkType Specifies the type of link that is shown on the Application Forms page; the valid values for LinkType are Help (indicates that the link goes to the Help page) and Form (indicates that the form should open via SSRS)
Lookup Generic lookup table which contains values used to populate dropdown boxes, such as hair color, race, and other demographic information
LookupEncrypted Encrypted version of the lookup table to hold Criminal Justice Information Services (CJIS) related lookup values
LookupType Contains type of lookup and department for each lookup value
TextString Contains text strings associated with notifications
Database Design Page 26 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.2 Task and Notification Tables
Database Design Page 27 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Database Design Page 28 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Table Description
Notification Contains the set of email notifications that can be automatically sent to system users, for example, Determination Available
NotificationOptOut Allows users to opt out of notification types
OutboundMessage Contains emails waiting to be sent
OutboundMessageFile Contains files that will be sent as an attachment to a mass email
Permission Contains the permissions (if necessary) for receiving notifications
Task Contains the set of automated tasks that run on a scheduled basis to generate notifications or perform other actions
TaskItem Actions that are queued to run asynchronously, such as letters to be generated to the report queue
TaskItemType Contains the set of all the types of TaskItems that can be generated
TaskNotification Join table that shows notifications associated with tasks
TaskSchedule Contains the schedule parameters for tasks
TaskScheduleRegistry Shows the schedule for individual registry rechecks
Database Design Page 29 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.3 User Management Tables
Database Design Page 30 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Database Design Page 31 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
UserDepartmentUserDepartmentIdUserIdDepartmentId
UserProviderUserProviderIdUserIdProviderIdIsActive
UserStatusUserStatusIdNameSortOrder
UserRoleUserRoleIdUserIdRoleIdIsGrantableIsActive
UsersUserIdUserNameUserTypeIdFirstNameLastNamePhonePositionTitleEmailPasswordHashPasswordSaltPasswordExpirationDatePasswordChangedOnLastLoginDateLastLoginIpFailedLoginsUserStatusIdEulaAcceptedOnUserExternalIdPersonIdSourceIdSignatureFileIdIsPending
PriorPasswordPriorPasswordIdUserIdPasswordHashPasswordSaltIsActive
DepartmentUserTypeDepartmentUserTypeIdDepartmentIdUserTypeIdIsActive
PermissionUserTypePermissionUserTypeIdPermissionIdUserTypeIdDepartmentIdRole
RoleIdNameDepartmentIdUserTypeId
UserTypeUserTypeIdCodeViewUsersPermissionIdEditUsersPermissionIdIsActive
PermissionPermissionIdParentPermissionIdNameDescriptionSortOrderIsActive
RolePermissionRolePermissionIdRoleIdPermissionId
UserSecurityQuestionUserSecurityQuestionIdUserIdSecurityQuestionIdSecurityAnswerHashSecurityAnswerSalt
UserDivisionUserDivisionIdUserIdDivisionIdIsActive
UserQueueTypeUserQueueTypeIdUserIdQueueTypeId
Protecting Patients through Background Checks
Table Description
DepartmentUserType Join table between UserType and Department; shows which user types are available to which departments
Permission Contains the set of permissions that are enforced by the application
PermissionUserType Specifies the types of users (State, Provider, or Vendor) that are eligible to be assigned to each permission
PriorPassword Contains a list of passwords that have previously been used by a User; passwords in this table cannot be reused
Role Contains the set of defined roles to which users can be assigned
RolePermission Join table between Role and Permission that specifies the set of permissions that a user assigned to this role can use
UserDepartment Contains the department to which each user is assigned
UserDivision Specifies the one division that a user is associated with
UserProvider Join table that specifies the Providers assigned to each User
UserQueueType Specifies the list of queue types to which a State user can be assigned
UserRole Join tables that specify the roles to which a user is assigned
Users Contains one row for each user who can access the application
UserSecurityQuestion Contains the set of security questions that a user has set up to use in the case of a forgotten password
UserStatus Lookup table of valid user statuses, such as Enabled or Locked
UserType Lookup table with valid types of users, such as State or Provider
Database Design Page 32 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.4 Application Tables
Table Description
Address This one address table contains address information for applicants, employees, providers, and departments
AddressType Describes what type of address is in the PersonAddress table, i.e., physical or mailing
Alias Contains other names by which an applicant has been known
Application Contains one row for each application - an applicant applying for a particular position at a particular provider
ApplicationFile Contains files associated with an application
ApplicationLicense Contains the licenses or certifications that were selected as applying to this application
Database Design Page 33 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
ApplicationApplicationIdProgramIdProviderIdPositionIdPositionDescriptionDeterminationIdApplicationTypeIdApplicationStatusIdApplicationStatusRe...StartedDateConfirmationNumberIsAppealClosedExpeditedDateIsReadyForApprovalIsApplicantInitiatedIsFingerprintingSki...ReleaseOfInformati...ResearchStartedDateNawResearchComp...ExpandedResearch...RegistryResearchSt...CanProvisionallyHireCreatedByUserIdApprovedByUserIdApprovedDateIntentToAppealDateWithdrawalReasonIdEmployeeTypeIdIsAlreadyEmployedProvisionalEmploy...LicenseRequiremen...
ApplicationFileApplicationFileIdApplicationIdFileIdReportId
ApplicationLicenseApplicationLicenseIdApplicationIdPersonLicenseIdAddressIdNameDateOfBirthLicenseTypeLicenseNumberEffectiveDate
ApplicationPaymentApplicationPaymentIdApplicationIdPaymentMethodIdPaymentDateAmountCommentApplicationPayment...
ApplicationStatusApplicationStatusIdNameSortOrder
ApplicationStatusReasonApplicationStatusRe...NameSortOrder
AddressAddressIdAddresseeStreetLine1StreetLine2CityStateCodeZipCountyIdCountryIdDateValidated
AliasAliasIdPersonIdFirstNameMiddleNameLastNameSsnEncryptedSsnLastFourDateOfBirth
PersonPersonIdFirstNameMiddleNameLastNameSuffixIdSsnEncryptedSsnLastFourSidIsItinDateOfBirthRaceIdGenderIdHairColorIdEyeColorIdWeightHeightIdPlaceOfBirthIdCitizenshipIdPhonePhoneTypeIdSecondaryPhoneSecondaryPhoneTyp...Email
PersonAddressPersonAddressIdPersonIdAddressIdAddressTypeIdYearFromYearToIsActive
PersonLicensePersonLicenseIdPersonIdAddressIdNameDateOfBirthLicenseTypeLicenseNumberEffectiveDateExpirationDateStatusIsAutoMatchIsConfirmedLastBackgroundChec...IsActive
PositionPositionIdPositionCategoryIdNameAbbreviationSortOrderIsEnabledIsActiveCreatedBy
PositionCategoryPositionCategoryIdDepartmentIdNameIsCmsReportable
ProviderProviderIdProviderNumberDepartmentProvide...SourceIdDepartmentIdFeeLevelIdNameLicenseNumberAddressIdMailingAddressIdIsMailingSameContactFirstNameContactLastNamePhone
DeterminationDeterminationIdPersonIdOriginatingDe...OriginatingPro...StartedDateStateComplete...StateDetermin...StateMissingDi...StateRapSheet...FederalCompl...FederalDeter...FederalMissin...FederalRapSh...AppealDeterm...LastDateToApp...CompletedDateDetermination...Determination...CommentCompletedByU...SubmittedDate
AddressTypeAddressTyp...Code
ApplicationNoteApplicationNot...ApplicationIdNoteId
ApplicationReleaseOfI nformationApplicationReleaseOfInformationIdApplicationIdReleaseOfInformationIdReceivedDateIsSelectedIsActive
ApplicationTypeApplicationTyp...NameIsActive
PersonIdentityPersonIdentit...PersonIdIdentityIdIssuingAutho...DocumentNu...ExpirationDateIsActive
PersonFilePersonFileIdFileIdPersonIdReportIdIsActive
ReleaseOfI nformationReleaseOfInformationIdDepartmentIdCodeDescriptionSortOrderIsApplicantInitiated
Protecting Patients through Background Checks
Table Description
ApplicationNote Mapping table between Application and Note
ApplicationPayment Mapping table between Application and Payment
ApplicationReleaseOfInformation Mapping table between Application and Release of Information
ApplicationStatus Lookup table with valid applicant status values, such as in-process or closed
ApplicationStatusReason Lookup table with valid reasons that an application may have been closed such as Hired, Withdrawn, or Not Hired Due to Registry Checks
ApplicationType Specifies the type of application, such as Initiating, Connecting, and Registry Recheck
Person Contains one row for each person in the system, whether an applicant or an employee
Determination Contains one row for each criminal history background check that is performed; multiple applications can be attached to the same determination
PersonAddress Join table that associates one or more address records with a person
PersonFile Join table between Person and Files; identity documents are stored as person files
PersonIdentity Join table that associates person to Lookup table to get citizenship
PersonLicense Contains one row for each license or certification held by a person
Position Lookup table with the list of positions for which a person can apply
PositionCategory Lookup table with the set of position categories used by the Center for Medicare and Medicaid Services (CMS)
Provider Contains a list of providers and facilities that are eligible to use the application
ReleaseOfInformation Contains the text that the user must agree to on the Applicant Consent page when entering a new application
Database Design Page 34 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.5 Determination Tables
Table Description
Appointment Contains information about fingerprinting appointments
CriminalHistoryPossibleMatch Contains information about possible matches when name-based criminal history searches are performed
CriminalHistoryPossibleMatchFile Contains the source file with possible matches when name-based criminal history searches are performed
Department Contains one row corresponding to the State department (i.e., Department of Health)
DepartmentOri Contains the valid ORI values for a department
Database Design Page 35 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
DepartmentDepartmentIdStateCodeNameCodeAcronym
DepartmentDeterminationEventTypeDepartmentDeterminationEventTypeIdDepartmentIdDeterminationEventTypeId
DepartmentOriDepartmentOriIdDepartmentIdProgramNameOriReasonForFingerprinting
DeterminationDeterminationIdPersonIdOriginatingDepartm...OriginatingProviderIdStartedDateStateCompletedDateStateDetermination...StateMissingDisposit...StateRapSheetRecei...FederalCompletedD...FederalDeterminati...FederalMissingDisp...FederalRapSheetRe...AppealDeterminatio...LastDateToAppealCompletedDateDeterminationStatus...DeterminationStatus...CommentCompletedByUserNa...SubmittedDateIsFingerprintingSkip...FingerprintDeadline...AssignedToUserIdRegistryResearchAss...CriminalHistoryAssig...OriTcnIsFederalHitIsStateHitDeterminationEvent
DeterminationEventIdDeterminationIdDeterminationEventT...EventDateDetailsIsActive
DeterminationEventTypeDeterminationEventTypeIdNameSortOrderIsActive
DeterminationFileDeterminationFileIdDeterminationIdFileIdReportId
DeterminationStatusDeterminationStatu...NameSortOrder
AppointmentAppointmentIdLivescanProviderIdDeterminationIdApplicationIdAppointmentDateDetailsLocationName
LivescanProviderLivescanProviderIdDepartmentIdNameAddressIdMailingAddressIdIsMailingSameContactNamePhoneEmailHoursUrlAppointmentUrlAppointmentTypeIdFingerprintTypeId
FingerprintTypeFingerprintTypeIdNameSortOrderIsActive
DeterminationNoteDeterminationNoteIdDeterminationIdNoteId
DeterminationOffenseDeterminationOffenseIdDeterminationIdCodeNameDescriptionOffenseLevelIdYearsDisqualifyingOffenseDateJurisdictionCaseNumberDispositionIdDispositionDateDispositionProvidedDateOffenseStatusIdDisqualifyingUntilDate
DeterminationOffenseNoteDeterminationOffenseNoteIdDeterminationOffenseIdNoteEncryptedId
DeterminationStatusReasonDeterminationStatusReasonIdName
OffenseStatusOffenseStat...NameSortOrderIsActive
OffenseOffenseIdDepartmentIdCodeNameDescriptionOffenseStat...OffenseLeve...YearsDisqu...SortOrderIsEnabled
DepartmentDeterminationStatusReasonDepartmentDeterminationStatusReasonIdDeterminationStatusReasonIdDepartmentIdNameCanAppealIsShownOnReadyForDeterminationIsShownOnNotReadyForDeterminationIsShownOnNameBasedDetermination
FingerprintFingerprintI dDeterminati...Fingerprint...TcnLivescanTcnTakenDateOperatorMachineLocationStateRejecte...StateTcrFederalReje...FederalTcrIsReprintIsActive
DepartmentOffenseStatusDepartmentOffenseStatusIdDepartmentIdOffenseStatusIdNameSeverityIsActive
CriminalHistoryPossibleMatchCriminalHistoryPossibleMatchIdDeterminationIdMatchStrengthSidSsnEncryptedSsnLastFour
CriminalHistoryPossibleMatchFileCriminalHistoryPossibleMatchFileIdCriminalHistoryPossibleMatchIdFileIdIsActive
Protecting Patients through Background Checks
Table Description
DepartmentDeterminationEventType Contains the DeterminationEventTypes that are valid for each department
DepartmentDeterminationStatusReason
Contains the set of determination status reasons that are valid for a given department
Determination Contains one row for each criminal history background check that is performed; multiple applications can be attached to the same determination
DeterminationEvent Contains one row for each event that happens while a determination is in process, such as Fingerprints Taken or Criminal History Received
DeterminationEventType Lookup table with the list of known determination event types, such as Fingerprints Taken or Criminal History Received
DeterminationFile Contains files associated with a determination
DeterminationNote Contains Notes associated with determinations
DeterminationOffense Contains information about a determination relating to an offense
DeterminationOffenseNote Mapping table between DeterminationOffense and NoteEncrypted; all notes for a DeterminationOffense are encrypted
DepartmentOffenseStatus Contains the set of offense statuses that are valid for a given department
DeterminationStatus Lookup table with valid determination status values, such as Pending, In-Process, Eligible, and Closed
DeterminationStatusReason Contains a list of the available reasons that a determination is in the current status, such as Auto Determination or Closed - Fingerprints Past Due
Fingerprint Contains a record for each set of fingerprints
FingerprintType Contains the set of fingerprint types, i.e., card scan or electronic scan
LivescanProvider Contains a list of the locations of live scan machines where an applicant can be fingerprinted
Offense Lookup table with offense names, codes, and descriptions
OffenseStatus Lookup table noting whether or not an offense is disqualifying
Database Design Page 36 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.6 Registry Tables
Table Description
DepartmentRegistry Contains a list of the registries that will always show up on the Research Registries page of the new applicant workflow
DepartmentRegistryDeterminationStatus Contains the set of RegistryDeterminationStatus values that are valid for a state; these values are what is shown in the results dropdown on the Research Registries page
Registry Contains information of registries available to the application
RegistryDetermination Contains the results of each registry check
RegistryDeterminationFile Mapping table between RegistryDetermination and File
Database Design Page 37 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
RegistryRegistryIdCodeStateCodeNameDescriptionUrlContactNameContactPhoneContactEmailContactAddressIdIsPublicSortOrderIsEnabled
RegistryDeterminationRegistryDeterminationIdRegistryIdApplicationIdCheckedDateCheckedByUserIdResearchCompletedDateRegistryDetermination...AppealRegistryDetermi...LastDateToAppealIsUserAddedIsAppealClosed
RegistryDeterminationFileRegistryDetermination...RegistryDeterminationIdFileIdIsConfirmedIsActive
RegistryDeterminationNoteRegistryDeterminationN...RegistryDeterminationIdNoteId
RegistryDeterminationStatusRegistryDeterminationStat...NameSortOrderIsActive
RegistryEventRegistryEventIdRegistryMatchIdEventDateDetailsIsAutoMatchIsConfirmed
RegistryEventFileRegistryEventFileIdRegistryEventIdFileIdIsConfirmedIsActiveCreatedBy
RegistryMatchRegistryMatchIdRegistryDeterminationIdFirstNameMiddleNameLastNameSsnEncryptedSsnLastFourDateOfBirthDetailsCommentIsAutoMatchIsConfirmedResearchIsConfirmedDetermina...MatchHash
RegistryMatchFileRegistryMatchFileIdRegistryMatchIdFileIdIsConfirmedIsActive
RegistryRapbackRegistryRapbackIdDepartmentIdRegistryIdPersonIdRapbackDateRapbackStatusIdDescriptionMatchHashIsActive
RegistryRapbackProviderRegistryRapbackProvid...RegistryRapbackIdProviderIdRegistryDetermination...ApplicationIdEmploymentIdCheckedByCheckedDateIsVerified
RegistryRecheckLogRegistryRecheckLogIdPersonIdRegistryIdDateCheckedMatchFoundIsActive
DepartmentRegistryDepartmentRegistryIdDepartmentIdRegistryIdIsRequiredAllowAutoMatchIsLicensingIsRegistryCanImportCanAppealIsStrongMatchAllowRapbackImportFileExtensionIsShownInNewApplica...IsShownInExpandedRe...DescriptionSortOrderIsEnabled
DepartmentRegistryDeterminationStatusDepartmentRegistryDeterminationStatusIdDepartmentIdRegistryDeterminationStatusIdName
Protecting Patients through Background Checks
Table Description
RegistryDeterminationNote Mapping table between RegistryDetermination and Note
RegistryDeterminationStatus Contains available statuses for a registry determination
RegistryEventFile Mapping table between RegistryEvent and File
RegistryEvent Contains details for a RegistryMatch, including EventDate and Details
RegistryMatch Contains match information and information about the person
RegistryMatchFile Mapping table from RegistryMatch to File
RegistryRapback Contains one row for each registry recheck that occurs
RegistryRapbackProvider Mapping table between RegistryRapback and Provider
RegistryRecheckLog Log table that shows all registry rechecks that were performed, regardless of whether a match was found or not
Database Design Page 38 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.7 Employment Tables
Database Design Page 39 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
EmploymentEmploymentIdPersonIdProviderIdPositionIdPositionDescriptionApplicationIdProvisionalHireDateProvisionalTermsAcknow...ProvisionalTermsAcknow...PermanentHireDateEndDateEmploymentStatusIdVerificationDateNewBackgroundCheckN...EmployeeTypeIdWillProvidePcaServicesIsSupervisionRequiredIsAlreadyEmployedIsActive
EmploymentStatusEmploymentStatusIdNameSortOrder
PersonPersonIdFirstNameMiddleNameLastNameSuffixIdSsnEncryptedSsnLastFourSidIsItinDateOfBirthRaceIdGenderIdHairColorIdEyeColorIdWeightHeightIdPlaceOfBirthIdCitizenshipIdPhonePhoneTypeIdSecondaryPhoneProvider
ProviderIdProviderNumberDepartmentProviderType...SourceIdDepartmentIdFeeLevelIdNameLicenseNumberAddressIdMailingAddressIdIsMailingSameContactFirstNameContactLastNamePhoneEmailStatusDescriptionMedicareIdOwnershipCompanyCanEditBillingNumberRsaRsaPaysApplicationFeeRsaPaysFingerprintFeeClosedDateServesChildrenSaltTaxIdIsEnabled
PositionPositionIdPositionCategoryIdNameAbbreviationSortOrderIsEnabledIsActiveCreatedBy
PositionCategoryPositionCategoryIdDepartmentIdNameIsCmsReportableCanEditSortOrderIsEnabled
EmployeeTypeEmployeeTypeIdNameSortOrderIsActive
EmployeeImportStagingEmployeeImportStagingIdProviderIdFirstNameMiddleNameLastNameSuffixSsnEncryptedDateOfBirthPersonIdPositionPositionDescriptionProvisionalHireDatePermanentHireDateEmploymentStatusEmployeeTypeEmploymentIdLastBackgroundCheckDateLicenseTypeLicenseNumberEffectiveDateExpirationDateLicenseStatusIsImportedErrorsIsActive
DepartmentEmployeeTypeDepartmentEmployeeTypeIdEmployeeTypeIdDepartmentIdName
Protecting Patients through Background Checks
Table Description
DepartmentEmployeeType Contains the set of employee types that are valid for a given department; this set of values is shown in the employee type dropdown on the Pre-Employment Information page
EmployeeImportStaging Staging table used to hold the employee information that is being imported
EmployeeType Contains the different employee types available to an applicant/employment record
Employment Contains one row for each employment record - an employee working in a particular position at a particular provider
EmploymentStatus Lookup table with valid employment status values, such as Provisional, Active, or Terminated
Person Contains one row for each person in the system, whether an applicant or an employee
Position Lookup table with the list of positions for which a person can apply
PositionCategory Lookup table with the set of position categories used by CMS
Provider Contains a list of providers and facilities who are eligible to use the application
Database Design Page 40 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.8 Appeal Tables
Database Design Page 41 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Database Design Page 42 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
AppealAppealIdDeterminationIdRegistryDeterminationIdStartedDateAppealTypeIdAppealStatusIdAppealStatusReasonIdStateAppealStatusReasonIdFederalAppealStatusReas...AppealSourceIdMustBeCompleteByCompletedDateCommentExtensionStatusIdExtensionRequestCommentExtensionReviewCommentDisqualifiedUntilDateAssignedToUserIdIsFollowUpNeeded
AppealEventAppealEventIdAppealIdAppealEventTypeIdEventDateResponsiblePartyOutcomeCommentDeadlineDateIsActiveCreatedByAppealEventType
AppealEventTypeIdDepartmentIdNameViewPermissionIdEditPermissionIdAppealTypeIdSortOrderAllowableDays
AppealFileAppealFileIdAppealIdFileIdReportIdIsActive
AppealStatusAppealStatusIdNameSortOrderIsActiveCreatedBy
AppealStatusReasonAppealStatusReasonIdNameSortOrder
DeterminationDeterminationIdPersonIdOriginatingDepartmentIdOriginatingProviderIdStartedDateStateCompletedDateStateDeterminationStatusIdStateMissingDispositionStateRapSheetReceivedD...FederalCompletedDateFederalDeterminationStat...FederalMissingDispositionFederalRapSheetReceive...AppealDeterminationStat...LastDateToAppealCompletedDateDeterminationStatusIdDeterminationStatusReas...CommentCompletedByUserNameSubmittedDateIsFingerprintingSkippedFingerprintDeadlineDateAssignedToUserIdRegistryResearchAssigne...CriminalHistoryAssignedT...OriTcnIsFederalHitIsStateHitIsHighRiskOffenseSeverityStateCriminalHistoryResul...FederalCriminalHistoryRe...DisqualifiedUntilDateOriginatingAgencyCaseN...AffidavitDeadlineDate
AppealSourceAppealSourceIdNameDescriptionSortOrderIsActive
AppealTypeAppealTypeIdNameDescriptionIsActive
DepartmentAppealStatusReasonDepartmentAppealStatusReasonIdDepartmentIdAppealStatusReasonIdName
DepartmentAppealTypeDepartmentAppealTypeIdDepartmentIdAppealTypeIdNameSortOrder
Protecting Patients through Background Checks
Table Description
Appeal Contains data for an appeal by an applicant
AppealEvent Contains one row for each event that is tracked for a given appeal
AppealEventType Lookup table with valid types of appeal events
AppealFile Contains files associated with an appeal
AppealSource Contains available sources for an appeal
AppealStatus Lookup table with the list of valid statuses for an appeal
AppealStatusReason Lookup table with the set of reasons that an appeal can be closed
AppealType Contains available appeal types for an appeal
DepartmentAppealStatusReason Contains the set of appeal status reasons that are valid for a given department
DepartmentAppealType Contains the set of appeal types that are valid for a given department; this set of values is shown in the dropdown on the Start Appeal page
Determination Contains one row for each criminal history background check that is performed; multiple applications can be attached to the same determination
Database Design Page 43 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.9 Files and Notes Tables
Table Description
FileChunk Stores the smaller “chunks” of data that large files are broken into
FileImport Contains one row for each file that is imported
FileImportDetail Contains messages from the import process, including errors
FileImportStatus Lookup table with valid statuses for a FileImport
Database Design Page 44 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
FileImportFileImportIdDepartmentIdFileImportStatusIdFilenameFileImportTypeIdErrorFileIdScheduledOnStartedOnEndedOn
FileImportDetailFileImportDetailIdFileImportIdRowNumberColumnNumberColumnNameErrorMessageIsSystemMessageIsActive
FileImportStatusFileImportStatusIdNameIsActive Files
FileIdFileGuidDepartmentIdFileTypeIdFilenameIsEncryptedFileDataSizeDescriptionSortOrderIsCompressedIsSystemIsIntegrationIsActive
ProviderImportProviderImportIdProviderImportTypeIdFileImportIdIsActive
ProviderImportTypeProviderImportTypeIdCodeNameIsActive
RegistryImportRegistryImportIdFileImportIdRegistryId
FileImportTypeFileImportTypeId
FileProcessorFileProcessorIdNameDescriptionIsActive
FileWatchFileWatchIdDepartmentIdFileTypeIdPathSearchPatternTopDirectoryOnlyCopyPathCopyFileDataEncryptFileDataDeleteFileFileProcessorId
FileTypeFileTypeId
FilesUserTypeFilesUserTypeIdFileId
FileChunkFileChunkIdFileIdFileDataChunkChunkIndex
NoteNoteIdNoteTypeIdTextSubjectIsEncrypted
NoteEncryptedNoteEncryptedIdNoteIdTextSubjectIsActive
NoteTypeCreatedByCreatedOn
NoteUserTypeNoteUserTypeIdNoteIdUserTypeIdIsActive
Protecting Patients through Background Checks
Table Description
FileImportType Contains available file import types
FileProcessor Defines the set of processes that are used to manipulate input files in the task service
Files Contains the files that were imported
FileType Contains the set of file types, such as Application, Determination, Attachment, etc.; the file type controls where the file can be viewed in the application
FileUserType Mapping table between Files and UserType; this table is used to specify which user types can view which files
FileWatch Contains configuration information for each file watch service
Note Contains all the notes that are entered into the system
NoteEncrypted Encrypted version of the Note table to hold CJIS sensitive notes
NoteType Contains a list of the valid note types, such as Determination or Registry
NoteUserType Mapping table between Note and UserType; this table is used to specify which user types can view which notes
ProviderImport Contains one row for each file of provider data that was imported
ProviderImportType Lookup table with set of valid types of provider imports
RegistryImport Contains one row for each file of registry data that was imported
Database Design Page 45 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.10 Rap Back Tables
Database Design Page 46 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Database Design Page 47 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
PersonPersonIdFirstNameMiddleNameLastNameSuffixIdSsnEncryptedSsnLastFourSidIsItinDateOfBirthRaceIdGenderIdHairColorIdEyeColorIdWeightHeightIdPlaceOfBirthIdCitizenshipIdPhonePhoneTypeIdSecondaryPhone
RapbackEnrollmentRapbackEnrollmentIdDepartmentIdPersonIdStateIdentifierEnrollmentDateWithdrawalDateIsActive
RegistryRapbackRegistryRapbackIdDepartmentIdRegistryIdPersonIdRapbackDateRapbackStatusIdDescriptionMatchHash
CriminalHistoryRapbackCriminalHistoryRapbackIdDepartmentIdDeterminationIdPersonIdEventDateRapbackStatusIdDescriptionCaseNumberChargeNumberTcnSidFileIdAssignedToUserIdIsFederalIsConfirmedRequiresSupervisionImmediateRemovalNotificationReceivedDate
CriminalHistoryRapbackProviderCriminalHistoryRapbackProviderIdCriminalHistoryRapbackIdProviderIdRapbackStatusIdIsVerifiedIsActive
RapbackStatusRapbackStatusIdNameIsActive
RegistryRapbackProviderRegistryRapbackProviderIdRegistryRapbackIdProviderIdRegistryDeterminationStatusIdApplicationIdEmploymentIdCheckedByCheckedDateIsVerified
RapbackPossibleMatchRapbackPossibleMatchIdDepartmentIdFileIdExternalIdOffenseStatusIdDetailsAssignedToUserIdIsResolvedIsActive
RapbackPossibleMatchPersonRapbackPossibleMatchPersonIdRapbackPossibleMatchIdPersonIdMatchStrengthIsConfirmed
Protecting Patients through Background Checks
Table Description
CriminalHistoryRapback Contains information pertaining to the event of a rap back
CriminalHistoryRapbackProvider Mapping table between CriminalHistoryRapback and Provider
Person Contains one row for each person in the system, whether an applicant or an employee
RapbackEnrollment Shows the time period that a person is enrolled in rap back
RapbackPossibleMatch Contains information about possible matches when name-based criminal history is being processed
RapbackPossibleMatchProvider Contains information about providers associated with possible matches when name-based criminal history is being processed
RapbackStatus Contains available statuses for a CriminalHistoryRapback
RegistryRapback Contains one row for each registry recheck that occurs
RegistryRapbackProvider Mapping table between RegistryRapback and Provider
Database Design Page 48 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.11 Payment Tables
Table Description
Application Contains one row for each application - an applicant applying for a particular position at a particular provider
ApplicationPayment Combines all of the fees for an application and holds the total of all fees
Database Design Page 49 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
PaymentDetailCreatedByCreatedOnModifiedBy
PaymentMethodPaymentMethodIdFeeGroupIdPaymentMethodTypeIdNameDescriptionPermissionIdActionIsAutoCollectedIsTransferableSortOrderIsActive
PaymentMethodDetailPaymentMethodDetailIdPaymentMethodIdPaymentDetailIdValidationRegExIsRequiredSortOrderIsRequiredNaw
PaymentMethodTypePaymentMethodTypeIdCodeIsActive
FeeFeeIdFeeGroupIdNameDescriptionDepartmentIdAmountPaymentMethodTypeIdFeeLevelIdEffectiveDateExpirationDateIsVolunteerIsConnectingIsGrandfathered
FeeGroupFeeGroupIdNameDescriptionDepartmentIdIsFingerprintFeeIsApplicationFee
FeeLevelFeeLevelIdDepartmentIdNameDescription
ApplicationPaymentApplicationPaymentIdApplicationIdPaymentMethodIdPaymentDateAmountCommentApplicationPaymentBat...
ApplicationApplicationIdProgramIdProviderIdPositionIdPositionDescriptionDeterminationIdApplicationTypeIdApplicationStatusIdApplicationStatusReaso...StartedDateConfirmationNumberIsAppealClosedExpeditedDateIsReadyForApprovalIsApplicantInitiatedIsFingerprintingSkippedReleaseOfInformationR...ResearchStartedDateNawResearchComplete...ExpandedResearchCom...RegistryResearchStatusIdCanProvisionallyHireCreatedByUserIdApprovedByUserIdApprovedDateIntentToAppealDate
ApplicationPaymentDetailApplicationPaymentDetailIdApplicationPaymentIdPaymentMethodDetailIdValueIsActive
ApplicationPaymentFeeAmountIsActiveCreatedByCreatedOn
ApplicationPaymentBatchApplicationPaymentBatchIdAmountPaymentDateTransactionNumberIsActive
ApplicationPaymentBatchDetailApplicationPaymentBatchDetail...ApplicationPaymentBatchIdPaymentMethodDetailIdValue
Protecting Patients through Background Checks
Table Description
ApplicationPaymentBatch Contains a record for a batch of application payments
ApplicationPaymentBatchDetail Mapping table between payment details and application payment; contains the details associated with a batch payment
ApplicationPaymentDetail Contains the details of the payment, i.e., confirmation numbers, check numbers, and verification numbers
ApplicationPaymentFee Combines the individual fees for an application that will make up the full amount of what is owed
Fee Contains the amounts that need to be collected for each part of the background check
FeeGroup Contains information about a grouping of fee records
FeeLevel Contains the set of fee levels; this table is used to support varying pay amounts by type of provider
PaymentDetail Lookup table describing the detailed information regarding the payment
PaymentMethod The available payment options for a department
PaymentMethodDetail Combines the payment methods with the types of information that should be gathered during the payment process, such as check number confirmation number, etc.
PaymentMethodType Lookup table that holds the available method to pay; cash, check, and govpay
Database Design Page 50 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.12 Report Tables
Table Description
DepartmentReport Join table that combines the department with the report and gives it a custom name for the department; it also combines the permissions to the report
DepartmentReportTag Join table to combine the ReportTag to the DepartmentReport table
FileQueue Holds the link to letters that have been automatically generated and need to be printed
Report Contains the location where each report resides
ReportTag Groups the reports together by which page the reports should be displayed on and where they should be displayed
Database Design Page 51 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
DepartmentReportDepartmentReportIdReportIdDepartmentIdNameDescriptionPermissionIdRequiresProviderIdNotificationId
DepartmentReportTagDepartmentReportTagIdReportTagIdDepartmentReportIdIsQueuedSortOrder
ReportReportIdPathDescriptionHasCustomParameterCustomParameterInstr...
ReportTagReportTagIdNameDescriptionIsActive
FileQueueFileQueueIdFileIdProcessedDateIsActiveCreatedBy
Protecting Patients through Background Checks
5.13 Organization Tables
Table Description
Department Contains configuration information at the department level
DepartmentProviderType Contains the list of provider types that are valid for a department, along with their mapping to one of the CMS used provider types
Division Contains the list of divisions that are subordinate to a department
DivisionContact Contains additional contacts for divisions
Program Contains a list of programs that belong to a division
Provider Contains a list of all the providers
ProviderContact Contains additional contacts for providers
Database Design Page 52 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
ProgramProgramIdDivisionIdNameRsaPaysApplicationFeePaysFingerprintFee
ProviderProviderIdProviderNumberDepartmentProviderTy...SourceIdDepartmentIdFeeLevelIdNameLicenseNumberAddressIdMailingAddressIdIsMailingSameContactFirstNameContactLastNamePhoneEmailStatusDescriptionMedicareIdOwnershipCompanyCanEditBillingNumberRsaRsaPaysApplicationFeeRsaPaysFingerprintFeeClosedDateServesChildrenSaltTaxIdIsEnabled
ProviderContactProviderContactIdProviderIdFirstNameMiddleNameLastNamePhoneSecondaryPhoneEmailAddressIdIsActive
ProviderProgramProviderProgramIdProviderIdProgramIdIsActive
ProviderTypeProviderTypeIdNameIsCmsReportableCmsCodeIsActive
DivisionDivisionIdDepartmentIdNameDescriptionAbbreviationAddressIdIsActive
DivisionContactDivisionContactIdDivisionIdFirstNameMiddleNameLastNamePhoneSecondaryPhoneEmailAddressId
DepartmentDepartmentIdStateCodeNameCodeAcronymUrlAddressIdMailingAddressIdIsMailingSameSystemNameSystemAbbreviationSystemUrlSystemContactContactPhoneContactEmailContactFaxIsActive
DepartmentProviderTypeDepartmentProviderTy...DepartmentIdCodeNameReasonForFingerprintingProviderTypeIdIsPaymentBypassedI temKeyDepartmentOriIdIsActive
SourceSourceIdName
UserDepartmentUserDepartmentIdUserIdDepartmentId
UserDivisionUserDivisionIdUserIdDivisionIdIsActive
UserProviderUserProviderIdUserIdProviderId
UsersUserIdUserNameUserTypeIdFirstNameLastNamePhonePositionTitleEmailPasswordHashPasswordSaltPasswordExpirationDatePasswordChangedOnLastLoginDateLastLoginIpFailedLoginsUserStatusIdEulaAcceptedOnUserExternalIdPersonIdSourceIdSignatureFileIdIsPendingIsActive
Protecting Patients through Background Checks
Table Description
ProviderProgram Join table that lists which programs are associated with which providers
ProviderType Contains the list of CMS used provider types
Source Indicates where the source from which provider and user records were created; valid values are Manual, Import, and SSO
UserDepartment Join table that lists which department is associated with each providers
UserDivision Join table that lists which users are associated with which divisions
Users List of all users who can access the system
UserProvider Join table that lists which users are associated with which providers
Database Design Page 53 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.14 Queue Management Tables
Database Design Page 54 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
Database Design Page 55 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
QueueLogQueueLogIdQueueTypeIdDepartmentIdUserIdApplicationIdDeterminationIdAppealIdAssignedDateUnassignedDateCompletedDateRapbackPossibleMatchIdCriminalHistoryRapbac...
QueueTypeQueueTypeIdNamePermissionIdSortOrder
DepartmentQueueTypeDepartmentQueueTypeIdDepartmentIdQueueTypeIdNameIsActive
UserQueueTypeUserQueueTypeIdUserIdQueueTypeIdIsActive
ApplicationApplicationIdProgramIdProviderIdPositionIdPositionDescriptionDeterminationIdApplicationTypeIdApplicationStatusIdApplicationStatusReaso...StartedDateConfirmationNumberIsAppealClosedExpeditedDateIsReadyForApprovalIsApplicantInitiated
DeterminationDeterminationIdPersonIdOriginatingDepartment...OriginatingProviderIdStartedDateStateCompletedDateStateDeterminationStat...StateMissingDispositionStateRapSheetReceived...FederalCompletedDateFederalDetermination...FederalMissingDisposit...FederalRapSheetRecei...AppealDeterminationSt...LastDateToAppealCompletedDate
AppealAppealIdDeterminationIdRegistryDeterminationIdStartedDateAppealTypeIdAppealStatusIdAppealStatusReasonIdStateAppealStatusReas...FederalAppealStatusRe...AppealSourceIdMustBeCompleteByCompletedDateCommentExtensionStatusIdExtensionRequestCom...ExtensionReviewComm...
Protecting Patients through Background Checks
Table Description
Appeal Contains a list of all appeals
Application Contains a list of all applications
Determination Contains a list of all determinations
QueueLog Contains a list of all queued items and the user to which they are assigned
QueueType Lists all queue types supported in the application
DepartmentQueueType Contains the set of queue types that are valid for a given department
UserQueue Contains the set of queue types that are valid for a given user
Database Design Page 56 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
Protecting Patients through Background Checks
5.15 Integration Rejection Tables
Table Description
IntegrationRejectionAppointmentSave Contains invalid integration records for Appointment Save
IntegrationRejectionChangeToSid Contains invalid integration records for Change To Sid
Database Design Page 57 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff
I ntegrationRejectionAppointmentSaveIntegrationRejectionAppointmentSaveIdDepartmentIdDeterminationIdAppointmentDateLastNameCustomXmlResponseLocationNameLocationAddress1LocationAddress2LocationCityLocationStateLocationZipLocationPhoneIsActiveCreatedByCreatedOn
I ntegrationRejectionChangeToSidIntegrationRejectionChangeToSidIdDepartmentIdOriApplicantSidCriminalSidLastNameResponseCustomXmlChangeDate
I ntegrationRejectionCriminalHistoryAvailableIntegrationRejectionCriminalHistoryAvailableIdDepartmentIdDeterminationIdOriTcnLastNameSsnEncryptedSsnLastFourDateOfBirthSidIsStateHitStateFileNameStateFileIdIsFederalHitFederalFileNameFederalFileIdDeterminationStatusNameStateDeterminationFederalDeterminationAgencyFederalFileCreatedDateStateFileCreatedDateResponseOcaCustomXml
I ntegrationRejectionCriminalHistoryRapbackIntegrationRejectionCriminalHistoryRapbackIdDepartmentIdSidLastNameFirstNameMiddleNameSuffixDateOfBirthSsnEncryptedSsnLastFourTcnDateOfActionActionRapbackTypeReferenceTypeReferenceNumberReferenceAgencyMessageTextCustomXmlResponseFileIdIsActive
I ntegrationRejectionDeterminationUpdateIntegrationRejectionDeterminationUpdateIdDepartmentIdSidFederalDeterminationRecordTypeStateDeterminationStatusMessageTcnTcrCustomXmlTimestampResponseIsActive
I ntegrationRejectionFingerprintsRejectedIntegrationRejectionFingerprintsRejectedIdDepartmentIdDeterminationIdOriTcnLastNameSsnEncryptedSsnLastFourDateOfBirthSidAgencyRejectedDateTcrFileIdFileName
I ntegrationRejectionFingerprintsTakenIntegrationRejectionFingerprintsTakenIdDepartmentIdDeterminationIdOriLastNameDateOfBirthTcnFingerprintingDateFingerprintTypeLocationOperatorMachineEbts
Protecting Patients through Background Checks
Table Description
IntegrationRejectionCriminalHistoryAvailable Contains invalid integration records for Criminal History Available
IntegrationRejectionCriminalHistoryRapback Contains invalid integration records for Criminal History Rap Back
IntegrationRejectionDeterminationUpdate Contains invalid integration records for Determination Update
IntegrationRejectionFingerprintsTaken Contains invalid integration data for Fingerprints Taken
IntegrationRejectionFingerprintsRejection Contains invalid integration records for Fingerprints Rejected
Database Design Page 58 of 58Version 01 | 4/23/2015 | IT Technical Design Guide | Audience: State IT Staff