You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-9Lines changed: 19 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,17 @@
1
1
# Contributing to the Practice Fusion MME Calculator
2
2
3
-
Thank you for your interest in contributing to this project. From commenting on issues, to reviewing and sending Pull Requests, all contributions are welcome.
3
+
Thank you for your interest in contributing to this project. From commenting on issues, to reviewing and sending Pull
4
+
Requests, all contributions are welcome.
4
5
5
-
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for anyone who wants to learn how to [contribute to open source projects](https://opensource.guide/how-to-contribute/), along with a lot of other valuable information on open source.
6
+
The [Open Source Guides](https://opensource.guide/) website has a collection of resources for anyone who wants to learn
7
+
how to [contribute to open source projects](https://opensource.guide/how-to-contribute/), along with a lot of other
8
+
valuable information on open source.
6
9
7
-
As a reminder, all contributors are expected to adhere to the [Code of Conduct](https://github.com/practicefusion/mmecalculator/blob/master/CODE-OF-CONDUCT.md).
10
+
As a reminder, all contributors are expected to adhere to
11
+
the [Code of Conduct](https://github.com/practicefusion/mmecalculator/blob/master/CODE-OF-CONDUCT.md).
8
12
9
13
## Ways to Contribute
10
-
14
+
11
15
1. Contribute fixes, improvements and documentation
12
16
2. Replying to and assisting with open issues
13
17
3. Reviewing pull requests
@@ -16,15 +20,20 @@ As a reminder, all contributors are expected to adhere to the [Code of Conduct](
16
20
17
21
## Development Process
18
22
19
-
We use GitHub issues and pull requests to track bugs and contributions from the community, including Practice Fusion engineers. All changes are handled through pull requests, and before they are approved, the changes must meet the standards outlined in the [Contributing Code](#contributing-code) section below, including a review by Practice Fusion clinicians if there are any changes that might affect the clinical nature of the calculation results.
23
+
We use GitHub issues and pull requests to track bugs and contributions from the community, including Practice Fusion
24
+
engineers. All changes are handled through pull requests, and before they are approved, the changes must meet the
25
+
standards outlined in the [Contributing Code](#contributing-code) section below, including a review by Practice Fusion
26
+
clinicians if there are any changes that might affect the clinical nature of the calculation results.
20
27
21
28
### Changing Parsing Rules
22
29
23
-
Changes to the grammar require care and a lot of testing. Please follow the [guidelines](./src/Grammar/) when planning and developing grammar changes.
30
+
Changes to the grammar require care and a lot of testing. Please follow the [guidelines](./src/Grammar/) when planning
31
+
and developing grammar changes.
24
32
25
-
### Testing
33
+
### Testing
26
34
27
-
Code coverage is generated using [Coverlet](https://github.com/coverlet-coverage/coverlet). We aim for more than 90% coverage, with the exclusions documented in the [coverlet runsettings](./src/coverlet.runsettings) file.
35
+
Code coverage is generated using [Coverlet](https://github.com/coverlet-coverage/coverlet). We aim for more than 90%
36
+
coverage, with the exclusions documented in the [coverlet runsettings](./src/coverlet.runsettings) file.
28
37
29
38
## Versioning Process
30
39
@@ -36,7 +45,8 @@ We use MinVer.
36
45
37
46
## Workflow
38
47
39
-
Code-level contributions must be made through pull requests. This is done by forking the repository, making the changes locally, and using the testing projects to validate the changes you've made.
48
+
Code-level contributions must be made through pull requests. This is done by forking the repository, making the changes
49
+
locally, and using the testing projects to validate the changes you've made.
> Morphine Milligram Equivalent (MME) Calculator: APIs, Containers and Samples
5
6
6
-
The calculator accepts two parameters:
7
+
The calculator accepts two parameters:
7
8
8
-
1. the [RxNorm](https://www.nlm.nih.gov/research/umls/rxnorm/overview.html) RxCUI (the drug identifier), which is used to retrieve the RxNorm normalized drug name
9
-
2. the *sig*, free-text instructions from the prescriber or pharmacist indicating how the patient should use the medication
9
+
1. the [RxNorm](https://www.nlm.nih.gov/research/umls/rxnorm/overview.html) RxCUI (the drug identifier), which is used
10
+
to retrieve the RxNorm normalized drug name
11
+
2. the *sig*, free-text instructions from the prescriber or pharmacist indicating how the patient should use the
12
+
medication
10
13
11
-
The *sig* is used to establish a maximum or total daily dose. The normalized drug name is used to identify active opioids and their strengths, so that a total daily dose in milligrams (or the appropriate unit of measure) can be established. Finally, using the appropriate [conversion factor](https://www.hhs.gov/guidance/sites/default/files/hhs-guidance-documents/Opioid%20Morphine%20EQ%20Conversion%20Factors%20%28vFeb%202018%29.pdf), which sometimes requires additional information on the route or form of the drug, a maximum morphine milligram equivalence per day is calculated.
14
+
The *sig* is used to establish a maximum or total daily dose. The normalized drug name is used to identify active
15
+
opioids and their strengths, so that a total daily dose in milligrams (or the appropriate unit of measure) can be
which sometimes requires additional information on the route or form of the drug, a maximum morphine milligram
19
+
equivalence per day is calculated.
12
20
13
-
The result is returned along with analysis of the medications and sigs. The analysis breaks down the parsed and calculated information, and includes a confidence rating on the information, along with any explanation of failures. Currently, if there are any failures, the calculator returns a "no-confidence" result.
21
+
The result is returned along with analysis of the medications and sigs. The analysis breaks down the parsed and
22
+
calculated information, and includes a confidence rating on the information, along with any explanation of failures.
23
+
Currently, if there are any failures, the calculator returns a "no-confidence" result.
14
24
15
-
The calculator makes no recommendations regarding the [safety of the maximum MME per day](https://www.cdc.gov/drugoverdose/pdf/calculating_total_daily_dose-a.pdf), that is instead left up to calling services (like clinical decision support services), which should analyze the calculated result and the confidence of the calculation before making a recommendation.
25
+
The calculator makes no recommendations regarding
26
+
the [safety of the maximum MME per day](https://www.cdc.gov/drugoverdose/pdf/calculating_total_daily_dose-a.pdf), that
27
+
is instead left up to calling services (like clinical decision support services), which should analyze the calculated
28
+
result and the confidence of the calculation before making a recommendation.
16
29
17
30
## Installing / Getting started
18
31
19
32
### Installing the [NuGet Package](https://www.nuget.org/packages/PracticeFusion.MmeCalculator.Core)
33
+
20
34
To use the calculator in your own project, add the package:
We want to make contributing to this project as simple as possible, and we are grateful to the community for contributing bug fixes, feature requests and code improvments. Read below to learn how you can take part in improving the MME calculator.
96
+
We want to make contributing to this project as simple as possible, and we are grateful to the community for
97
+
contributing bug fixes, feature requests and code improvments. Read below to learn how you can take part in improving
98
+
the MME calculator.
64
99
65
100
### Bug reports
66
101
67
-
To report a bug [click here](https://github.com/practicefusion/mmecalculator/issues/new?assignees=&labels=&template=bug_report.md&title=) and fill in the template. We'll look at it as soon as we can.
and fill in the template. We'll look at it as soon as we can.
68
105
69
106
### Feature Requests
70
107
71
-
To request a new feature [click here](https://github.com/practicefusion/mmecalculator/issues/new?assignees=&labels=&template=feature_request.md&title=) and fill in the template.
### [Code of Conduct](https://github.com/practicefusion/mmecalculator/blob/master/CODE-OF-CONDUCT.md)
78
-
We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](https://github.com/practicefusion/mmecalculator/blob/master/CODE-OF-CONDUCT.md).
117
+
118
+
We have adopted a Code of Conduct that we expect project participants to adhere to. Please read
119
+
the [full text](https://github.com/practicefusion/mmecalculator/blob/master/CODE-OF-CONDUCT.md).
- In case of sensitive bugs like security vulnerabilities, please contact [security@practicefusion.com](mailto:security@practicefusion.com) directly instead of using the issue tracker. We value your effort to improve the security and privacy of this project!
125
+
- In case of sensitive bugs like security vulnerabilities, please
126
+
contact [security@practicefusion.com](mailto:security@practicefusion.com) directly instead of using the issue
127
+
tracker. We value your effort to improve the security and privacy of this project!
- Dr. Ken Kawamoto (via support from contracts HHS 75P00119F80176 and HHS 75P00120F80182 managed by Security Risk Solutions, Inc.), and the sig parsing for the [OpenCDS project](https://bitbucket.org/opencds/fhir-utils/src/master/src/main/java/org/opencds/RxSig.java).
Copy file name to clipboardExpand all lines: SECURITY.md
+3-2Lines changed: 3 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,13 @@
5
5
The following versions are supported with security updates.
6
6
7
7
| Version | Supported |
8
-
|-------|------------------|
8
+
|---------|--------------------|
9
9
| 1.2.x |:white_check_mark:|
10
10
| 1.1.x |:white_check_mark:|
11
11
| 1.0.x |:white_check_mark:|
12
12
| < 1.0 |:x:|
13
13
14
14
## Reporting a Vulnerability
15
15
16
-
To report sensitive bugs like security vulnerabilities, please contact security@practicefusion.com directly instead of using the issue tracker. We value your effort to improve the security and privacy of this project!
16
+
To report sensitive bugs like security vulnerabilities, please contact security@practicefusion.com directly instead of
17
+
using the issue tracker. We value your effort to improve the security and privacy of this project!
0 commit comments