Database Naming Convention
Naming Conventions:
| Convention Type | Usage case |
|---|---|
| Case of the Name for all DB Objects | Upper camel case |
| Name Of the Primary and Foreign Keys | TableName+ID |
| Prefix Usage Before Table and Procedures | Based on Modules |
| Singular Vs Plural | Singular |
Prefix Usage:
| Prefix | Description |
|---|---|
| CIRS | Use this prefix before all tables generated by back-end gate analysis process Ex: CIRS_ClinicalAnnotation |
| USR | All Transaction data generated tables from User/web application |
| HIM | Table data generated from Hospital information management system (HL7, FTP etc) |
| MST | All standard and Master Look up Tables |
| TMP | Temporary table for Processing |
| OTR | For all other unrelated to specific process tables. |
StoredProcedure Naming Convention:
| Calling Application | Description |
|---|---|
| CIRS | Clinical Information Extraction System |
| CRI | Clinical Report Insertion |
| USR | Any front end application (KPAI) |
| AQAS | Auto Query Alert System |
| SYNC | For Data Synchronization between HL7Tables and Local database. |
Action Verb Details:
| Action Verb | Description |
|---|---|
| Insert | Main Intention of procedure is insertion |
| Get | Main Intention of procedure is Retrieving results |
| Update | Main Intention of procedure is Update |
| Delete | Main Intention of procedure is Delete |
Example of naming conventions for some stored procedures:
| SP Name | Intention |
|---|---|
| CRI_InsertLab | It will insert lab report from CRI application in to HIM_Lab Table |
| CIRS_InsertLab | It will insert lab data analysed from documents with CIRS application in to CIRS_Lab Table |
Schema Implementation guide Lines:¶
-
Follow above conventions with out fail, either it is general standard or not we should maintain one convention.
-
Use Same ColumnName for same data Type for entire tables Ex: Don’t do Accountno, Accountnumber in different tables.
-
Becarefull about data types assignment for columns, use appropriate or discuss with concern persons.
-
Always create Index on required columns based on your usage.