This project is a MERN (MongoDB, Express, React, Node.js) stack application designed to manage and manipulate IPS (International Patient Summary) records. It includes features to convert between MongoDB, BEER, and IPS JSON formats, and supports various CRUD operations on IPS data. It also offers raw binary data encryption (using IV + MAC + compressed ciphertext) for secure and efficient data handling.

• Overview
• Features
• Setup
• API Documentation
  • POST Endpoints
  • GET Endpoints
  • PUT Endpoints
  • DELETE Endpoints
• Gzip Support
• AES-256 Support
• Client-Side Pages
• Technologies Used
• Contributing
• License

This application allows healthcare providers to create, update, delete, and convert patient records stored in MongoDB. The records can be transformed into different formats, including BEER (Basic Emergency Exchange Record) and IPS JSON, to facilitate data sharing and interoperability. Additionally, the application supports both JSON-based and raw binary encryption flows, giving users the flexibility to optimize performance and security.

• CRUD Operations: Create, Read, Update, and Delete IPS records.
• Format Conversion: Convert IPS records between MongoDB, BEER, and IPS JSON formats.
• API Endpoints: Comprehensive set of endpoints to manage IPS records.
• Responsive Frontend: User-friendly interface for managing and converting records.
• Search and Filter: Find records by various attributes.
• Advanced Encryption Options:
  • JSON-based AES-256 encryption with HMAC verification.
  • Raw Binary support using a 16-byte IV, 32-byte HMAC, and gzipped ciphertext for optimal security and space efficiency.

• Node.js
• MongoDB
• npm or yarn

1. Clone the repository:

   git clone https://github.com/yourusername/ips-mern-project.git
   cd ips-mern-project

2. Install server dependencies:

cd server
npm install

3. Install client dependencies:

cd ../client
npm install

4. Set up environment variables:

Create a .env file in the server directory with the following content:

DB_CONN=mongodb://localhost:27017/ipsDB

5. Start the development server:

cd ../server
npm run dev

6. Start the React development server:

cd ../client
npm start

This API supports gzip compression to optimize data transfer.

• Incoming Requests: When sending gzip-encoded data, set the Content-Encoding: gzip header.
• Outgoing Responses: To receive gzip-encoded responses, set the Accept-Encoding: gzip header.

1. Compress your payload using gzip.
2. Include the header Content-Encoding: gzip.
3. Send the compressed payload.

1. Set the header Accept-Encoding: gzip.
2. The API will return the response in gzip format if supported.

Request Headers for Gzip

Content-Type: application/json
Content-Encoding: gzip

Response Headers for Gzip

Content-Type: application/json
Content-Encoding: gzip

This API supports AES-256 encryption for secure data transfer.

• Incoming Requests: To send encrypted data, include the x-encrypted: true header and provide an encrypted payload.
• Outgoing Responses: To receive encrypted responses, include the Accept-Encryption: aes256 header in your request.

To facilitate compatibility and efficient data transfer, the API supports returning encrypted data encoded in Base64 format.

• Incoming Requests: To send in base64 format, include the header Content-Encoding: base64 with the encrypted payload. Make sure both the data and the iv are in base64 not hex.
• Outgoing Responses: Use the header Accept-Encoding: base64 The encrypted payload and IV will be returned as Base64-encoded strings.

1. Encrypt your payload using AES-256 encryption with the provided key and IV.
2. Include the x-encrypted: true header.
3. Send the encrypted payload in the request body as a JSON with the elements: encryptedData and iv.
4. Default format is hex strings for both elements. If you wish to send as base64 strings then use the Content-Encoding: base64.

1. Include the Accept-Encryption: aes256 header in your request.
2. Optionally, include the Accept-Encoding: base64 header to receive the encrypted data and iv encoded in Base64.
3. The response will be a JSON with two elements: encryptedData and iv.

his API also supports sending and receiving raw binary data via application/octet-stream. This is useful when you want a single binary payload that includes:

1. A 16-byte IV (initialization vector).
2. A 16-byte MAC (HMAC-SHA256 for integrity).
3. The encrypted + gzipped data. + +### Incoming Requests (Raw Binary)

1. Set the header: Content-Type: application/octet-stream
2. The first 16 bytes of your binary payload must be the IV, the next 16 bytes must be the MAC, and the remainder is the AES-256-CBC-encrypted, gzip-compressed data.
3. The server will:

• Verify the MAC to check integrity.
• Decrypt the payload using AES-256-CBC.
• Decompress the result from gzip.

1. Send a request with: Accept: application/octet-stream
2. The server will:

• Take the plaintext response body.
• Compress it with gzip.
• Encrypt it using AES-256-CBC.
• Compute the MAC for integrity.
• Return a binary payload consisting of [16-byte IV] + [32-byte MAC] + [Encrypted Gzipped Data]

3. The response will have:

• Content-Type: application/octet-stream
• X-Encrypted: true

1. Default Page

   • Purpose: Central page for managing IPS records. Users can add new records, edit existing records, and perform searches.
   • Features:
     • Search for records directly from the page.
     • Perform CRUD operations on IPS records.

2. API Page

   • Purpose: Provides an interface for interacting with API GET endpoints.
   • Features:
     • View available API endpoints.
     • Execute API calls and display the response.
     • Download the response data.
     • Includes the ability to encrypt and compress the response - base64

3. QR Page

   • Purpose: Generate and download QR codes for IPS records.
   • Features:
     • Create QR codes in various formats including IPS JSON and BEER.
     • Download the generated QR codes.
     • Includes the ability to encrypt and compress the response - base64

4. DMICP Page

   • Purpose: Facilitates the bulk upload of IPS records in the SmartDoc format.
   • Features:
     • Upload multiple IPS records simultaneously.
     • Supports the SmartDoc format for bulk data entry.

5. External API Pages

   • Purpose: Manage interactions with external IPS webApps/servers.
   • Features:
     • GET and POST IPS records between pre-defined endpoints (or manually entered) and the IPS MERN WebApp.

6. About Pages

   • Purpose: Provide detailed information about the IPS system and the WebApp.
   • Features:
     • Overview of IPS.
     • Information about the WebApp.
     • View the ChangeLog for recent updates.
     • Access the API Documentation page.

Each page in the application is designed to provide specific functionalities for managing and interacting with IPS records, ensuring a comprehensive and user-friendly experience.

Frontend: React, React Bootstrap Backend: Node.js, Express Database: MongoDB Other: Axios for HTTP requests, Mongoose for MongoDB interaction

Contributions are welcome! Please read our contributing guidelines before you submit a pull request.

This project is licensed under the MIT License. See the LICENSE file for details.