-
Notifications
You must be signed in to change notification settings - Fork 62
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
Added examples for Opioid guidelines and radiology assessment. #64
Conversation
@brynrhodes - Take a look at the deployed review app with your changes. There are some syntax errors that you'll need to fix. Also, move the example above the documentation. That will allow Slate to align the example in the righthand sidebar with the documentation in the middle pane. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @brynrhodes for adding these clinical examples / use cases! These will really help others understand more complex uses of CDS Hooks.
source/includes/_examples.md
Outdated
"system": "http://www.ama-assn.org/go/cpt", | ||
"code": "70450", | ||
"display": "CT, head, wo iv contrast" | ||
}], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This json is malformed due to the trailing comma on this line: }],
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed and fixed.
source/includes/_examples.md
Outdated
```json | ||
{ | ||
"hookInstance": "d1577c69-dfbe-44ad-ba6d-3e05e953b2ea", | ||
"fhirServer": "http://fhirtest.uhn.ca/baseDstu2", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather than use a real FHIR server URL here (and below), would you rather use something like https://fhir.example.com? I know we use http://hooks.smarthealthit.org:9080 in another example in the doc but these URLs will likely become broken in the future and developers may have expectations that they can hit this URL in the example. Using the example.com domain makes it clear that these are pure examples.
Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed.
"dateWritten": "2017-05-05", | ||
"status": "draft", | ||
"patient": { | ||
"reference": "Patient/example" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this match the Patient reference below (Patient/Patient-12214)?
|
||
This example illustrates the use of the CDS Hooks `medication-prescribe` hook to implement Recommendation #5 from the [CDC guideline for prescribing opioids for chronic pain](https://guidelines.gov/summaries/summary/50153/cdc-guideline-for-prescribing-opioids-for-chronic-pain---united-states-2016#420). | ||
|
||
This example is taken from the [Opioid Prescribing Support Implementation Guide](http://build.fhir.org/ig/cqframework/opioid-cds/), developed in partnership with the Centers for Disease Control and Prevention [(CDC)](https://www.cdc.gov/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: We'll need to change this URL off of the build domain to when we get the final published IG
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed
source/includes/_examples.md
Outdated
@@ -0,0 +1,219 @@ | |||
# Examples | |||
|
|||
## CDC Guideline for Prescribing Opioids for Chronic Pain - Request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Maybe we should make the h2 'CDC Guideline for Prescribing Opioids for Chronic Pain' and then both Request and Response can be h3 elements?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to do this, but the Slate processing didn't like it, it seemed to just ignore the h3 elements. Perhaps it was just a case of me not understanding how to express it with Slate?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just tested both ##
(h2) and ###
(h3) and they work. Only #
(h1) and ##
headers will show in the left hand sidebar. h3 headers do show in the middle documentation panel.
source/includes/_examples.md
Outdated
|
||
The opioid guideline request results in the following response that indicates the patient is at high risk for opioid overdose according to the CDC guidelines, and the dosage should be tapered to less than 50 MME. Links are provided to the guideline, as well as to the MME conversion tables provided by CDC. | ||
|
||
## Radiology Appropriateness - Request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same nit comment as above with the headings
source/includes/_examples.md
Outdated
{ | ||
"hookInstance": "d1577c69-dfbe-44ad-ba6d-3e05e953b2ea", | ||
"fhirServer": "http://fhirtest.uhn.ca/baseDstu2", | ||
"hook": "medication-prescribe", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Below you say this is using the order-review
hook
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed and fixed.
I added sub-headers for the request and response, but they don't line up with the code snippets, so it's a little confusing. Happy to go with the sub-headers though. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kpshek - can you rereview and approve?
Adds clinically relevant examples to address issue #32.