Da Vinci - Coverage Requirements Discovery
2.2.1 - STU 2.2

Da Vinci - Coverage Requirements Discovery, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-crd/ and changes regularly. See the Directory of published versions

## Logical Model: CRD CDSHooks Response (Logical Definition)

Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse | Version: 2.2.1 | Highlight text changes?
Standards status: Trial-use Active as of 2026-03-26 | Maturity Level: 4 | Computable Name: CRDHooksResponse
Other Identifiers: OID:2.16.840.1.113883.4.642.40.18.42.35

Defines CRD-specific constraints on the CDS Hooks Response body

Usages:

- This Logical Model Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CDSHooksResponse |  | 0..* | CRDHooksResponseBase | The response to the discovery endpoint
Slices for cards |  | 0..* | CDSHooksElement | CDS responses to show user Slice: Unordered, Open by profile:$this
cards:externalReference |  | 0..* | CRDHooksResponseExternalReference | CDS responses to show user
cards:instructions |  | 0..* | CRDHooksResponseInstructions | CDS responses to show user
cards:alternateRequest |  | 0..* | CRDHooksResponseAlternateRequest | CDS responses to show user
cards:additionalOrders |  | 0..* | CRDHooksResponseAdditionalOrders | CDS responses to show user
cards:formCompletion |  | 0..* | CRDHooksResponseFormCompletion | CDS responses to show user
cards:adjustCoverage |  | 0..* | CRDHooksResponseAdjustCoverage | CDS responses to show user
cards:launchSMART |  | 0..* | CRDHooksResponseLaunchSMART | CDS responses to show user
Slices for systemActions |  | 0..* | CDSHooksElement | Actions to auto-apply Slice: Unordered, Open by profile:$this
systemActions:coverageInformation |  | 0..* | CRDHooksResponseCoverageInformation | Actions to auto-apply
systemActions:formCompletion |  | 0..* | CRDHooksResponseFormCompletion | Actions to auto-apply
systemActions:adjustCoverage |  | 0..* | CRDHooksResponseAdjustCoverage | Actions to auto-apply
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CDSHooksResponse |  | 0..* | CRDHooksResponseBase | The response to the discovery endpoint
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
Slices for cards | C | 0..* | CDSHooksElement | CDS responses to show user Slice: Unordered, Open by profile:$this JSON: The type of this element is inferred from the JSON type in the instance Constraints: cds-resp-1, cds-resp-6
cards:All Slices |  |  |  | Content/Rules for all slices
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:externalReference | C | 0..* | CRDHooksResponseExternalReference | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:instructions | C | 0..* | CRDHooksResponseInstructions | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:alternateRequest | C | 0..* | CRDHooksResponseAlternateRequest | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:additionalOrders | C | 0..* | CRDHooksResponseAdditionalOrders | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:formCompletion | C | 0..* | CRDHooksResponseFormCompletion | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:adjustCoverage | C | 0..* | CRDHooksResponseAdjustCoverage | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:launchSMART | C | 0..* | CRDHooksResponseLaunchSMART | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
Slices for systemActions |  | 0..* | CDSHooksElement | Actions to auto-apply Slice: Unordered, Open by profile:$this JSON: This element may be present as a JSON Array even when there are no items in the instance
systemActions:All Slices |  |  |  | Content/Rules for all slices
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | C | 0..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
systemActions:coverageInformation |  | 0..* | CRDHooksResponseCoverageInformation | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | C | 0..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
systemActions:formCompletion |  | 0..* | CRDHooksResponseFormCompletion | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | C | 0..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
systemActions:adjustCoverage |  | 0..* | CRDHooksResponseAdjustCoverage | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | C | 0..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CDSHooksResponse.cards.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:externalReference.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:externalReference.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:externalReference.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:externalReference.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:externalReference.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:instructions.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:instructions.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:instructions.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:instructions.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:instructions.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:alternateRequest.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:alternateRequest.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:alternateRequest.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:alternateRequest.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:alternateRequest.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:additionalOrders.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:additionalOrders.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:additionalOrders.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:additionalOrders.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:additionalOrders.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:formCompletion.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:formCompletion.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:formCompletion.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:formCompletion.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:formCompletion.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:adjustCoverage.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:adjustCoverage.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:adjustCoverage.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:adjustCoverage.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:adjustCoverage.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:launchSMART.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:launchSMART.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:launchSMART.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:launchSMART.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:launchSMART.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.systemActions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.systemActions:coverageInformation.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.systemActions:formCompletion.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.systemActions:adjustCoverage.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
cds-resp-1 | error | CDSHooksResponse.cards, CDSHooksResponse.cards:externalReference, CDSHooksResponse.cards:instructions, CDSHooksResponse.cards:alternateRequest, CDSHooksResponse.cards:additionalOrders, CDSHooksResponse.cards:formCompletion, CDSHooksResponse.cards:adjustCoverage, CDSHooksResponse.cards:launchSMART | 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, CDSHooksResponse.cards:externalReference.suggestions.actions, CDSHooksResponse.cards:instructions.suggestions.actions, CDSHooksResponse.cards:alternateRequest.suggestions.actions, CDSHooksResponse.cards:additionalOrders.suggestions.actions, CDSHooksResponse.cards:formCompletion.suggestions.actions, CDSHooksResponse.cards:adjustCoverage.suggestions.actions, CDSHooksResponse.cards:launchSMART.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, CDSHooksResponse.cards:externalReference.links, CDSHooksResponse.cards:instructions.links, CDSHooksResponse.cards:alternateRequest.links, CDSHooksResponse.cards:additionalOrders.links, CDSHooksResponse.cards:formCompletion.links, CDSHooksResponse.cards:adjustCoverage.links, CDSHooksResponse.cards:launchSMART.links | AppContext only for smart Apps | `(type != 'smart') implies (appContext.empty())`
cds-resp-4 | error | CDSHooksResponse.cards.overrideReasons, CDSHooksResponse.cards:externalReference.overrideReasons, CDSHooksResponse.cards:instructions.overrideReasons, CDSHooksResponse.cards:alternateRequest.overrideReasons, CDSHooksResponse.cards:additionalOrders.overrideReasons, CDSHooksResponse.cards:formCompletion.overrideReasons, CDSHooksResponse.cards:adjustCoverage.overrideReasons, CDSHooksResponse.cards:launchSMART.overrideReasons | the CDS Service MUST populate a display value for each reason's Coding | `all(display.exists())`
cds-resp-5 | error | CDSHooksResponse.cards.suggestions, CDSHooksResponse.cards:externalReference.suggestions, CDSHooksResponse.cards:instructions.suggestions, CDSHooksResponse.cards:alternateRequest.suggestions, CDSHooksResponse.cards:additionalOrders.suggestions, CDSHooksResponse.cards:formCompletion.suggestions, CDSHooksResponse.cards:adjustCoverage.suggestions, CDSHooksResponse.cards:launchSMART.suggestions | All suggestion actions must have a description | `actions.all(description.exists())`
cds-resp-6 | error | CDSHooksResponse.cards, CDSHooksResponse.cards:externalReference, CDSHooksResponse.cards:instructions, CDSHooksResponse.cards:alternateRequest, CDSHooksResponse.cards:additionalOrders, CDSHooksResponse.cards:formCompletion, CDSHooksResponse.cards:adjustCoverage, CDSHooksResponse.cards:launchSMART | If suggestions are present, selectionBehavior MUST also be provided. | `suggestions.exists() implies selectionBehavior.exists()`

