diff --git a/input/pagecontent/index.md b/input/pagecontent/index.md index efb49e03..95e5c362 100644 --- a/input/pagecontent/index.md +++ b/input/pagecontent/index.md @@ -14,3 +14,23 @@ decision support from within a clinician's workflow. The API supports: * Synchronous, workflow-triggered CDS calls returning information and suggestions * Launching a user-facing SMART app when CDS requires additional interaction + +## CDS Hooks Anatomy + +This specification describes a ["hook"](https://en.wikipedia.org/wiki/Hooking)-based pattern for invoking +decision support from within a clinician's workflow. The API supports: + + * Synchronous, workflow-triggered CDS calls returning information and suggestions +* Launching a web page to provide additional information to the user +* Launching a user-facing SMART app when CDS requires additional interaction + +The main concepts of the specification are Services, CDS Clients, and Cards. + +### CDS Services +A _CDS Service_ is a service that provides recommendations and guidance through the RESTful APIs described by this specification. The primary APIs are [Discovery](#discovery), which allows a CDS Developer to publish the types of CDS Services it provides. The [Service](#calling-a-cds-service) API that CDS Clients use to request decision support. The [Feedback](#feedback) API through which services learn the outcomes of their recommendations and guidance. + +### CDS Clients +A _CDS Client_ is an Electronic Health Record (EHR), or other clinical information system that uses decision support by calling CDS Services at specific points in the application's workflow called [_hooks_](hooks.html). Each hook defines the _hook context_ (contextual information available within the CDS Client and specific to the workflow) that is provided as part of the request. Each service advertises which hooks it supports and what [_prefetch data_](#providing-fhir-resources-to-a-cds-service) (information needed by the CDS Service to determine what decision support should be presented) it requires. In addition, CDS Clients typically provide the FHIR resource server location and associated authorization information as part of the request to enable services to request additional information. + +### Cards +Decision support is then returned to the CDS Client in the form of [_cards_](#cds-service-response), which the CDS Client MAY display to the end-user as part of their workflow. Cards may be informational, or they may provide suggestions that the user may accept or reject they may provide a [link](#link) to additional information or even launch a SMART app when additional user interaction is required. diff --git a/input/pagecontent/services.md b/input/pagecontent/services.md index 56d42c40..24d0b277 100644 --- a/input/pagecontent/services.md +++ b/input/pagecontent/services.md @@ -14,26 +14,6 @@ If a JSON attribute is defined as OPTIONAL, and does not have a value, implement Unless otherwise specified, JSON attribute values SHALL NOT be null or empty, so `null`, `""`, `[]`, or `{}` are prohibited. If a JSON attribute is defined with as OPTIONAL, and does not have a value, implementers SHALL omit it. -## CDS Hooks Anatomy - -This specification describes a ["hook"](https://en.wikipedia.org/wiki/Hooking)-based pattern for invoking -decision support from within a clinician's workflow. The API supports: - - * Synchronous, workflow-triggered CDS calls returning information and suggestions -* Launching a web page to provide additional information to the user -* Launching a user-facing SMART app when CDS requires additional interaction - -The main concepts of the specification are Services, CDS Clients, and Cards. - -### CDS Services -A _CDS Service_ is a service that provides recommendations and guidance through the RESTful APIs described by this specification. The primary APIs are [Discovery](#discovery), which allows a CDS Developer to publish the types of CDS Services it provides. The [Service](#calling-a-cds-service) API that CDS Clients use to request decision support. The [Feedback](#feedback) API through which services learn the outcomes of their recommendations and guidance. - -### CDS Clients -A _CDS Client_ is an Electronic Health Record (EHR), or other clinical information system that uses decision support by calling CDS Services at specific points in the application's workflow called [_hooks_](hooks.html). Each hook defines the _hook context_ (contextual information available within the CDS Client and specific to the workflow) that is provided as part of the request. Each service advertises which hooks it supports and what [_prefetch data_](#providing-fhir-resources-to-a-cds-service) (information needed by the CDS Service to determine what decision support should be presented) it requires. In addition, CDS Clients typically provide the FHIR resource server location and associated authorization information as part of the request to enable services to request additional information. - -### Cards -Decision support is then returned to the CDS Client in the form of [_cards_](#cds-service-response), which the CDS Client MAY display to the end-user as part of their workflow. Cards may be informational, or they may provide suggestions that the user may accept or reject they may provide a [link](#link) to additional information or even launch a SMART app when additional user interaction is required. - ## Discovery A CDS Service is discoverable via a stable endpoint by CDS Clients. The Discovery endpoint includes information such as a description of the CDS Service, when it should be invoked, and any data that is requested to be prefetched.