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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Logical Model: CDSHooks Feedback (Logical Definition) ( Experimental )

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

Usages:

• This Logical Model 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
CDSHooksFeedback		0..*	CDSHooksElement	The request body for the CDS Hooks feedback endpoint Elements defined in Ancestors:extension
feedback	C	0..*	CDSHooksElement	Array of Feedback entries JSON: The type of this element is inferred from the JSON type in the instance Constraints: cds-fb-1, cds-fb-2
card		1..1	uuid	Identifier of the card the user acted on When this element is read urn:uuid: is prefixed to the value before validation
outcome		1..1	code	accepted | overridden
acceptedSuggestions		0..*	CDSHooksElement	Suggestions accepted by the user
id		1..1	uuid	Identifier of the accepted suggestion When this element is read urn:uuid: is prefixed to the value before validation
overrideReason	C	0..1	CDSHooksElement	Reason the user overrode the card Constraints: cds-fb-3
reason		0..1	Coding	The override reason selected by the end user
userComment		0..1	string	Free text user comment
outcomeTimestamp		1..1	instant	When the user took action on the card
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
cds-fb-1	error	CDSHooksFeedback.feedback	outcome must be 'accepted' or 'overridden'	outcome = 'accepted' or outcome = 'overridden'
cds-fb-2	error	CDSHooksFeedback.feedback	If outcome is 'accepted', acceptedSuggestions SHALL be provided	(outcome = 'accepted') implies acceptedSuggestions.exists()
cds-fb-3	error	CDSHooksFeedback.feedback.overrideReason	An overrideReason must contain a reason, a userComment, or both	reason.exists() or userComment.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksFeedback		0..*	CDSHooksElement	The request body for the CDS Hooks feedback endpoint Elements defined in Ancestors:extension
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
feedback	C	0..*	CDSHooksElement	Array of Feedback entries JSON: The type of this element is inferred from the JSON type in the instance Constraints: cds-fb-1, cds-fb-2
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
card		1..1	uuid	Identifier of the card the user acted on When this element is read urn:uuid: is prefixed to the value before validation
outcome		1..1	code	accepted | overridden
acceptedSuggestions		0..*	CDSHooksElement	Suggestions accepted by the user
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
id		1..1	uuid	Identifier of the accepted suggestion When this element is read urn:uuid: is prefixed to the value before validation
overrideReason	C	0..1	CDSHooksElement	Reason the user overrode the card Constraints: cds-fb-3
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
reason		0..1	Coding	The override reason selected by the end user
userComment		0..1	string	Free text user comment
outcomeTimestamp		1..1	instant	When the user took action on the card
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
cds-fb-1	error	CDSHooksFeedback.feedback	outcome must be 'accepted' or 'overridden'	outcome = 'accepted' or outcome = 'overridden'
cds-fb-2	error	CDSHooksFeedback.feedback	If outcome is 'accepted', acceptedSuggestions SHALL be provided	(outcome = 'accepted') implies acceptedSuggestions.exists()
cds-fb-3	error	CDSHooksFeedback.feedback.overrideReason	An overrideReason must contain a reason, a userComment, or both	reason.exists() or userComment.exists()

Summary

Mandatory: 0 element(4 nested mandatory elements)

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksFeedback		0..*	CDSHooksElement	The request body for the CDS Hooks feedback endpoint Elements defined in Ancestors:extension
feedback	C	0..*	CDSHooksElement	Array of Feedback entries JSON: The type of this element is inferred from the JSON type in the instance Constraints: cds-fb-1, cds-fb-2
card		1..1	uuid	Identifier of the card the user acted on When this element is read urn:uuid: is prefixed to the value before validation
outcome		1..1	code	accepted | overridden
acceptedSuggestions		0..*	CDSHooksElement	Suggestions accepted by the user
id		1..1	uuid	Identifier of the accepted suggestion When this element is read urn:uuid: is prefixed to the value before validation
overrideReason	C	0..1	CDSHooksElement	Reason the user overrode the card Constraints: cds-fb-3
reason		0..1	Coding	The override reason selected by the end user
userComment		0..1	string	Free text user comment
outcomeTimestamp		1..1	instant	When the user took action on the card
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
cds-fb-1	error	CDSHooksFeedback.feedback	outcome must be 'accepted' or 'overridden'	outcome = 'accepted' or outcome = 'overridden'
cds-fb-2	error	CDSHooksFeedback.feedback	If outcome is 'accepted', acceptedSuggestions SHALL be provided	(outcome = 'accepted') implies acceptedSuggestions.exists()
cds-fb-3	error	CDSHooksFeedback.feedback.overrideReason	An overrideReason must contain a reason, a userComment, or both	reason.exists() or userComment.exists()

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
CDSHooksFeedback		0..*	CDSHooksElement	The request body for the CDS Hooks feedback endpoint Elements defined in Ancestors:extension
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
feedback	C	0..*	CDSHooksElement	Array of Feedback entries JSON: The type of this element is inferred from the JSON type in the instance Constraints: cds-fb-1, cds-fb-2
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
card		1..1	uuid	Identifier of the card the user acted on When this element is read urn:uuid: is prefixed to the value before validation
outcome		1..1	code	accepted | overridden
acceptedSuggestions		0..*	CDSHooksElement	Suggestions accepted by the user
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
id		1..1	uuid	Identifier of the accepted suggestion When this element is read urn:uuid: is prefixed to the value before validation
overrideReason	C	0..1	CDSHooksElement	Reason the user overrode the card Constraints: cds-fb-3
extension		0..1	CDSHooksExtensions	Object that has Named Extension Properties
reason		0..1	Coding	The override reason selected by the end user
userComment		0..1	string	Free text user comment
outcomeTimestamp		1..1	instant	When the user took action on the card
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
cds-fb-1	error	CDSHooksFeedback.feedback	outcome must be 'accepted' or 'overridden'	outcome = 'accepted' or outcome = 'overridden'
cds-fb-2	error	CDSHooksFeedback.feedback	If outcome is 'accepted', acceptedSuggestions SHALL be provided	(outcome = 'accepted') implies acceptedSuggestions.exists()
cds-fb-3	error	CDSHooksFeedback.feedback.overrideReason	An overrideReason must contain a reason, a userComment, or both	reason.exists() or userComment.exists()

Summary

Mandatory: 0 element(4 nested mandatory elements)

Other representations of profile: CSV, Excel