Skip to content

Commit c6b9eaa

Browse files
authored
change course to link instead of response
following feedback
1 parent bb1436e commit c6b9eaa

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

docs/specification/current.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,6 @@ Field | Optionality | Type | Description
512512
----- | ----- | ----- | --------
513513
`cards` | REQUIRED | *array* of **[Cards](#card-attributes)** | An array of **Cards**. Cards can provide a combination of information (for reading), suggested actions (to be applied if a user selects them), and links (to launch an app if the user selects them). The CDS Client decides how to display cards, but this specification recommends displaying suggestions using buttons, and links using underlined text.
514514
`systemActions` | OPTIONAL | *array* of **[Actions](#action)** | An array of **Actions** that the CDS Service proposes to auto-apply. Each action follows the schema of a [card-based `suggestion.action`](#action). The CDS Client decides whether to auto-apply actions.
515-
`no-guidance-but-app-launch` | OPTIONAL | *boolean* | A boolean informing the CDS Client that the only meaingful decision support contained in this Response is a single card with a single link. A CDS Service MUST NOT set this field to true if the card also returns a suggestion, or any other guidance intended to be seen by the user. This field serves as a hint to the CDS Client, that it could immediately launch the app from the link, without manual user interaction and without displaying the card. The CDS Client's user interface needs may override the possibility of an automated launch.
516515

517516
If your CDS Service has no decision support for the user, your service should return a 200 HTTP response with an empty array of cards, for example:
518517

@@ -662,7 +661,7 @@ Field | Optionality | Type | Description
662661
`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.
663662
`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.
664663
`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.
665-
664+
`try-auto-launch` | OPTIONAL | *boolean* | This field serves as a hint to the CDS Client suggesting to immediately launch the link, without displaying the card and therefore without manual user interaction. The CDS Client ultimately determines if a link can be automatically launched, taking into consideration user interface needs, workflow considerations, or even absence of support for this feature. Note that CDS Hooks responses containing links with `try-auto-launch` equal true may not be shown to the user. It's the CDS Service's responsibiltty to ensure that any decision support that exists in card(s) is shown via the launched app. Sufficiently advanced CDS Clients may support auto-launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.
666665

667666
### System Action
668667
A `systemAction` is the same **[Action](#action)** which may be returned in a suggestion, but is instead returned alongside the array of cards. A `systemAction` is not presented to the user within a card, but rather may be auto-applied without user intervention.
@@ -743,26 +742,26 @@ A `systemAction` is the same **[Action](#action)** which may be returned in a su
743742
```
744743

745744

746-
> Example response using `no-guidance-but-app-launch`
745+
> Example response using `try-auto-launch`
747746
748747
```json
749748
{
750-
"no-guidance-but-app-launch": true,
751749
"cards": [
752750
{
753751
"uuid": "4e0a3a1e-3283-4575-ab82-028d55fe2719",
754-
"summary": "Example Link Card",
755-
"detail": "Click the link to launch github.",
752+
"summary": "Lung cancer screening shared decision making",
753+
"detail": "Patient is a current smoker with a 20 pack/year history. Consider advising patient to complete lung cancer screening. The Lung Cancer Screening Shared Decision Making App (LCSSDM) has been proven to increase patient followthrough for screening.",
756754
"source": {
757-
"label": "Static CDS Service Example",
758-
"url": "https://example.com",
755+
"label": "Lung Cancer Screening Shared Decision Making App",
756+
"url": "https://example.com/LCS",
759757
"icon": "https://example.com/img/icon-100px.png"
760758
},
761759
"links": [
762760
{
763761
"label": "Github",
764762
"url": "https://github.com",
765-
"type": "absolute"
763+
"type": "absolute",
764+
"try-auto-launch": true
766765
}
767766
]
768767
}

0 commit comments

Comments
 (0)