This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.2.0-ballot: STU 2.2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.1.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: CRD CDSHooks External Reference Response (Logical Definition) ( Abstract )

Defines CRD-specific constraints for the External Reference 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 of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• 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. Elements defined in Ancestors:extension, cards, systemActions, cards 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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CDSHooksResponse.cards.indicator	required	CDSIndicatorCodesVS http://hl7.org/fhir/tools/ValueSet/CDSIndicator
CDSHooksResponse.cards.source.topic	extensible	CRDCardType http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType From this IG
CDSHooksResponse.cards.suggestions.actions.type	required	CDSActionTypeCodesVS http://hl7.org/fhir/tools/ValueSet/CDSActionType
CDSHooksResponse.cards.selectionBehavior	required	CDSSelectionBehaviorCodesVS http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
CDSHooksResponse.cards.links.type	required	Pattern Value: absolute http://hl7.org/fhir/tools/ValueSet/CDSLinkType
CDSHooksResponse.systemActions.type	required	CDSActionTypeCodesVS http://hl7.org/fhir/tools/ValueSet/CDSActionType

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from CRDHooksResponseBase

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksResponse		0..*	CRDHooksResponseBase	This is an abstract profile. Elements defined in Ancestors:extension, cards, systemActions, cards The response to the discovery endpoint
cards	S	1..*	CDSHooksElement	CDS responses to show user
suggestions		0..0
links		1..*	CDSHooksElement	Link to app or additional information
type		1..1	code	absolute | smart Required Pattern: absolute
appContext		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksResponse		0..*	CRDHooksResponseBase	This is an abstract profile. Elements defined in Ancestors:extension, cards, systemActions, cards 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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CDSHooksResponse.cards.indicator	required	CDSIndicatorCodesVS http://hl7.org/fhir/tools/ValueSet/CDSIndicator
CDSHooksResponse.cards.source.topic	extensible	CRDCardType http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType From this IG
CDSHooksResponse.cards.suggestions.actions.type	required	CDSActionTypeCodesVS http://hl7.org/fhir/tools/ValueSet/CDSActionType
CDSHooksResponse.cards.selectionBehavior	required	CDSSelectionBehaviorCodesVS http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
CDSHooksResponse.cards.links.type	required	Pattern Value: absolute http://hl7.org/fhir/tools/ValueSet/CDSLinkType
CDSHooksResponse.systemActions.type	required	CDSActionTypeCodesVS http://hl7.org/fhir/tools/ValueSet/CDSActionType

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from CRDHooksResponseBase

Summary

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

Maturity: 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksResponse		0..*	CRDHooksResponseBase	This is an abstract profile. Elements defined in Ancestors:extension, cards, systemActions, cards 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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CDSHooksResponse.cards.indicator	required	CDSIndicatorCodesVS http://hl7.org/fhir/tools/ValueSet/CDSIndicator
CDSHooksResponse.cards.source.topic	extensible	CRDCardType http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType From this IG
CDSHooksResponse.cards.suggestions.actions.type	required	CDSActionTypeCodesVS http://hl7.org/fhir/tools/ValueSet/CDSActionType
CDSHooksResponse.cards.selectionBehavior	required	CDSSelectionBehaviorCodesVS http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
CDSHooksResponse.cards.links.type	required	Pattern Value: absolute http://hl7.org/fhir/tools/ValueSet/CDSLinkType
CDSHooksResponse.systemActions.type	required	CDSActionTypeCodesVS http://hl7.org/fhir/tools/ValueSet/CDSActionType

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Differential View

This structure is derived from CRDHooksResponseBase

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksResponse		0..*	CRDHooksResponseBase	This is an abstract profile. Elements defined in Ancestors:extension, cards, systemActions, cards The response to the discovery endpoint
cards	S	1..*	CDSHooksElement	CDS responses to show user
suggestions		0..0
links		1..*	CDSHooksElement	Link to app or additional information
type		1..1	code	absolute | smart Required Pattern: absolute
appContext		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksResponse		0..*	CRDHooksResponseBase	This is an abstract profile. Elements defined in Ancestors:extension, cards, systemActions, cards 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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
CDSHooksResponse.cards.indicator	required	CDSIndicatorCodesVS http://hl7.org/fhir/tools/ValueSet/CDSIndicator
CDSHooksResponse.cards.source.topic	extensible	CRDCardType http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType From this IG
CDSHooksResponse.cards.suggestions.actions.type	required	CDSActionTypeCodesVS http://hl7.org/fhir/tools/ValueSet/CDSActionType
CDSHooksResponse.cards.selectionBehavior	required	CDSSelectionBehaviorCodesVS http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
CDSHooksResponse.cards.links.type	required	Pattern Value: absolute http://hl7.org/fhir/tools/ValueSet/CDSLinkType
CDSHooksResponse.systemActions.type	required	CDSActionTypeCodesVS http://hl7.org/fhir/tools/ValueSet/CDSActionType

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from CRDHooksResponseBase

Summary

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

Maturity: 4

Other representations of profile: CSV, Excel