Skip to content

Commit 46ad1ac

Browse files
authored
Update docs/specification/current.md
1 parent c6b9eaa commit 46ad1ac

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/specification/current.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ Field | Optionality | Type | Description
661661
`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.
662662
`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.
663663
`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.
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.
664+
`try-auto-launch` | OPTIONAL | *boolean* | This field serves as a hint to the CDS Client suggesting this link be immediately launched, without displaying the card and 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 optional feature. Note that CDS Hooks responses containing links with this field set to true may not be shown to the user. It's the CDS Service's responsibility to ensure that any decision support that exists in the CDS Hooks response's card(s) is communicated 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.
665665

666666
### System Action
667667
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.

0 commit comments

Comments
 (0)