Skip to content

Clinical-Support-Systems/canadian-drug-product-database

Repository files navigation

.NET Drug Product Database (DPD) API Wrapper

Sublime's custom image GitHub Workflow Status Nuget Nuget Version

About | Usage | Development | Acknowledgement | License


🔰 About

This library was created by Clinical Support Systems, who have experience integrating with APIs of varying complexity. We wanted to simplify the connection in .NET web applications so we could get on with the actual API implementation related to our work using the eHealth DHDR service which references drugs using the Drug Identification Number (DIN) so additional information is needed to be able to complete the remaining drug product information.

☀️ Usage

Here's how to use this library in your project.

🔌 NuGet Installation

Install-Package DrugProductDatabase

📦 YourCode.cs

Add the following to your code:

var result = await DrugProductRequest.GetDrugProduct(din: "02247087");

🔧 Development

If you want other people to contribute to this project, this is the section, make sure you always add this.

📓 Pre-Requisites

  • Nothing! This is a fully public API that has no authentication.

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

  1. Report a bug
    If you think you have encountered a bug, and I should know about it, feel free to report it and I will take care of it.

  2. Request a feature
    You can also request for a feature.

  3. Create a pull request
    It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

🌵 Branches

I use an agile continuous integration methodology, so the version is frequently updated and development is really fast.

  1. develop is the development branch.

  2. main is the production branch.

  3. No further branches should be created in the main repository.

Steps to create a pull request

  1. Make a PR to main branch.
  2. Comply with the best practices and guidelines e.g. where the PR concerns visual elements it should have an image showing the effect.
  3. It must pass all continuous integration checks and get positive reviews.

After this, changes will be merged.

🌟 Credit/Acknowledgment

  • David Ball
  • Kori Francis

🔒 MIT License

License