You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update Quick Start guide based upon feedback (#387)
* spelling fix - add dash to "non secured"
Fixes#297
* consistent tense in quickstart guide
specifically the enumerated list of steps and corresponding headers of the Building an EHR service section of the document
* Update quickstart.md
Change header from "Building an EHR Service" to "Integrating CDS Services into an EHR"
* SMART app is optional
Fixes#294
A CDS Service is an external service that responds to EHR requests through cards. There are several steps to setting up 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:
10
10
11
11
1. Create an endpoint for discovery
12
12
2. Develop a service
13
13
3. Test the service with the [sandbox](http://sandbox.cds-hooks.org/)
14
-
4.Create a SMART app (or [borrow one](https://apps.smarthealthit.org/apps/pricing/open-source))
15
-
5. Test the service andSMART app with an EHR
14
+
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
16
16
17
17
This tutorial recommends implementing the CDS Hooks [security model](specification/1.0/#security-and-safety) after successful open access testing.
18
18
@@ -80,20 +80,20 @@ Delete the existing hooks, and then do a quick add with a reference to your CDS
80
80
81
81
After testing with the sandbox, you are ready to connect with an EHR service.
82
82
83
-
## Building an EHR Service
83
+
## Integrating CDS Services into an EHR
84
84
Build out following sections:
85
85
86
-
1.Calls discovery endpoint
86
+
1.Call discovery endpoint
87
87
2. Invoke service on patient-view
88
-
3. Support for FHIR resources on request (context or pre-fetch)
89
-
4.Exposed non-secured FHIR server
88
+
3. Support FHIR resource on CDS requests (context or pre-fetch)
89
+
4.Expose non-secured FHIR server for testing
90
90
5. Render card
91
91
6. Launch SMART app
92
-
7.Tested with external CDS Service
92
+
7.Test with external CDS Service
93
93
94
94
This tutorial recommends implementing the CDS Hooks [security model](specification/1.0/#security-and-safety) after successful open access testing.
95
95
96
-
### Calls discovery endpoint
96
+
### Call discovery endpoint
97
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.
98
98
99
99
Below is an example work flow where a business analyst accesses this list of available services by calling
@@ -109,7 +109,7 @@ This image captures a business analyst reviewing services from one CDS provider.
109
109
### Invoke service on patient-view hook
110
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.
111
111
112
-
### Support for FHIR resources on request or prefetch
112
+
### Support FHIR resource on CDS requests (context or pre-fetch)
113
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:
114
114
115
115
```json
@@ -140,8 +140,8 @@ In some cases, additional information beyond what is included in the prefetch ma
140
140
141
141
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.
142
142
143
-
### Exposed non-secured FHIR server
144
-
A nonsecured 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.
143
+
### 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.
145
145
146
146
### Render card
147
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.
@@ -174,7 +174,7 @@ Example card rendered: .
176
176
177
-
## Test with an external CDS Service
177
+
## Test with external CDS Service
178
178
179
179
No development is complete without testing with a CDS Service provider. Find a member in the [community](community) and test away.
0 commit comments