CDS Hooks
3.0.0 - R3 Normative/Trial-Use International flag

CDS Hooks, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cds-hooks/ and changes regularly. See the Directory of published versions

Logical Model: CDSHooks Response (Logical Definition)

Official URL: http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse Version: 3.0.0
Standards status: Informative Maturity Level: 1 Computable Name: CDSHooksResponse
Other Identifiers: OID:2.16.840.1.113883.4.642.40.93.42.6

This structure is defined to allow the FHIR Validator to validate a CDSHooks Response body.

Usages:

  • This Logical Model is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksResponse 0..* CDSHooksElement The response to a CDS service request

Elements defined in Ancestors:extension
CDSHooksResponse.cards C 0..* CDSHooksElement CDS responses to show user
JSON: The type of this element is inferred from the JSON type in the instance
Constraints: cds-resp-1, cds-resp-6
CDSHooksResponse.cards.uuid 0..1 uuid Unique identifier of the card (for logging/feedback)
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksResponse.cards.summary 1..1 string Summary message for display to the user (<140 char)
CDSHooksResponse.cards.detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown)
CDSHooksResponse.cards.indicator 1..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
CDSHooksResponse.cards.source 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
CDSHooksResponse.cards.source.label 1..1 string Short, human-readable label to display for the source.
CDSHooksResponse.cards.source.url 0..1 url Link for when user clicks for more information about the source
CDSHooksResponse.cards.source.icon 0..1 url absolute URL to an icon for the source (<100x100 PNG))
CDSHooksResponse.cards.source.topic 0..1 Coding Describes the content of the card
CDSHooksResponse.cards.suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5, cds-resp-7
CDSHooksResponse.cards.suggestions.label 1..1 string Human-readable label to display for this suggestion
CDSHooksResponse.cards.suggestions.uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksResponse.cards.suggestions.isRecommended 0..1 boolean Which suggestion is most preferred of a set
CDSHooksResponse.cards.suggestions.actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
CDSHooksResponse.cards.suggestions.actions.type 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
CDSHooksResponse.cards.suggestions.actions.description C 0..1 string Human-readable description of the suggested action
CDSHooksResponse.cards.suggestions.actions.resource 0..1 Resource FHIR resource to create/update
CDSHooksResponse.cards.suggestions.actions.resourceId 0..1 string A relative reference to the relevant resource.
CDSHooksResponse.cards.suggestions.actionSelectionBehavior 0..1 code all | any | at-most-one (default: all)
CDSHooksResponse.cards.selectionBehavior C 0..1 code at-most-one | any
Binding: CDSSelectionBehavior Codes ValueSet (required)
CDSHooksResponse.cards.overrideReasons C 0..* Coding Feedback from user on card - why not acted on
Constraints: cds-resp-4
CDSHooksResponse.cards.links C 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
CDSHooksResponse.cards.links.label 1..1 string Human-readable label to display for this link
CDSHooksResponse.cards.links.url 1..1 url URL to load
CDSHooksResponse.cards.links.type 1..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
CDSHooksResponse.cards.links.appContext 0..1 string Information to share when launching SMART app
CDSHooksResponse.cards.links.autolaunchable 0..1 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. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.
CDSHooksResponse.systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CDSHooksResponse.cards.​indicator Base required CDSIndicator Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​suggestions.actions.​type Base required CDSActionType Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​selectionBehavior Base required CDSSelectionBehavior Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​links.type Base required CDSLinkType Codes ValueSet 📦3.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
cds-resp-1 error CDSHooksResponse.cards only one action can be suggested if selectionBehavior = at-most-one (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2 warning CDSHooksResponse.cards.suggestions.actions A resourceId not a resource must be provided when type = delete (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3 error CDSHooksResponse.cards.links AppContext only for smart Apps (type != 'smart') implies (appContext.empty())
cds-resp-4 error CDSHooksResponse.cards.overrideReasons the CDS Service MUST populate a display value for each reason's Coding all(display.exists())
cds-resp-5 error CDSHooksResponse.cards.suggestions All suggestion actions must have a description actions.all(description.exists())
cds-resp-6 error CDSHooksResponse.cards If suggestions are present, selectionBehavior MUST also be provided. suggestions.exists() implies selectionBehavior.exists()
cds-resp-7 error CDSHooksResponse.cards.suggestions actionSelectionBehavior must be 'all', 'any', or 'at-most-one' actionSelectionBehavior.empty() or actionSelectionBehavior = 'all' or actionSelectionBehavior = 'any' or actionSelectionBehavior = 'at-most-one'
NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksResponse 0..* CDSHooksElement The response to a CDS service request

Elements defined in Ancestors:extension
CDSHooksResponse.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards C 0..* CDSHooksElement CDS responses to show user
JSON: The type of this element is inferred from the JSON type in the instance
Constraints: cds-resp-1, cds-resp-6
CDSHooksResponse.cards.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.uuid 0..1 uuid Unique identifier of the card (for logging/feedback)
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksResponse.cards.summary 1..1 string Summary message for display to the user (<140 char)
CDSHooksResponse.cards.detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown)
CDSHooksResponse.cards.indicator 1..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
CDSHooksResponse.cards.source 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
CDSHooksResponse.cards.source.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.source.label 1..1 string Short, human-readable label to display for the source.
CDSHooksResponse.cards.source.url 0..1 url Link for when user clicks for more information about the source
CDSHooksResponse.cards.source.icon 0..1 url absolute URL to an icon for the source (<100x100 PNG))
CDSHooksResponse.cards.source.topic 0..1 Coding Describes the content of the card
CDSHooksResponse.cards.suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5, cds-resp-7
CDSHooksResponse.cards.suggestions.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.suggestions.label 1..1 string Human-readable label to display for this suggestion
CDSHooksResponse.cards.suggestions.uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksResponse.cards.suggestions.isRecommended 0..1 boolean Which suggestion is most preferred of a set
CDSHooksResponse.cards.suggestions.actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
CDSHooksResponse.cards.suggestions.actions.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.suggestions.actions.type 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
CDSHooksResponse.cards.suggestions.actions.description C 0..1 string Human-readable description of the suggested action
CDSHooksResponse.cards.suggestions.actions.resource 0..1 Resource FHIR resource to create/update
CDSHooksResponse.cards.suggestions.actions.resourceId 0..1 string A relative reference to the relevant resource.
CDSHooksResponse.cards.suggestions.actionSelectionBehavior 0..1 code all | any | at-most-one (default: all)
CDSHooksResponse.cards.selectionBehavior C 0..1 code at-most-one | any
Binding: CDSSelectionBehavior Codes ValueSet (required)
CDSHooksResponse.cards.overrideReasons C 0..* Coding Feedback from user on card - why not acted on
Constraints: cds-resp-4
CDSHooksResponse.cards.links C 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
CDSHooksResponse.cards.links.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.links.label 1..1 string Human-readable label to display for this link
CDSHooksResponse.cards.links.url 1..1 url URL to load
CDSHooksResponse.cards.links.type 1..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
CDSHooksResponse.cards.links.appContext 0..1 string Information to share when launching SMART app
CDSHooksResponse.cards.links.autolaunchable 0..1 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. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.
CDSHooksResponse.systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CDSHooksResponse.cards.​indicator Base required CDSIndicator Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​suggestions.actions.​type Base required CDSActionType Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​selectionBehavior Base required CDSSelectionBehavior Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​links.type Base required CDSLinkType Codes ValueSet 📦3.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
cds-resp-1 error CDSHooksResponse.cards only one action can be suggested if selectionBehavior = at-most-one (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2 warning CDSHooksResponse.cards.suggestions.actions A resourceId not a resource must be provided when type = delete (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3 error CDSHooksResponse.cards.links AppContext only for smart Apps (type != 'smart') implies (appContext.empty())
cds-resp-4 error CDSHooksResponse.cards.overrideReasons the CDS Service MUST populate a display value for each reason's Coding all(display.exists())
cds-resp-5 error CDSHooksResponse.cards.suggestions All suggestion actions must have a description actions.all(description.exists())
cds-resp-6 error CDSHooksResponse.cards If suggestions are present, selectionBehavior MUST also be provided. suggestions.exists() implies selectionBehavior.exists()
cds-resp-7 error CDSHooksResponse.cards.suggestions actionSelectionBehavior must be 'all', 'any', or 'at-most-one' actionSelectionBehavior.empty() or actionSelectionBehavior = 'all' or actionSelectionBehavior = 'any' or actionSelectionBehavior = 'at-most-one'
The source should be the primary source of guidance for the decision support the card representssource [1..1] Defines a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within itactions [0..*] Allows a service to suggest a set of changes in the context of the current activity (e.g. changing the dose of a medication currently being prescribed, for the order-sign activity)suggestions [0..*] 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 decisionlinks [0..*] 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)cards [0..*] An array of Actions that the CDS Service proposes to auto-applysystemActions [0..*] CDSHooksResponse ( CDSHooksElement )
extension : CDSHooksExtensions [0..1]
CDSHooksResponseCards
extension : CDSHooksExtensions [0..1]
uuid : uuid [0..1]
summary : string [1..1]
detail : markdown [0..1]
indicator : code [1..1] « CDSIndicatorCodesVS! »
selectionBehavior : code [0..1] « CDSSelectionBehaviorCodesVS! »
overrideReasons : Coding [0..*]
CDSHooksResponseCardsSource
extension : CDSHooksExtensions [0..1]
label : string [1..1]
url : url [0..1]
icon : url [0..1]
topic : Coding [0..1]
CDSHooksResponseCardsSuggestions
extension : CDSHooksExtensions [0..1]
label : string [1..1]
uuid : uuid [0..1]
isRecommended : boolean [0..1]
actionSelectionBehavior : code [0..1]
CDSHooksResponseCardsSuggestionsActions
extension : CDSHooksExtensions [0..1]
type : code [1..1] « CDSActionTypeCodesVS! »
description : string [0..1]
resource : Resource [0..1]
resourceId : string [0..1]
CDSHooksResponseCardsLinks
extension : CDSHooksExtensions [0..1]
label : string [1..1]
url : url [1..1]
type : code [1..1] « CDSLinkTypeCodesVS! »
appContext : string [0..1]
autolaunchable : boolean [0..1]

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(9 nested mandatory elements)

Maturity: 1

Differential View

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksResponse 0..* CDSHooksElement The response to a CDS service request

Elements defined in Ancestors:extension
CDSHooksResponse.cards C 0..* CDSHooksElement CDS responses to show user
JSON: The type of this element is inferred from the JSON type in the instance
Constraints: cds-resp-1, cds-resp-6
CDSHooksResponse.cards.uuid 0..1 uuid Unique identifier of the card (for logging/feedback)
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksResponse.cards.summary 1..1 string Summary message for display to the user (<140 char)
CDSHooksResponse.cards.detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown)
CDSHooksResponse.cards.indicator 1..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
CDSHooksResponse.cards.source 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
CDSHooksResponse.cards.source.label 1..1 string Short, human-readable label to display for the source.
CDSHooksResponse.cards.source.url 0..1 url Link for when user clicks for more information about the source
CDSHooksResponse.cards.source.icon 0..1 url absolute URL to an icon for the source (<100x100 PNG))
CDSHooksResponse.cards.source.topic 0..1 Coding Describes the content of the card
CDSHooksResponse.cards.suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5, cds-resp-7
CDSHooksResponse.cards.suggestions.label 1..1 string Human-readable label to display for this suggestion
CDSHooksResponse.cards.suggestions.uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksResponse.cards.suggestions.isRecommended 0..1 boolean Which suggestion is most preferred of a set
CDSHooksResponse.cards.suggestions.actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
CDSHooksResponse.cards.suggestions.actions.type 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
CDSHooksResponse.cards.suggestions.actions.description C 0..1 string Human-readable description of the suggested action
CDSHooksResponse.cards.suggestions.actions.resource 0..1 Resource FHIR resource to create/update
CDSHooksResponse.cards.suggestions.actions.resourceId 0..1 string A relative reference to the relevant resource.
CDSHooksResponse.cards.suggestions.actionSelectionBehavior 0..1 code all | any | at-most-one (default: all)
CDSHooksResponse.cards.selectionBehavior C 0..1 code at-most-one | any
Binding: CDSSelectionBehavior Codes ValueSet (required)
CDSHooksResponse.cards.overrideReasons C 0..* Coding Feedback from user on card - why not acted on
Constraints: cds-resp-4
CDSHooksResponse.cards.links C 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
CDSHooksResponse.cards.links.label 1..1 string Human-readable label to display for this link
CDSHooksResponse.cards.links.url 1..1 url URL to load
CDSHooksResponse.cards.links.type 1..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
CDSHooksResponse.cards.links.appContext 0..1 string Information to share when launching SMART app
CDSHooksResponse.cards.links.autolaunchable 0..1 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. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.
CDSHooksResponse.systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CDSHooksResponse.cards.​indicator Base required CDSIndicator Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​suggestions.actions.​type Base required CDSActionType Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​selectionBehavior Base required CDSSelectionBehavior Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​links.type Base required CDSLinkType Codes ValueSet 📦3.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
cds-resp-1 error CDSHooksResponse.cards only one action can be suggested if selectionBehavior = at-most-one (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2 warning CDSHooksResponse.cards.suggestions.actions A resourceId not a resource must be provided when type = delete (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3 error CDSHooksResponse.cards.links AppContext only for smart Apps (type != 'smart') implies (appContext.empty())
cds-resp-4 error CDSHooksResponse.cards.overrideReasons the CDS Service MUST populate a display value for each reason's Coding all(display.exists())
cds-resp-5 error CDSHooksResponse.cards.suggestions All suggestion actions must have a description actions.all(description.exists())
cds-resp-6 error CDSHooksResponse.cards If suggestions are present, selectionBehavior MUST also be provided. suggestions.exists() implies selectionBehavior.exists()
cds-resp-7 error CDSHooksResponse.cards.suggestions actionSelectionBehavior must be 'all', 'any', or 'at-most-one' actionSelectionBehavior.empty() or actionSelectionBehavior = 'all' or actionSelectionBehavior = 'any' or actionSelectionBehavior = 'at-most-one'

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksResponse 0..* CDSHooksElement The response to a CDS service request

Elements defined in Ancestors:extension
CDSHooksResponse.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards C 0..* CDSHooksElement CDS responses to show user
JSON: The type of this element is inferred from the JSON type in the instance
Constraints: cds-resp-1, cds-resp-6
CDSHooksResponse.cards.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.uuid 0..1 uuid Unique identifier of the card (for logging/feedback)
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksResponse.cards.summary 1..1 string Summary message for display to the user (<140 char)
CDSHooksResponse.cards.detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown)
CDSHooksResponse.cards.indicator 1..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
CDSHooksResponse.cards.source 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
CDSHooksResponse.cards.source.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.source.label 1..1 string Short, human-readable label to display for the source.
CDSHooksResponse.cards.source.url 0..1 url Link for when user clicks for more information about the source
CDSHooksResponse.cards.source.icon 0..1 url absolute URL to an icon for the source (<100x100 PNG))
CDSHooksResponse.cards.source.topic 0..1 Coding Describes the content of the card
CDSHooksResponse.cards.suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5, cds-resp-7
CDSHooksResponse.cards.suggestions.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.suggestions.label 1..1 string Human-readable label to display for this suggestion
CDSHooksResponse.cards.suggestions.uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksResponse.cards.suggestions.isRecommended 0..1 boolean Which suggestion is most preferred of a set
CDSHooksResponse.cards.suggestions.actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
CDSHooksResponse.cards.suggestions.actions.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.suggestions.actions.type 1..1 code create, update, delete - type of action performed
Binding: CDSActionType Codes ValueSet (required)
CDSHooksResponse.cards.suggestions.actions.description C 0..1 string Human-readable description of the suggested action
CDSHooksResponse.cards.suggestions.actions.resource 0..1 Resource FHIR resource to create/update
CDSHooksResponse.cards.suggestions.actions.resourceId 0..1 string A relative reference to the relevant resource.
CDSHooksResponse.cards.suggestions.actionSelectionBehavior 0..1 code all | any | at-most-one (default: all)
CDSHooksResponse.cards.selectionBehavior C 0..1 code at-most-one | any
Binding: CDSSelectionBehavior Codes ValueSet (required)
CDSHooksResponse.cards.overrideReasons C 0..* Coding Feedback from user on card - why not acted on
Constraints: cds-resp-4
CDSHooksResponse.cards.links C 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
CDSHooksResponse.cards.links.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksResponse.cards.links.label 1..1 string Human-readable label to display for this link
CDSHooksResponse.cards.links.url 1..1 url URL to load
CDSHooksResponse.cards.links.type 1..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
CDSHooksResponse.cards.links.appContext 0..1 string Information to share when launching SMART app
CDSHooksResponse.cards.links.autolaunchable 0..1 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. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.
CDSHooksResponse.systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CDSHooksResponse.cards.​indicator Base required CDSIndicator Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​suggestions.actions.​type Base required CDSActionType Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​selectionBehavior Base required CDSSelectionBehavior Codes ValueSet 📦3.0.0 This IG
CDSHooksResponse.cards.​links.type Base required CDSLinkType Codes ValueSet 📦3.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
cds-resp-1 error CDSHooksResponse.cards only one action can be suggested if selectionBehavior = at-most-one (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2 warning CDSHooksResponse.cards.suggestions.actions A resourceId not a resource must be provided when type = delete (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3 error CDSHooksResponse.cards.links AppContext only for smart Apps (type != 'smart') implies (appContext.empty())
cds-resp-4 error CDSHooksResponse.cards.overrideReasons the CDS Service MUST populate a display value for each reason's Coding all(display.exists())
cds-resp-5 error CDSHooksResponse.cards.suggestions All suggestion actions must have a description actions.all(description.exists())
cds-resp-6 error CDSHooksResponse.cards If suggestions are present, selectionBehavior MUST also be provided. suggestions.exists() implies selectionBehavior.exists()
cds-resp-7 error CDSHooksResponse.cards.suggestions actionSelectionBehavior must be 'all', 'any', or 'at-most-one' actionSelectionBehavior.empty() or actionSelectionBehavior = 'all' or actionSelectionBehavior = 'any' or actionSelectionBehavior = 'at-most-one'
The source should be the primary source of guidance for the decision support the card representssource [1..1] Defines a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within itactions [0..*] Allows a service to suggest a set of changes in the context of the current activity (e.g. changing the dose of a medication currently being prescribed, for the order-sign activity)suggestions [0..*] 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 decisionlinks [0..*] 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)cards [0..*] An array of Actions that the CDS Service proposes to auto-applysystemActions [0..*] CDSHooksResponse ( CDSHooksElement )
extension : CDSHooksExtensions [0..1]
CDSHooksResponseCards
extension : CDSHooksExtensions [0..1]
uuid : uuid [0..1]
summary : string [1..1]
detail : markdown [0..1]
indicator : code [1..1] « CDSIndicatorCodesVS! »
selectionBehavior : code [0..1] « CDSSelectionBehaviorCodesVS! »
overrideReasons : Coding [0..*]
CDSHooksResponseCardsSource
extension : CDSHooksExtensions [0..1]
label : string [1..1]
url : url [0..1]
icon : url [0..1]
topic : Coding [0..1]
CDSHooksResponseCardsSuggestions
extension : CDSHooksExtensions [0..1]
label : string [1..1]
uuid : uuid [0..1]
isRecommended : boolean [0..1]
actionSelectionBehavior : code [0..1]
CDSHooksResponseCardsSuggestionsActions
extension : CDSHooksExtensions [0..1]
type : code [1..1] « CDSActionTypeCodesVS! »
description : string [0..1]
resource : Resource [0..1]
resourceId : string [0..1]
CDSHooksResponseCardsLinks
extension : CDSHooksExtensions [0..1]
label : string [1..1]
url : url [1..1]
type : code [1..1] « CDSLinkTypeCodesVS! »
appContext : string [0..1]
autolaunchable : boolean [0..1]

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(9 nested mandatory elements)

Maturity: 1

 

Other representations of profile: CSV, Excel