Skip to content

Document prefetch token format and update examples (fixes #151) #181

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Mar 26, 2018
Merged

Document prefetch token format and update examples (fixes #151) #181

merged 5 commits into from
Mar 26, 2018

Conversation

kpshek
Copy link
Contributor

@kpshek kpshek commented Mar 26, 2018

  • {{User.id}} -> {{user}}
  • {{Patient.id}} -> {{context.patientId}}

@kpshek
Document prefetch token format and update examples (fixes #151)
43e47d2 
- {{User.id}} -> {{user}}
- {{Patient.id}} -> {{context.patientId}}
@kpshek kpshek temporarily deployed to cds-hooks-docs-pr-181 March 26, 2018 07:28 Inactive
@isaacvetter isaacvetter requested a review from brynrhodes March 26, 2018 15:26
@isaacvetter isaacvetter mentioned this pull request Mar 26, 2018
Closed
@isaacvetter
Copy link
Member

Hey Kevin,

There was some brief conversation about this notion in PR #109.

+The prefetch tokens defined by this example-hook would be {{context.patientId}} and {{context.medication.medicationId}}.

How far down into a json object is this path syntax intended to support? Note that we're also sidestepping repeating objects.

Why not only allow top-level strings to be referenced in context ?

Isaac

@isaacvetter isaacvetter mentioned this pull request Mar 26, 2018
Merged
@kpshek kpshek temporarily deployed to cds-hooks-docs-pr-181 March 26, 2018 17:11 Inactive
@kpshek kpshek temporarily deployed to cds-hooks-docs-pr-181 March 26, 2018 17:40 Inactive
@kpshek
Copy link
Contributor Author

kpshek commented Mar 26, 2018

Thanks @isaacvetter & @brynrhodes -- Your feedback has been applied in c6c2a14

brynrhodes
brynrhodes approved these changes Mar 26, 2018
View reviewed changes
Copy link
Contributor

@brynrhodes brynrhodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

brettmarquard
brettmarquard approved these changes Mar 26, 2018
View reviewed changes
Copy link
Collaborator

@brettmarquard brettmarquard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@kpshek kpshek merged commit 915d68d into master Mar 26, 2018
@kpshek kpshek deleted the issue/151-prefetch-tokens branch March 26, 2018 17:48
kpshek pushed a commit that referenced this pull request Mar 27, 2018
@brynrhodes @kpshek
Rework field table documentation (#183) (Fixes #171, #172, #173, #177)
7db0e6c 
* #171, #172, #173, #177: Changed Priority to Optionality in all tables. Added Type column to all tables to split type out from description. Fixed several references to Patient.id (changed to context.patientId) and corrected prefetch-template documentation based on new context tokens. Also changed User.id to userId for consistency with hook context names.

* #154: Initial draft of hook versioning support (#178)

* #154: Initial draft of hook versioning support

* #154: Added change log section

* #154: Added change log discussion and updated hook definitions

* #154: Removed status and changed formatting of hook metadata.

* Dropped patch from hook version specifier (when 0).

* Document that context should use Bundle, not array (#180) (fixes #158)

* iss 158 - context should use Bundle, not array

* order-review's context should use Bundle, not array

switch from array of fhir orders being placed to bundle of fhir orders in the context for order-review hook

* mention FHIR Bundle in context documentation

and remove reference to DSTU2-specific FHIR resource

* FHIR Bundles in context for new hooks

guidance on use of FHIR Bundles in context for new hooks and draft status of in-memory resources

* Fixed misspelling

ordesr  -> orders

* fix table formatting

add newline

* Document prefetch token format and update examples (fixes #151) (#181)

* Document prefetch token format and update examples (fixes #151)

- {{User.id}} -> {{user}}
- {{Patient.id}} -> {{context.patientId}}

* Clarify documentation on prefetch tokens after discussion with Isaac, Bryn, and Brett.

* Document that the scopes are those defined by SMART on FHIR (fixes #144) (#182)

* #171, #172, #173, #177: Changed Priority to Optionality in all tables. Added Type column to all tables to split type out from description. Fixed several references to Patient.id (changed to context.patientId) and corrected prefetch-template documentation based on new context tokens. Also changed User.id to userId for consistency with hook context names.

* Cleanup after rebase.

* Additional fixes after rebase

* Additional fixes after rebase

* Remove thematic break to see if that resolves the parse error

* Add missing } to JSON example

* remove extraneous brace from json example

* Fix & format the JSON example

* Format JSON example

* Added boolean to possible types for hook context.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@isaacvetter isaacvetter isaacvetter approved these changes

@brettmarquard brettmarquard brettmarquard approved these changes

@brynrhodes brynrhodes brynrhodes approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@kpshek @isaacvetter @brettmarquard @brynrhodes