-
Notifications
You must be signed in to change notification settings - Fork 1
Add documentation for most sold stock items query #95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sonzsara
wants to merge
2
commits into
main
Choose a base branch
from
ENG-230
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
|
|
||
| # Most Sold Stock Items | ||
|
|
||
| > Total quantity dispensed, selling price, purchase price, and margin per stock item | ||
|
|
||
| ## Purpose | ||
|
|
||
| Identifies the most-selling stock items by aggregating dispensed quantities and computing the gross margin (selling price minus purchase cost). | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | Example | | ||
| |-----------|------|-------------|---------| | ||
| | `stock_name` | TEXT | Filter by stock item name (exact match) | `'Paracetamol'` | | ||
| | `DATE` | DATE | Filter by date range on the charge item | `2026-05-01` | | ||
|
|
||
| --- | ||
|
|
||
| ## Query | ||
|
|
||
| ```sql | ||
| SELECT | ||
| pk.name AS stock_name, | ||
| SUM(md.quantity) AS total_quantity_dispensed, | ||
| SUM(ci.total_price) AS selling_price, | ||
| SUM(p.purchase_price * md.quantity) AS purchase_price, | ||
| SUM(ci.total_price - (p.purchase_price * md.quantity)) AS total_margin | ||
| FROM emr_medicationdispense md | ||
| JOIN emr_chargeitem ci ON md.charge_item_id = ci.id | ||
| JOIN emr_chargeitemdefinition cid ON ci.charge_item_definition_id = cid.id | ||
| JOIN emr_product p ON p.charge_item_definition_id = cid.id | ||
| JOIN emr_productknowledge pk ON p.product_knowledge_id = pk.id | ||
| WHERE md.status IN ('completed', 'in_progress', 'preparation') | ||
| AND md.deleted = FALSE | ||
| AND ci.status IN ('billed', 'paid') | ||
| --[[AND pk.name = {{stock_name}}]] | ||
| --[[AND {{DATE}}]] | ||
| GROUP BY pk.name | ||
| ORDER BY total_quantity_dispensed DESC; | ||
| ``` | ||
|
|
||
|
|
||
| ## Notes | ||
|
|
||
| - Only non-deleted medication dispenses are included. | ||
| - Dispense status is filtered to `completed`, `in_progress`, and `preparation` to capture both fulfilled and active dispenses. | ||
| - Charge item status is filtered to `billed` and `paid` to ensure only items that have generated revenue are counted. | ||
| - Metabase-specific filters (`[[...]]`) allow dynamic filtering in dashboards. | ||
| - Results are ordered by highest dispensed quantity first. | ||
|
|
||
| *Last updated: 2026-05-12* | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.