********************************************************************************
		What is C-DAC’s Toolkit for LOINC (CLNtk) ?
********************************************************************************

C-DAC’s Toolkit for LOINC is a specially designed FOSS application for easy access and integration of LOINC standard in health care applications. Logical Observation Identifiers Names and Codes (LOINC®) is an international standard for laboratory tests, measurement, and observations.

The toolkit enables clinicians and researchers to find relevant LOINC codes from its components including, the long common name, short name, display name, and other related information.


Note: CLNtk is developed, build & tested on OpenJdk 17(13).
      Use this toolkit for development purpose.

********************************************************************************
		 CLNtk Prerequisite Software requirements and settings
********************************************************************************
1. JDK 17 should be installed on machine
	Set the environment variables for Java.
	e.g.: Setting the environment variables for Java considering OpenJdk17 is installed.  
		Windows: Add System Environment Variable: JAVA_HOME - C:\Program Files\AdoptOpenJDK\jdk-17.0.13
		LINUX: modify '/etc/profile': JAVA_HOME - export JAVA_HOME=/usr/lib/AdoptOpenJDK/jdk-17.0.13

	Append the path value for JAVA in the PATH environment variable.
	e.g.:  Windows: C:\Program Files\AdoptOpenJDK\jdk-17.0.13\bin
	       LINUX: modify '/etc/profile': export PATH=/usr/lib/AdoptOpenJDK/jdk-17.0.13/bin:$PATH
	
2. a) Go on https://loinc.org/
   b) Log in to your account. If account does not  exist, create an account by signing up.
   c) Go to Downloads tab.
   d) On this web page , download Loinc_x.zip. User must be signed in to download Loinc_x.zip.
   e) Unzip the downloaded Loinc_x.zip.
   f) Go to extracted folder and inside that go to "LoincTable" folder, From here you can obtain "Loinc.csv" file.
		Loinc_x > LoincTable > Loinc.csv 
   g) Go to extracted folder and inside that go to "AccessoryFiles" folder,and inside that go to "PartFile" folder. From here you can obtain "Part.csv" file.		
		Loinc_x > AccessoryFiles > PartFile > Part.csv		
   h) Go to extracted folder and inside that go to "AccessoryFiles" folder,and inside that go to "PanelsAndForms" folder. From here you can obtain "PanelsAndForms.csv" file.  
		Loinc_x > AccessoryFiles > PanelsAndForms > PanelsAndForms.csv
   g) Copy Loinc.csv, Part.csv and PanelsAndForms.csv to a folder. Use this folder path as LOINC CSV File Directory while filling details in config and show page.

3. Common Lab Codes for India (CLCI) : The Common Lab Codes for India (CLCI) is a curated subset of Logical Observation Identifiers Names and Codes (LOINC) covering commonly referred laboratory tests and measurements in India. The CLCI CSV file can be provided optionally while providing details for initial setup of toolkit with the steps to get the csv mentioned below

a) Go to https://www.nrces.in/services/national-releases#lab_codes
b) click on the get url to download the zip containing csv file.
c) provide the full path for the clci csv file location while providing config details if you wish to include it.	
   
4. Web server Apache-tomcat-10.1.9 should be installed on machine. 
	Set the environment variables for web server.
	e.g. : export TOMCAT_HOME=/usr/java/apache-tomcat-10.1.9 (modify '/etc/profile' - in case of LINUX)	  

5. Browser Compatibility  
   a)Edge: version 42 and higher
   b)Chrome: 88.0 and higher
   
6. Apache Maven 3.9.8 should be installed on machine
	Add MAVEN_HOME and Maven Path inside environment variable
	Ex: MAVEN_HOME - C:\Program Files\Apache-Maven\apache-maven-3.9.8
		Path - C:\Program Files\Apache-Maven\apache-maven-3.9.8\bin
		
7. To open .jar and .war files use WINRAR archiver.			

********************************************************************************
		How to build code and configurations
********************************************************************************
1. Extract the downloaded loinc_toolkit_src.zip file from C-DAC website

2. It Consist of following structure
```
	+---common
	|	+---main	
	|	|---LICENSE.txt
	|	|---NOTICE.txt
	|	|---README.md
	|	|---README.txt
	|	|---pom.xml
	+---loinc-lib	
	|	+---src
	|	|---pom.xml
	+---loinc-service	
	|	+---src
	|	|---pom.xml
	|---README.txt
	|---NOTICE.txt
	|---LICENSE.txt
	+---demo
```
3. To build source code go inside "common" folder open command prompt (cmd) and enter below command:
	"mvn clean install".
	Ex: D:\loinc_toolkit_src\common>mvn clean install

	This will create zip,jars,wars inside "target" folder of common, loinc-lib and loinc-service.
	
********************************************************************************
				FINISH
********************************************************************************
