Da Vinci - Coverage Requirements Discovery
2.2.0-snapshot - STU 2.2 Peer Review

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.0-snapshot 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 Form Completion Response (Logical Definition) ( Abstract )

Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-formCompletion | Version: 2.2.0-snapshot | Highlight text changes?
Standards status: Trial-use Active as of 2026-02-19 | Maturity Level: 4 | Computable Name: CRDHooksResponseFormCompletion
Other Identifiers: OID:2.16.840.1.113883.4.642.40.18.42.45

Defines CRD-specific constraints for the Form Completion response type

Usages:

- Use this Logical Model Profile: CRD CDSHooks Response (Logical Definition)

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 | This is an abstract profile. The response to the discovery endpoint
cards | S | 1..* | CDSHooksElement | CDS responses to show user
suggestions | S | 1..* | CDSHooksElement | Suggest a set of changes in the context of the current activity
actions | S | 1..* | CDSHooksElement | Defines a suggested action (all apply)
type | S | 1..1 | code | create, update, delete - type of action performed Required Pattern: create
resource | S | 0..1 | CRDTaskQuestionnaire | A task to be performed
resourceId |  | 0..0 |  | A relative reference to the relevant resource.
links |  | 0..0 |  | Link to app or additional information
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CDSHooksResponse |  | 0..* | CRDHooksResponseBase | This is an abstract profile. The response to the discovery endpoint
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
cards | S C | 1..* | 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
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 | S C | 1..* | 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 | S C | 1..* | 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) Required Pattern: create
description | S C | 1..1 | string | Human-readable description of the suggested action
resource | S | 0..1 | CRDTaskQuestionnaire | A task to be performed
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
systemActions |  | 0..* | CDSHooksElement | 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.0.0 | FHIR Tooling Extensions IG v1.0
CDSHooksResponse.cards.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.0-snapshot | This IG
CDSHooksResponse.cards.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.0.0 | FHIR Tooling Extensions IG v1.0
CDSHooksResponse.cards.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.0.0 | FHIR Tooling Extensions IG v1.0
CDSHooksResponse.cards.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.0.0 | FHIR Tooling Extensions IG v1.0
CDSHooksResponse.systemActions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.0.0 | FHIR Tooling Extensions IG v1.0

#### 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-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()`

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

- CRD Questionnaire Task (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-taskquestionnaire)

Maturity: 4

Differential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CDSHooksResponse |  | 0..* | CRDHooksResponseBase | This is an abstract profile. The response to the discovery endpoint
cards | S | 1..* | CDSHooksElement | CDS responses to show user
suggestions | S | 1..* | CDSHooksElement | Suggest a set of changes in the context of the current activity
actions | S | 1..* | CDSHooksElement | Defines a suggested action (all apply)
type | S | 1..1 | code | create, update, delete - type of action performed Required Pattern: create
resource | S | 0..1 | CRDTaskQuestionnaire | A task to be performed
resourceId |  | 0..0 |  | A relative reference to the relevant resource.
links |  | 0..0 |  | Link to app or additional information
Documentation for this format

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CDSHooksResponse |  | 0..* | CRDHooksResponseBase | This is an abstract profile. The response to the discovery endpoint
extension |  | 0..1 | CDSHooksExtensions | Object that has Named Extension Properties
cards | S C | 1..* | 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
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 | S C | 1..* | 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 | S C | 1..* | 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) Required Pattern: create
description | S C | 1..1 | string | Human-readable description of the suggested action
resource | S | 0..1 | CRDTaskQuestionnaire | A task to be performed
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
systemActions |  | 0..* | CDSHooksElement | 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.0.0 | FHIR Tooling Extensions IG v1.0
CDSHooksResponse.cards.​source.topic | Base | extensible | CRD Response Types Value Set | 📦2.2.0-snapshot | This IG
CDSHooksResponse.cards.​suggestions.actions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.0.0 | FHIR Tooling Extensions IG v1.0
CDSHooksResponse.cards.​selectionBehavior | Base | required | CDSSelectionBehavior Codes ValueSet | 📦1.0.0 | FHIR Tooling Extensions IG v1.0
CDSHooksResponse.cards.​links.type | Base | required | CDSLinkType Codes ValueSet | 📦1.0.0 | FHIR Tooling Extensions IG v1.0
CDSHooksResponse.systemActions.​type | Base | required | CDSActionType Codes ValueSet | 📦1.0.0 | FHIR Tooling Extensions IG v1.0

#### 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-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()`

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

- CRD Questionnaire Task (http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-taskquestionnaire)

Maturity: 4

Other representations of profile: CSV, Excel