Stream: cds hooks/github
Topic: docs / Issue #200 Context and Prefetch discussion
Github Notifications (Apr 23 2018 at 20:40):
kpsethilcg opened Issue #200
Hook context and prefetch discussion is somewhat confusing, and the examples aren't very helpful since they repeat a lot of the same information.
I would suggest using a common example and showing the context, the prefetch, including what their definitions look like so its easier to understand what they look like.
Github Notifications (Apr 23 2018 at 20:43):
kpsethilcg edited Issue #200
Hook context and prefetch discussion is somewhat confusing, and the examples aren't very helpful since they repeat a lot of the same information.
I would suggest using a simple running example and showing the context, the prefetch, including what their definitions look like so its easier to understand what they look like.
Github Notifications (Apr 24 2018 at 04:27):
kpshek commented on Issue #200
Hi @kpsethilcg and thanks for the feedback!
Can you elaborate on what specifically you find confusing? For instance, if you could highlight particular statements or passages and explain what is confusing, that would help us better understand what proposed changes we could make to clarify our documentation.
Github Notifications (Apr 24 2018 at 19:22):
kpsethilcg commented on Issue #200
Having an easy to understand definition to start the Section would help. Eg, something like this after the intro paragraph would be good.
Hook context is... <definition>. An example of this is <example> where <x data> is the context for the hook since that's how the EHR workflow or action set the context.
In contrast, prefetch is <definition>. In our earlier example, an example of pre-fetch would be <example>.I think the info is all there but is a bit disorganized. Differentiating what would be a context vs what would be prefetched like you have with the example "Therefore, including the full patient resource in context would be unnecessary. For CDS Services that want the full patient resource, they can request it to be prefetched or fetch it as needed from the FHIR server." ... this can be pulled up earlier so it's immediately clear.
Github Notifications (Apr 24 2018 at 19:24):
kpshek commented on Issue #200
Thanks @kpsethilcg! If you would be willing to open a pull request with your proposed changes so we can review your suggestion more concretely, that would be fantastic!
Last updated: Apr 12 2022 at 19:14 UTC
