Skip to content

Commit 8da48d7

Browse files
isaacvetterkpshek
authored andcommitted
Change EHR to CDS Client (fixes #407)
1 parent 4e898b8 commit 8da48d7

File tree

4 files changed

+86
-86
lines changed

4 files changed

+86
-86
lines changed

docs/community.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There are several ways in which you can get involved with the CDS Hooks communit
1313

1414
### Objectives
1515

16-
* Promote creation of clinical-grade service integrations (EHRs + CDS Services)
16+
* Promote creation of clinical-grade service integrations (CDS Clients + CDS Services)
1717
* Gain implementation experience with real-world systems
1818
* Refine the spec, balancing ease of use, flexibility, and stability
1919
* Drive toward pilot deployments with the ability to measure results

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This specification describes a
44
["hook"](http://en.wikipedia.org/wiki/Hooking)-based pattern for invoking
5-
decision support from within a clinician's EHR workflow. The API supports:
5+
decision support from within a clinician's workflow. The API supports:
66

77
* Synchronous, workflow-triggered CDS calls returning information and suggestions
88
* Launching a user-facing SMART app when CDS requires additional interaction
@@ -12,13 +12,13 @@ decision support from within a clinician's EHR workflow. The API supports:
1212

1313
## How it works
1414

15-
User activity inside the EHR triggers **CDS hooks** in real-time. For example:
15+
User activity inside the clinician's workflow triggers **CDS hooks** in real-time. For example:
1616

1717
* `patient-view` when opening a new patient record
1818
* `medication-prescribe` on authoring a new prescription
1919
* `order-review` on viewing pending orders for approval
2020

21-
When a triggering activity occurs, the EHR notifies each CDS service registered for the activity. These services must then provide near-real-time feedback about the triggering event. Each service gets basic details about the EHR
21+
When a triggering activity occurs, the CDS Client notifies each CDS service registered for the activity. These services must then provide near-real-time feedback about the triggering event. Each service gets basic details about the clinical workflow
2222
context (via the `context` parameter of the hook) plus whatever
2323
service-specific data are required (via the `pre-fetch-template` parameter).
2424

@@ -30,11 +30,11 @@ Each CDS service can return any number of **cards** in response to the hook.
3030
Cards convey some combination of text (*information card*), alternative
3131
suggestions (*suggestion card*), and links to apps or reference
3232
materials (*app link card*). A user sees these cards — one or more of each type
33-
— embedded in the EHR, and can interact with them as follows:
33+
— embedded in the workflow, and can interact with them as follows:
3434

3535
* *information card*: provides text for the user to read.
3636

37-
* *suggestion card*: provides a specific suggestion for which the EHR renders a button that the user can click to accept. Clicking automatically populates the suggested change into the EHR's UI.
37+
* *suggestion card*: provides a specific suggestion for which the CDS Client renders a button that the user can click to accept. Clicking automatically populates the suggested change into the clinician's UI.
3838

3939
* *app link card*: provides a link to an app (often a SMART app) where the user can supply details, step through a flowchart, or do anything else required to help reach an informed decision.
4040

docs/quickstart.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# Quick Start
22
This quick start tutorial defines each of the actors and provides details for implementing the `patient-view` hook.
33

4-
A CDS Hooks scenario typically includes two main actors: an EHR and a CDS Service. Below is an example interaction for the `patient-view` hook.
4+
A CDS Hooks scenario typically includes two main actors: an CDS Client and a CDS Service, where the CDS Client may be an EHR, CPOE or other clinical workflow system. Below is an example interaction for the `patient-view` hook.
55

66
![patient-view Hook Overview](images/patient-view-hook-launch_spec.png)
77

88
## Building a CDS Service
9-
A CDS Service is an external service that responds to EHR requests through cards. A card can optionally link to a SMART app. There are several steps to setting up a CDS Service:
9+
A CDS Service is an external service that responds to CDS Client requests through cards. A card can optionally link to a SMART app. There are several steps to setting up a CDS Service:
1010

1111
1. Create an endpoint for discovery
1212
2. Develop a service
1313
3. Test the service with the [sandbox](http://sandbox.cds-hooks.org/)
1414
4. If applicable, create a SMART app (or [borrow one](https://apps.smarthealthit.org/apps/pricing/open-source))
15-
5. Test the service (and, if applicable, SMART app) with an EHR
15+
5. Test the service (and, if applicable, SMART app) with an CDS Client
1616

1717
This tutorial recommends implementing the CDS Hooks [security model](specification/1.0/#security-and-safety) after successful open access testing.
1818

1919
### Endpoint for discovery
20-
The CDS Service must provide a stable endpoint for the EHR to discover the available services. A system must expose their services at `{baseUrl}/cds-services`. A service endpoint that supports the `patient-view` hook may return:
20+
The CDS Service must provide a stable endpoint for the CDS Client to discover the available services. A system must expose their services at `{baseUrl}/cds-services`. A service endpoint that supports the `patient-view` hook may return:
2121

2222
```json
2323
{
@@ -78,9 +78,9 @@ Select the configure hooks:<br>
7878
Delete the existing hooks, and then do a quick add with a reference to your CDS Service:<br>
7979
![Patient View Hooks Launch from Sandbox](images/demo-quick-add.png)
8080

81-
After testing with the sandbox, you are ready to connect with an EHR service.
81+
After testing with the sandbox, you are ready to connect with an CDS Client.
8282

83-
## Integrating CDS Services into an EHR
83+
## Integrating CDS Services into a CDS Client
8484
Build out following sections:
8585

8686
1. Call discovery endpoint
@@ -94,7 +94,7 @@ Build out following sections:
9494
This tutorial recommends implementing the CDS Hooks [security model](specification/1.0/#security-and-safety) after successful open access testing.
9595

9696
### Call discovery endpoint
97-
The CDS discovery endpoint provides the list of services a CDS provider supports, and the hooks a service should be invoked on. An EHR may configure their system to support a set of hooks at a certain location in their users work flow, or build a dynamic capability to interact with a CDS Service provider within a work flow. For the best end-user experience, this guide recommends a business analyst configure which hooks an EHR will support.
97+
The CDS discovery endpoint provides the list of services a CDS provider supports, and the hooks a service should be invoked on. A CDS Client may configure their system to support a set of hooks at a certain location in their users work flow, or build a dynamic capability to interact with a CDS Service provider within a work flow. For the best end-user experience, this guide recommends a business analyst configure which hooks a CDS Client will support.
9898

9999
Below is an example work flow where a business analyst accesses this list of available services by calling
100100

@@ -107,10 +107,10 @@ and then configures them in the system.
107107
This image captures a business analyst reviewing services from one CDS provider. A business analyst may review services from multiple providers and configure appropriate services per user profiles.
108108

109109
### Invoke service on patient-view hook
110-
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.
110+
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 CDS Client to decide which characteristics to consider.
111111

112112
### Support FHIR resource on CDS requests (context or pre-fetch)
113-
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:
113+
Often a CDS Service will require additional information from the CDS Client to perform the decision support logic, or determine the appropriate SMART app to return. Prefetch provides the CDS Client 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:
114114

115115
```json
116116
{
@@ -141,10 +141,10 @@ In some cases, additional information beyond what is included in the prefetch ma
141141
It is recommended FHIR servers implement, and CDS Services follow, locale specific implementation 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.
142142

143143
### Expose non-secured FHIR server for testing
144-
A non-secured FHIR server is important to support testing with a CDS Service. When the EHR moves a hook to production the system is expected to follow the guidelines in the [security](specification/1.0/#security-and-safety) requirements.
144+
A non-secured FHIR server is important to support testing with a CDS Service. When the CDS Client moves a hook to production the system is expected to follow the guidelines in the [security](specification/1.0/#security-and-safety) requirements.
145145

146146
### Render card
147-
The CDS Service will provide a response in the form a of a 'card'. Your EHR needs to be able to display the card.
147+
The CDS Service will provide a response in the form a of a 'card'. Your CDS Client needs to be able to display the card.
148148

149149
Example card JSON:
150150

0 commit comments

Comments
 (0)