<status value="draft"/> <experimental value="true"/> <date value="2026-06-04T13:13:04+00:00"/> <publisher value="Clinical Decision Support WG"/> <contact> <name value="Clinical Decision Support WG"/> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/dss/index.cfm"/> </telecom> <telecom> <system value="email"/> <value value="cds@lists.HL7.org"/> </telecom> </contact> <description value="This structure is defined to allow the FHIR Validator to validate a CDSHooks Feedback request body."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <fhirVersion value="4.0.1"/> <kind value="logical"/> <abstract value="false"/> <type value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksFeedback"/> <baseDefinition value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/> <derivation value="specialization"/> <snapshot> <extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version"> <valueString value="3.0.0-ballot"/> </extension> <element id="CDSHooksFeedback"> <path value="CDSHooksFeedback"/> <short value="The request body for the CDS Hooks feedback endpoint"/> <definition value="Feedback that a CDS Client POSTs to a CDS Service's feedback endpoint. The request body is an object containing an array of one or more Feedback entries reporting end-user interaction with cards previously returned by the CDS Service."/> <min value="0"/> <max value="*"/> <base> <path value="Base"/> <min value="0"/> <max value="*"/> </base> <isModifier value="false"/> </element> <element id="CDSHooksFeedback.extension"> <path value="CDSHooksFeedback.extension"/> <short value="Object that has Named Extension Properties"/> <definition value="A JSON object that has properties where the names are defined by the extension definitions"/> <comment value="Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined"/> <min value="0"/> <max value="1"/> <base> <path value="CDSHooksElement.extension"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions"/> </type> </element> <element id="CDSHooksFeedback.feedback"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior"> <valueCode value="present"/> </extension> <path value="CDSHooksFeedback.feedback"/> <short value="Array of Feedback entries"/> <definition value="An array of Feedback entries reporting end-user interaction with cards previously returned by the CDS Service."/> <min value="0"/> <max value="*"/> <base> <path value="CDSHooksFeedback.feedback"/> <min value="0"/> <max value="*"/> </base> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/> </type> <constraint> <key value="cds-fb-1"/> <severity value="error"/> <human value="outcome must be 'accepted' or 'overridden'"/> <expression value="outcome = 'accepted' or outcome = 'overridden'"/> <source value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksFeedback"/> </constraint> <constraint> <key value="cds-fb-2"/> <severity value="error"/> <human value="If outcome is 'accepted', acceptedSuggestions SHALL be provided"/> <expression value="(outcome = 'accepted') implies acceptedSuggestions.exists()"/> <source value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksFeedback"/> </constraint> </element> <element id="CDSHooksFeedback.feedback.extension"> <path value="CDSHooksFeedback.feedback.extension"/> <short value="Object that has Named Extension Properties"/> <definition value="A JSON object that has properties where the names are defined by the extension definitions"/> <comment value="Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined"/> <min value="0"/> <max value="1"/> <base> <path value="CDSHooksElement.extension"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions"/> </type> </element> <element id="CDSHooksFeedback.feedback.card"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix"> <valueString value="urn:uuid:"/> </extension> <path value="CDSHooksFeedback.feedback.card"/> <short value="Identifier of the card the user acted on"/> <definition value="The card.uuid from the CDS Hooks response. Uniquely identifies the card."/> <min value="1"/> <max value="1"/> <base> <path value="CDSHooksFeedback.feedback.card"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uuid"/> </type> </element> <element id="CDSHooksFeedback.feedback.outcome"> <path value="CDSHooksFeedback.feedback.outcome"/> <short value="accepted | overridden"/> <definition value="A value of accepted or overridden."/> <min value="1"/> <max value="1"/> <base> <path value="CDSHooksFeedback.feedback.outcome"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> </element> <element id="CDSHooksFeedback.feedback.acceptedSuggestions"> <path value="CDSHooksFeedback.feedback.acceptedSuggestions"/> <short value="Suggestions accepted by the user"/> <definition value="An array of objects identifying one or more of the user's AcceptedSuggestions. Required for 'accepted' outcomes."/> <min value="0"/> <max value="*"/> <base> <path value="CDSHooksFeedback.feedback.acceptedSuggestions"/> <min value="0"/> <max value="*"/> </base> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/> </type> </element> <element id="CDSHooksFeedback.feedback.acceptedSuggestions.extension"> <path value="CDSHooksFeedback.feedback.acceptedSuggestions.extension"/> <short value="Object that has Named Extension Properties"/> <definition value="A JSON object that has properties where the names are defined by the extension definitions"/> <comment value="Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined"/> <min value="0"/> <max value="1"/> <base> <path value="CDSHooksElement.extension"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions"/> </type> </element> <element id="CDSHooksFeedback.feedback.acceptedSuggestions.id"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix"> <valueString value="urn:uuid:"/> </extension> <path value="CDSHooksFeedback.feedback.acceptedSuggestions.id"/> <short value="Identifier of the accepted suggestion"/> <definition value="The card.suggestion.uuid from the CDS Hooks response. Uniquely identifies the suggestion that was accepted."/> <min value="1"/> <max value="1"/> <base> <path value="CDSHooksFeedback.feedback.acceptedSuggestions.id"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uuid"/> </type> </element> <element id="CDSHooksFeedback.feedback.overrideReason"> <path value="CDSHooksFeedback.feedback.overrideReason"/> <short value="Reason the user overrode the card"/> <definition value="Captures the override reason as a Coding as well as any free-text comment entered by the user."/> <min value="0"/> <max value="1"/> <base> <path value="CDSHooksFeedback.feedback.overrideReason"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/> </type> <constraint> <key value="cds-fb-3"/> <severity value="error"/> <human value="An overrideReason must contain a reason, a userComment, or both"/> <expression value="reason.exists() or userComment.exists()"/> <source value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksFeedback"/> </constraint> </element> <element id="CDSHooksFeedback.feedback.overrideReason.extension"> <path value="CDSHooksFeedback.feedback.overrideReason.extension"/> <short value="Object that has Named Extension Properties"/> <definition value="A JSON object that has properties where the names are defined by the extension definitions"/> <comment value="Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined"/> <min value="0"/> <max value="1"/> <base> <path value="CDSHooksElement.extension"/> <min value="0"/> <max value="1"/> </base> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions"/> </type> </element> <element id="CDSHooksFeedback.feedback.overrideReason.reason"> <path value="CDSHooksFeedback.feedback.overrideReason.reason"/> <short value="The override reason selected by the end user"/> <definition value="The Coding object representing the override reason selected by the end user. Required if the user selected an override reason from the list of reasons provided in the Card (instead of only leaving a userComment)."/> <min value="0"/> <max value="1"/> <base> <path value="CDSHooksFeedback.feedback.overrideReason.reason"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> </element> <element id="CDSHooksFeedback.feedback.overrideReason.userComment"> <path value="CDSHooksFeedback.feedback.overrideReason.userComment"/> <short value="Free text user comment"/> <definition value="Free text the clinician provided to further explain why the card was rejected."/> <min value="0"/> <max value="1"/> <base> <path value="CDSHooksFeedback.feedback.overrideReason.userComment"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element id="CDSHooksFeedback.feedback.outcomeTimestamp"> <path value="CDSHooksFeedback.feedback.outcomeTimestamp"/> <short value="When the user took action on the card"/> <definition value="ISO8601 representation of the date and time in Coordinated Universal Time (UTC) when action was taken on the card, as profiled in section 5.6 of RFC3339 (e.g. 1985-04-12T23:20:50.52Z)."/> <min value="1"/> <max value="1"/> <base> <path value="CDSHooksFeedback.feedback.outcomeTimestamp"/> <min value="1"/> <max value="1"/> </base> <type> <code value="instant"/> </type> </element> </snapshot> <differential> <element id="CDSHooksFeedback"> <path value="CDSHooksFeedback"/> <short value="The request body for the CDS Hooks feedback endpoint"/> <definition value="Feedback that a CDS Client POSTs to a CDS Service's feedback endpoint. The request body is an object containing an array of one or more Feedback entries reporting end-user interaction with cards previously returned by the CDS Service."/> </element> <element id="CDSHooksFeedback.feedback"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior"> <valueCode value="present"/> </extension> <path value="CDSHooksFeedback.feedback"/> <short value="Array of Feedback entries"/> <definition value="An array of Feedback entries reporting end-user interaction with cards previously returned by the CDS Service."/> <min value="0"/> <max value="*"/> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/> </type> <constraint> <key value="cds-fb-1"/> <severity value="error"/> <human value="outcome must be 'accepted' or 'overridden'"/> <expression value="outcome = 'accepted' or outcome = 'overridden'"/> <source value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksFeedback"/> </constraint> <constraint> <key value="cds-fb-2"/> <severity value="error"/> <human value="If outcome is 'accepted', acceptedSuggestions SHALL be provided"/> <expression value="(outcome = 'accepted') implies acceptedSuggestions.exists()"/> <source value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksFeedback"/> </constraint> </element> <element id="CDSHooksFeedback.feedback.card"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix"> <valueString value="urn:uuid:"/> </extension> <path value="CDSHooksFeedback.feedback.card"/> <short value="Identifier of the card the user acted on"/> <definition value="The card.uuid from the CDS Hooks response. Uniquely identifies the card."/> <min value="1"/> <max value="1"/> <type> <code value="uuid"/> </type> </element> <element id="CDSHooksFeedback.feedback.outcome"> <path value="CDSHooksFeedback.feedback.outcome"/> <short value="accepted | overridden"/> <definition value="A value of accepted or overridden."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element id="CDSHooksFeedback.feedback.acceptedSuggestions"> <path value="CDSHooksFeedback.feedback.acceptedSuggestions"/> <short value="Suggestions accepted by the user"/> <definition value="An array of objects identifying one or more of the user's AcceptedSuggestions. Required for 'accepted' outcomes."/> <min value="0"/> <max value="*"/> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/> </type> </element> <element id="CDSHooksFeedback.feedback.acceptedSuggestions.id"> <extension url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix"> <valueString value="urn:uuid:"/> </extension> <path value="CDSHooksFeedback.feedback.acceptedSuggestions.id"/> <short value="Identifier of the accepted suggestion"/> <definition value="The card.suggestion.uuid from the CDS Hooks response. Uniquely identifies the suggestion that was accepted."/> <min value="1"/> <max value="1"/> <type> <code value="uuid"/> </type> </element> <element id="CDSHooksFeedback.feedback.overrideReason"> <path value="CDSHooksFeedback.feedback.overrideReason"/> <short value="Reason the user overrode the card"/> <definition value="Captures the override reason as a Coding as well as any free-text comment entered by the user."/> <min value="0"/> <max value="1"/> <type> <code value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/> </type> <constraint> <key value="cds-fb-3"/> <severity value="error"/> <human value="An overrideReason must contain a reason, a userComment, or both"/> <expression value="reason.exists() or userComment.exists()"/> <source value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksFeedback"/> </constraint> </element> <element id="CDSHooksFeedback.feedback.overrideReason.reason"> <path value="CDSHooksFeedback.feedback.overrideReason.reason"/> <short value="The override reason selected by the end user"/> <definition value="The Coding object representing the override reason selected by the end user. Required if the user selected an override reason from the list of reasons provided in the Card (instead of only leaving a userComment)."/> <min value="0"/> <max value="1"/> <type> <code value="Coding"/> </type> </element> <element id="CDSHooksFeedback.feedback.overrideReason.userComment"> <path value="CDSHooksFeedback.feedback.overrideReason.userComment"/> <short value="Free text user comment"/> <definition value="Free text the clinician provided to further explain why the card was rejected."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element id="CDSHooksFeedback.feedback.outcomeTimestamp"> <path value="CDSHooksFeedback.feedback.outcomeTimestamp"/> <short value="When the user took action on the card"/> <definition value="ISO8601 representation of the date and time in Coordinated Universal Time (UTC) when action was taken on the card, as profiled in section 5.6 of RFC3339 (e.g. 1985-04-12T23:20:50.52Z)."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> </element> </differential> </StructureDefinition>

Generated Narrative: StructureDefinition CDSHooksFeedback

Name	Flags	Card.	Type	Description & Constraints
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