Summary

Structures

This structure refers to these other structures:

- CRD CDSHooks External Reference Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-externalReference)
- CRD CDSHooks Instructions Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-instructions)
- CRD CDSHooks Alternate Request Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-alternateRequest)
- CRD CDSHooks Additional Orders Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-additionalOrders)
- CRD CDSHooks Form Completion Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-formCompletion)
- CRD CDSHooks Adjust Coverage Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-adjustCoverage)
- CRD CDSHooks SMART App Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-launchSMART)
- CRD CDSHooks Coverage Information Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-coverageInformation)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of CDSHooksResponse.cards
- The element 1 is sliced based on the value of CDSHooksResponse.systemActions

Maturity: 4

Differential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CDSHooksResponse |  | 0..* | CRDHooksResponseBase | The response to the discovery endpoint
Slices for cards |  | 0..* | CDSHooksElement | CDS responses to show user Slice: Unordered, Open by profile:$this
cards:externalReference |  | 0..* | CRDHooksResponseExternalReference | CDS responses to show user
cards:instructions |  | 0..* | CRDHooksResponseInstructions | CDS responses to show user
cards:alternateRequest |  | 0..* | CRDHooksResponseAlternateRequest | CDS responses to show user
cards:additionalOrders |  | 0..* | CRDHooksResponseAdditionalOrders | CDS responses to show user
cards:formCompletion |  | 0..* | CRDHooksResponseFormCompletion | CDS responses to show user
cards:adjustCoverage |  | 0..* | CRDHooksResponseAdjustCoverage | CDS responses to show user
cards:launchSMART |  | 0..* | CRDHooksResponseLaunchSMART | CDS responses to show user
Slices for systemActions |  | 0..* | CDSHooksElement | Actions to auto-apply Slice: Unordered, Open by profile:$this
systemActions:coverageInformation |  | 0..* | CRDHooksResponseCoverageInformation | Actions to auto-apply
systemActions:formCompletion |  | 0..* | CRDHooksResponseFormCompletion | Actions to auto-apply
systemActions:adjustCoverage |  | 0..* | CRDHooksResponseAdjustCoverage | Actions to auto-apply
Documentation for this format

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CDSHooksResponse |  | 0..* | CRDHooksResponseBase | The response to the discovery endpoint
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
Slices for cards | C | 0..* | CDSHooksElement | CDS responses to show user Slice: Unordered, Open by profile:$this JSON: The type of this element is inferred from the JSON type in the instance Constraints: cds-resp-1, cds-resp-6
cards:All Slices |  |  |  | Content/Rules for all slices
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:externalReference | C | 0..* | CRDHooksResponseExternalReference | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:instructions | C | 0..* | CRDHooksResponseInstructions | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:alternateRequest | C | 0..* | CRDHooksResponseAlternateRequest | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:additionalOrders | C | 0..* | CRDHooksResponseAdditionalOrders | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:formCompletion | C | 0..* | CRDHooksResponseFormCompletion | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:adjustCoverage | C | 0..* | CRDHooksResponseAdjustCoverage | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
cards:launchSMART | C | 0..* | CRDHooksResponseLaunchSMART | 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
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
uuid | S | 1..1 | uuid | Unique identifier of the card (for logging/feedback) When this element is read `urn:uuid:` is prefixed to the value before validation
summary | S | 1..1 | string | Summary message for display to the user (<140 char)
detail |  | 0..1 | markdown | Optional detailed information to display (GitHub Flavored Markdown)
indicator | S | 0..1 | code | info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required)
source | S | 1..1 | CDSHooksElement | The primary source of guidance for the content the card represents.
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Short, human-readable label to display for the source.
url |  | 0..1 | url | Link for when user clicks for more information about the source
icon |  | 0..1 | url | absolute URL to an icon for the source (<100x100 PNG))
topic | S | 1..1 | Coding | Describes the content of the card Binding: CRD Response Types Value Set (extensible)
suggestions | C | 0..* | CDSHooksElement | Suggest a set of changes in the context of the current activity Constraints: cds-resp-5
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this suggestion
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
isRecommended |  | 0..1 | boolean | Which suggestion is most preferred of a set
actions | C | 0..* | CDSHooksElement | Defines a suggested action (all apply) Constraints: cds-resp-2
extension |  | 0..1 | CDSHooksExtensions | Extension
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | S C | 1..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
selectionBehavior | C | 0..1 | code | at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required)
overrideReasons | C | 0..* | Coding | Feedback from user on card - why not acted on Constraints: cds-resp-4
links | C | 0..* | CDSHooksElement | Link to app or additional information Constraints: cds-resp-3
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
label | S | 1..1 | string | Human-readable label to display for this link
url | S | 1..1 | url | URL to load
type | S | 1..1 | code | absolute | smart Binding: CDSLinkType Codes ValueSet (required)
appContext | S | 0..1 | string | Information to share when launching SMART app
Slices for systemActions |  | 0..* | CDSHooksElement | Actions to auto-apply Slice: Unordered, Open by profile:$this JSON: This element may be present as a JSON Array even when there are no items in the instance
systemActions:All Slices |  |  |  | Content/Rules for all slices
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | C | 0..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
systemActions:coverageInformation |  | 0..* | CRDHooksResponseCoverageInformation | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | C | 0..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
systemActions:formCompletion |  | 0..* | CRDHooksResponseFormCompletion | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | C | 0..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
systemActions:adjustCoverage |  | 0..* | CRDHooksResponseAdjustCoverage | Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
type | S | 1..1 | code | create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required)
description | C | 0..1 | string | Human-readable description of the suggested action
resource |  | 0..1 | Resource | FHIR resource to create/update
resourceId |  | 0..1 | url | A relative reference to the relevant resource.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CDSHooksResponse.cards.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:externalReference.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:externalReference.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:externalReference.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:externalReference.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:externalReference.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:instructions.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:instructions.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:instructions.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:instructions.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:instructions.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:alternateRequest.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:alternateRequest.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:alternateRequest.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:alternateRequest.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:alternateRequest.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:additionalOrders.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:additionalOrders.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:additionalOrders.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:additionalOrders.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:additionalOrders.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:formCompletion.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:formCompletion.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:formCompletion.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:formCompletion.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:formCompletion.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:adjustCoverage.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:adjustCoverage.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:adjustCoverage.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:adjustCoverage.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:adjustCoverage.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:launchSMART.​indicator | Base | required | CDSIndicator Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:launchSMART.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.1 | This IG
CDSHooksResponse.cards:launchSMART.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:launchSMART.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.cards:launchSMART.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.systemActions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.systemActions:coverageInformation.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.systemActions:formCompletion.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1
CDSHooksResponse.systemActions:adjustCoverage.​type | Base | required | CDSActionType Codes ValueSet | 📦1.1.2 | FHIR Tooling Extensions IG v1.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
cds-resp-1 | error | CDSHooksResponse.cards, CDSHooksResponse.cards:externalReference, CDSHooksResponse.cards:instructions, CDSHooksResponse.cards:alternateRequest, CDSHooksResponse.cards:additionalOrders, CDSHooksResponse.cards:formCompletion, CDSHooksResponse.cards:adjustCoverage, CDSHooksResponse.cards:launchSMART | 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, CDSHooksResponse.cards:externalReference.suggestions.actions, CDSHooksResponse.cards:instructions.suggestions.actions, CDSHooksResponse.cards:alternateRequest.suggestions.actions, CDSHooksResponse.cards:additionalOrders.suggestions.actions, CDSHooksResponse.cards:formCompletion.suggestions.actions, CDSHooksResponse.cards:adjustCoverage.suggestions.actions, CDSHooksResponse.cards:launchSMART.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, CDSHooksResponse.cards:externalReference.links, CDSHooksResponse.cards:instructions.links, CDSHooksResponse.cards:alternateRequest.links, CDSHooksResponse.cards:additionalOrders.links, CDSHooksResponse.cards:formCompletion.links, CDSHooksResponse.cards:adjustCoverage.links, CDSHooksResponse.cards:launchSMART.links | AppContext only for smart Apps | `(type != 'smart') implies (appContext.empty())`
cds-resp-4 | error | CDSHooksResponse.cards.overrideReasons, CDSHooksResponse.cards:externalReference.overrideReasons, CDSHooksResponse.cards:instructions.overrideReasons, CDSHooksResponse.cards:alternateRequest.overrideReasons, CDSHooksResponse.cards:additionalOrders.overrideReasons, CDSHooksResponse.cards:formCompletion.overrideReasons, CDSHooksResponse.cards:adjustCoverage.overrideReasons, CDSHooksResponse.cards:launchSMART.overrideReasons | the CDS Service MUST populate a display value for each reason's Coding | `all(display.exists())`
cds-resp-5 | error | CDSHooksResponse.cards.suggestions, CDSHooksResponse.cards:externalReference.suggestions, CDSHooksResponse.cards:instructions.suggestions, CDSHooksResponse.cards:alternateRequest.suggestions, CDSHooksResponse.cards:additionalOrders.suggestions, CDSHooksResponse.cards:formCompletion.suggestions, CDSHooksResponse.cards:adjustCoverage.suggestions, CDSHooksResponse.cards:launchSMART.suggestions | All suggestion actions must have a description | `actions.all(description.exists())`
cds-resp-6 | error | CDSHooksResponse.cards, CDSHooksResponse.cards:externalReference, CDSHooksResponse.cards:instructions, CDSHooksResponse.cards:alternateRequest, CDSHooksResponse.cards:additionalOrders, CDSHooksResponse.cards:formCompletion, CDSHooksResponse.cards:adjustCoverage, CDSHooksResponse.cards:launchSMART | If suggestions are present, selectionBehavior MUST also be provided. | `suggestions.exists() implies selectionBehavior.exists()`

Summary

Structures

This structure refers to these other structures:

- CRD CDSHooks External Reference Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-externalReference)
- CRD CDSHooks Instructions Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-instructions)
- CRD CDSHooks Alternate Request Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-alternateRequest)
- CRD CDSHooks Additional Orders Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-additionalOrders)
- CRD CDSHooks Form Completion Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-formCompletion)
- CRD CDSHooks Adjust Coverage Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-adjustCoverage)
- CRD CDSHooks SMART App Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-launchSMART)
- CRD CDSHooks Coverage Information Response (Logical Definition) (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-coverageInformation)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of CDSHooksResponse.cards
- The element 1 is sliced based on the value of CDSHooksResponse.systemActions

Maturity: 4

Other representations of profile: CSV, Excel