Add initial 'Quick Start' page #113
Conversation
There was a problem hiding this comment.
Thanks for putting this together @brettmarquard! Some general comments:
Fix "CDS hooks" -> "CDS Hooks" throughout the page.
Should we add a banner at the top of this page stating "The CDS Hooks community would like to thank the Argonaut Project for their work in the initial creation of this Quick Start Guide."? (or something similar) I know we've talked about ensuring the Argonaut Project receives credit for their investment/work in CDS Hooks so perhaps this would be a good thing to do here.
I've got lots of little comments on the content of this page but I don't think its worth calling each out. Instead, it would likely be better for me to simply update the branch with my suggested changes to include in this review here.
docs/quickstart.md
Outdated
| The patient-view hook is invoked when a patient chart is opened. It's one of the most basic since the logic doesn't have any prior workflow dependencies. The service called on the patient-view hook could be dependent on patient characteristics, for example: sex, problems in problems list, active medications, etc. The current version of the CDS Hooks specification allows the EHR to decide which characteristics to consider. | ||
|
|
||
| ### Support for FHIR resources on request or prefetch | ||
| Often a CDS service will require additional information from the EHR to perform the decision support logic, or determine the appropriate SMART app to return. Prefetch provides the EHR the capability to pass a resource when invoking a service. For example, with a patient resource included a service could do a geography search for potential environmental risk factors. Below is an example request invoked on patient-view with a patient included: (***fix server, not working for me) |
There was a problem hiding this comment.
What do you mean by your "fix server, not working for me" comment?
There was a problem hiding this comment.
eek, can't immediately remember. My guess is I couldn't get the http://hooks.smarthealthit.org to work -- do we have a preferred FHIR server, and CDS server for examples?
We can fix in all location later since this server is referenced other places. I will remove this specific comment.
There was a problem hiding this comment.
Today our example patient-view CDS Service is available at http://hooks.fhir.me:8082/cds-services/patient-hello-world. However, @zplata is working to replace this over in cds-hooks/sandbox-cds-services so that URL will be changing very soon.
docs/quickstart.md
Outdated
| ### Render card | ||
| The CDS service will provide a response in the form a of a 'card'. Your EHR needs to be able to display the card. | ||
|
|
||
| Example card JSON: |
There was a problem hiding this comment.
I think that for both the example JSON as well as the SMART app card image, we should use content that is open source and vendor neutral.
In this case, I'd suggest we use an imagined Bilirubin CDS Service that returns a link to the Bilirubin Chart SMART app in its card.
docs/quickstart.md
Outdated
|
|
||
| `GET [base]/AllergyIntolerance?patient=[id]` | ||
|
|
||
| It is recommended FHIR servers implement, CDS Services follow, the guidance in the [Argonaut Data Query Guide (DSTU2)](http://www.fhir.org/guides/argonaut/r2/) or [HL7 US Core (STU3)](http://hl7.org/fhir/us/core/index.html) implementation guides when retrieving additional resources. Each profile page within these implementation guides includes queries FHIR servers are required to support. |
There was a problem hiding this comment.
Do we need to call out the Argonaut or US Core profile? While this is certainly applicable to the US market, it may not be in the rest of the world.
There was a problem hiding this comment.
I updated reference to make it clear these profiles are US examples. I think there is value in encouraging all implementers to look to profiles before rolling their own
docs/quickstart.md
Outdated
| It is recommended FHIR servers implement, and CDS Services follow, locale specific implementaiton guides. In the US, the recommended implementation guides to follow are the [Argonaut Data Query Guide (DSTU2)](http://www.fhir.org/guides/argonaut/r2/) or [HL7 US Core (STU3)](http://hl7.org/fhir/us/core/index.html). Each profile page within these implementation guides includes queries FHIR servers are required to support. | ||
|
|
||
| ### Exposed non-secured FHIR server | ||
| A non secured FHIR server is important to support testing with a CDS service. When the EHR moves a hook so to production the system to is expected to follow the guidelines in the [security](specification/#security) requirements. |
There was a problem hiding this comment.
"When the EHR moves a hook so to production the system to is expected to follow the guidelines in the security requirements." has some extraneous words in the sentence. Please update to: "When the EHR moves a hook to production the system is expected to follow the guidelines in the security requirements."
# Conflicts: # mkdocs.yml
There was a problem hiding this comment.
I'm good with merging this in as a starting point. This Quick Start guide needs additional fleshing out but my preference would be to merge this in now and make more continual, smaller edits/additions to the page. This will make the reviews smaller & faster.
Thanks @brettmarquard for putting this together!
this quick start is based on the Argonaut tutorial