Skip to content

Commit c39eaff

Browse files
brynrhodeskpshek
authored andcommitted
Added selectionBehavior field to the Response. Fixes #320 (#424)
1 parent 46a7830 commit c39eaff

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

docs/specification/1.0-api.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,13 +141,17 @@ definitions:
141141
enum:
142142
- info
143143
- warning
144-
- hard-stop
144+
- critical
145145
source:
146146
$ref: '#/definitions/Source'
147147
suggestions:
148148
type: array
149149
items:
150150
$ref: '#/definitions/Suggestion'
151+
selectionBehavior:
152+
type: string
153+
enum:
154+
- at-most-one
151155
links:
152156
type: array
153157
items:

docs/specification/1.0.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,8 @@ Field | Optionality | Type | Description
356356
`detail` | OPTIONAL | *string* | Optional detailed information to display; if provided MUST be represented in [(GitHub Flavored) Markdown](https://github.github.com/gfm/). (For non-urgent cards, the EHR MAY hide these details until the user clicks a link like "view more details...").
357357
`indicator` | REQUIRED | *string* | Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: `info`, `warning`, `critical`. The EHR MAY use this field to help make UI display decisions such as sort order or coloring.
358358
`source` | REQUIRED | *object* | Grouping structure for the **Source** of the information displayed on this card. The source should be the primary source of guidance for the decision support the card represents.
359-
<nobr>`suggestions`</nobr> | OPTIONAL | *array* of **Suggestions** | Allows a service to suggest a set of changes in the context of the current activity (e.g. changing the dose of the medication currently being prescribed, for the `medication-prescribe` activity). If used, the user MUST be allowed to choose no more than one suggestion.
359+
<nobr>`suggestions`</nobr> | OPTIONAL | *array* of **Suggestions** | Allows a service to suggest a set of changes in the context of the current activity (e.g. changing the dose of the medication currently being prescribed, for the `medication-prescribe` activity). If suggestions are present, `selectionBehavior` MUST also be provided.
360+
`selectionBehavior` | OPTIONAL | *string* | Describes the intended selection behavior of the suggestions in the card. Currently, the only allowed value is `at-most-one`, indicating that the user may choose none or at most one of the suggestions. Future versions of the specification may expand this behavior, so EHRs that do not understand the value MUST treat the card as an error. EHRs MUST support the value of `at-most-one`.
360361
`links` | OPTIONAL | *array* of **Links** | Allows a service to suggest a link to an app that the user might want to run for additional information or to help guide a decision.
361362

362363
#### Source

0 commit comments

Comments
 (0)