Skip to content

CDS Hooks Request Processing

c-schuler edited this page Aug 15, 2022 · 23 revisions

The CDS Hooks API offers a standardized request pattern to invoke clinical decision support.

The cqf-ruler currently supports the following hooks:

Usage

  • Discovery url: https://cloud.alphora.com/sandbox/r4/cqm/cds-services

  • CDS Request:

    https://cloud.alphora.com/sandbox/r4/cqm/cds-services/{user defined cds service name}

PlanDefinition to CarePlan to CDS Cards

In previous implementations for CDS Hooks request resolution, standardized CQL expressions were used to populate the CDS Card elements. That approach does not scale for more complex operations where multiple cards are returned. In an effort to provide more robust support for CDS Hooks requests, the request's PlanDefinition will go through a specialized $apply operation. The table below identifies which elements from the PlanDefinition are mapped to CDS Card elements, some of which may be dynamically resolved using dynamicValues (use the path value in the right-most column to specify which element to resolve) or an ActivityDefinition $apply operation.

PlanDefinition CDS Card Dynamic Path
action.title summary No N/A
action.dynamicValue summary Yes action.title
action.description detail No N/A
action.dynamicValue detail Yes action.description
action.dynamicValue indicator Yes action.extension
action.selectionBehavior selectionBehavior No N/A
action.documentation.display source.label No N/A
action.documentation.url source.url No N/A
action.documentation.document.url source.label No N/A
action.label suggestions.label No N/A
action.type suggestions.actions.type No N/A
action.definition -> ActivityDefinition.description suggestions.actions.description No N/A
action.definition -> ActivityDefinition $apply suggestions.actions.resource Yes N/A
relatedArtifact.display RequestGroup.extension.valueAttachment.title links.label No
relatedArtifact.url links.url No N/A
relatedArtifact.extension.valueString RequestGroup.extension.valueAttachment.extension.valueString links.type No N/A

Currently Unsupported Elements

  • Card.uuid
  • Card.overrideReasons
  • Card.source.topic
  • Card.suggestions.uuid
  • Card.links.appContext