/mpharma-diagnosis-codes

RESTful API that can allow us to utilize an internationally recognized set of diagnosis codes.

Primary LanguagePython

Sure, here's an example of what a README.md file for a Django project might look like:

My Django Project

This is a Django project that provides an API for managing medical diagnoses using the ICD-10 classification system.

Features

  • Create, read, update, and delete diagnoses
  • Upload diagnoses in bulk from a CSV file
  • View diagnoses by category or ICD version

Dependencies

This project requires the following software:

  • Python 3.x
  • Django 3.x
  • Django REST framework 3.x
  • Pandas (for bulk upload functionality)
  • Redis (for publisher-subscriber messaging)
  • PostgreSQL (for database)
  • Docker (for container communication and deployment)

Installation

  1. Clone the repository
  2. Verify the .env file in the root directory.
  3. Install the dependencies listed above using pip
  4. Set up the database by running python manage.py migrate
  5. Create a superuser account by running python manage.py createsuperuser
  6. Start the development server by running python manage.py runserver

API Documentation

Endpoints

GET /api/v1/diagnosis/

Returns a list of all diagnoses in the system.

POST /api/v1/diagnosis/

Creates a new diagnosis in the system.

GET /api/v1/diagnosis/{full_code}/

Returns the diagnosis with the specified full code.

PUT /api/v1/diagnosis/{full_code}/

Updates the diagnosis with the specified full code.

DELETE /api/v1/diagnosis/{full_code}/

Deletes the diagnosis with the specified full code.

POST /api/v1/upload/

Uploads diagnoses from a CSV file in bulk.

Authentication

Some API endpoints require authentication. To authenticate, include an Authorization header in your requests with a valid API token.

License

After the containers start up, the application should be accessible at http://localhost:<APP_HOST_PORT>.