FHIR Chat · docs / Issue #21 Add a Suggestion Type · cds hooks/github

Stream: cds hooks/github

Topic: docs / Issue #21 Add a Suggestion Type

view this post on Zulip Github Notifications (Aug 08 2017 at 19:42):

robs16 edited Issue #21

An EHR might allow users to take actions on CDS cards outside of clicking suggestion buttons or links. For example, the EHR could allow users to dismiss a card so that it no longer appears, ignoring any suggestions on the card. There is currently no mechanism in the CDS-hook spec that allows for the EHR to notify the CDS service that such an action has taken place.

The existing CDS-Hooks specification provides suggestion with only a label to describe them to the consuming EMR. However it is very common to have different types of suggestions which may be displayed or utilized differently by the EMR. Other than ‘accept’ suggestions which may add, remove, or modify the order, it is useful to capture the reasons a user decided not to accept the suggested changes.

Please consider adding a Suggestion.type required field with values of ‘accept’, ‘override’, ‘prompt’, ‘dismiss’:

  • accept - for suggestions which are considered accepting the requested changes
  • override - for suggestions where there is a reason for not accepting changes
  • prompt - For override reasons where the user should be prompted for additional information (the prompt would be part of the label). For analytics postback, the text entered by the user should be included in the POST body
  • dismiss - The default reason, which would be called if the user closes the card display or otherwise dismisses it without selecting a suggestion.

The suggestions structure with these changes might look similar to the following:

  "suggestions": [
    {
      "type": "dismiss",
      "label": "Dismiss",
      "uuid": "27b525a4-71d7-4b01-b796-294178da5544"
    },
    {
      "type": "accept",
      "actions": [
        {
          "type": "delete",
          "resource": "DiagnosticOrder/117262"
        }
      ],
      "label": "Remove Orders",
      "uuid": "b0fefb6a-406b-4efb-b416-29a88118a066"
    },
    {
      "type": "override",
      "label": "Rapid eye movement sleep disorders",
      "uuid": "f0a30281-d0cd-4eff-b105-d9a47c2ce324"
    },
    {
      "type": "prompt",
      "label": "Other (please specify)",
      "uuid": "1e770724-3342-4b5c-802b-cc3e48880e44"
    }
  ]

A 'prompt' type suggestion analytic post might include a body of the form:

{
  "response": "End-of-life care"
}

Last updated: Apr 12 2022 at 19:14 UTC


An HL7 Website -