From 47ab24c1ef635e1b0d413de7b45fa970bccfb14e Mon Sep 17 00:00:00 2001 From: Bas van den Heuvel Date: Tue, 20 Sep 2022 09:16:34 -0400 Subject: [PATCH] Add Link to Suggestion --- docs/specification/current.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/specification/current.md b/docs/specification/current.md index 81b215ea..6228effc 100644 --- a/docs/specification/current.md +++ b/docs/specification/current.md @@ -577,6 +577,7 @@ Field | Optionality | Type | Description `uuid` | OPTIONAL | *string* | Unique identifier, used for auditing and logging suggestions. `isRecommended` | OPTIONAL | *boolean* | When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card. CDS Hooks clients may choose to influence their UI based on this value, such as pre-selecting, or highlighting recommended suggestions. Multiple suggestions MAY be recommended, if `card.selectionBehavior` is `any`. `actions` | OPTIONAL | *array* of **[Actions](#action)** | Array of objects, each defining a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within it. When a suggestion contains multiple actions, the actions SHOULD be processed as per FHIR's rules for processing [transactions](https://hl7.org/fhir/http.html#trules) with the CDS Client's `fhirServer` as the base url for the inferred full URL of the transaction bundle entries. (Specifically, deletes happen first, then creates, then updates). +`link` | OPTIONAL | [Link](#link) | Indicates an application that SHOULD be launched to satisfy this suggestion. ##### Action @@ -661,6 +662,7 @@ Field | Optionality | Type | Description `url` | REQUIRED | *URL* | URL to load (via `GET`, in a browser context) when a user clicks on this link. Note that this MAY be a "deep link" with context embedded in path segments, query parameters, or a hash. `type` | REQUIRED | *string* | The type of the given URL. There are two possible values for this field. A type of `absolute` indicates that the URL is absolute and should be treated as-is. A type of `smart` indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters. `appContext` | OPTIONAL | *string* | An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The `appContext` field should only be valued if the link type is `smart` and is not valid for `absolute` links. The `appContext` field and value will be sent to the SMART app as part of the [OAuth 2.0][OAuth 2.0] access token response, alongside the other [SMART launch parameters](http://hl7.org/fhir/smart-app-launch/1.0.0/scopes-and-launch-context/#launch-context-arrives-with-your-access_token) when the SMART app is launched. Note that `appContext` could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it. CDS Client support for `appContext` requires additional coordination with the authorization server that is not described or specified in CDS Hooks nor SMART. +`deferred` | OPTIONAL | boolean | The default value of this field is `false`. When set to `true`, it indicate that opening the application referred to by the `url` field may be deferred to a later point in time. ### System Action