Da Vinci - Coverage Requirements Discovery
​2.2.0-ballot - United States of America flag

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-ballot 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 External Reference Response (Logical Definition) ( Abstract )

Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-externalReference Version: 2.2.0-ballot
Standards status: Trial-use Active as of 2025-10-30 Maturity Level: 4 Computable Name: CRDHooksResponseExternalReference
Other Identifiers: OID:2.16.840.1.113883.4.642.40.18.42.48

Defines CRD-specific constraints for the External Reference response type

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CRDHooksResponseBase This is an abstract profile.
The response to the discovery endpoint
... cards S 1..* CDSHooksElement CDS responses to show user
.... suggestions 0..0 Suggest a set of changes in the context of the current activity
.... links 1..* CDSHooksElement Link to app or additional information
..... type 1..1 code absolute | smart
Required Pattern: absolute
..... appContext 0..0 Information to share when launching SMART app

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 SC 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 Card Types Value Set (extensible)
.... 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 1..* 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)
Required Pattern: absolute
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CDSHooksResponse.cards.​indicator Base required CDSIndicator Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8
CDSHooksResponse.cards.​source.topic Base extensible CRD Card Types Value Set 📦2.2.0-ballot This IG
CDSHooksResponse.cards.​suggestions.actions.​type Base required CDSActionType Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8
CDSHooksResponse.cards.​selectionBehavior Base required CDSSelectionBehavior Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8
CDSHooksResponse.cards.​links.type Base required CDSLinkType Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8
CDSHooksResponse.systemActions.​type Base required CDSActionType Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8

Constraints

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

Summary

Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 2 elements

Maturity: 4

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CRDHooksResponseBase This is an abstract profile.
The response to the discovery endpoint
... cards S 1..* CDSHooksElement CDS responses to show user
.... suggestions 0..0 Suggest a set of changes in the context of the current activity
.... links 1..* CDSHooksElement Link to app or additional information
..... type 1..1 code absolute | smart
Required Pattern: absolute
..... appContext 0..0 Information to share when launching SMART app

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 SC 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 Card Types Value Set (extensible)
.... 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 1..* 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)
Required Pattern: absolute
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CDSHooksResponse.cards.​indicator Base required CDSIndicator Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8
CDSHooksResponse.cards.​source.topic Base extensible CRD Card Types Value Set 📦2.2.0-ballot This IG
CDSHooksResponse.cards.​suggestions.actions.​type Base required CDSActionType Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8
CDSHooksResponse.cards.​selectionBehavior Base required CDSSelectionBehavior Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8
CDSHooksResponse.cards.​links.type Base required CDSLinkType Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8
CDSHooksResponse.systemActions.​type Base required CDSActionType Codes ValueSet 📦0.8.0 FHIR Tooling Extensions IG v0.8

Constraints

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

Summary

Mandatory: 2 elements
Must-Support: 1 element
Prohibited: 2 elements

Maturity: 4

 

Other representations of profile: CSV, Excel