Skip to content

Commit 91b916c

Browse files
authored
Merge pull request #443 from cds-hooks/issue/351-card-summary
Add brief summary of cards (fixes #351)
2 parents 8cbf27a + 0d1d78d commit 91b916c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/specification/1.0.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ In CDS Hooks, a _CDS Service_ is a service that provides patient-specific recomm
4141

4242
A _CDS Client_ or _EHR_ is an electronic health record, or other clinical information system that consumes decision support by calling CDS Services at specific points in the application's workflow called [hooks](#hooks). Each hook defines the _hook context_, contextual information available within the client and specific to the workflow. 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.
4343

44-
Decision support is then returned to the CDS Client in the form of [cards](#cds-service-response), which the client displays 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, or they may provide a [link](#link) to additional information or even launch a SMART-app when additional user interaction is required.
44+
Decision support is then returned to the CDS Client in the form of [cards](#cds-service-response), which the 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, or they may provide a [link](#link) to additional information or even launch a SMART app when additional user interaction is required.
4545

4646
## Discovery
4747

@@ -420,6 +420,8 @@ Below is an example `fhirAuthorization` parameter:
420420

421421
For successful responses, CDS Services SHALL respond with a 200 HTTP response with an object containing a `cards` element as described below.
422422

423+
Each card contains decision support from the CDS Service. Generally speaking, cards are intended for display to an end user. The data format of a card defines a very minimal set of required attributes with several more optional attributes to suit a variety of use cases. For instance, narrative informational decision support, actionable suggestions to modify data, and links to SMART apps.
424+
423425
> Note that because the CDS client may be invoking multiple services from the same hook, there may be multiple responses related to the same information. This specification does not address these scenarios specifically; both CDS Services and CDS Clients should consider the implications of multiple CDS Services in their integrations.
424426
425427
### HTTP Status Codes
@@ -431,7 +433,7 @@ Code | Description
431433

432434
CDS Services MAY return other HTTP statuses, specifically 4xx and 5xx HTTP error codes.
433435

434-
### Card Array
436+
### HTTP Response
435437

436438
Field | Optionality | Type | Description
437439
----- | ----- | ----- | --------

0 commit comments

Comments
 (0)