CDS Hooks
3.0.0 - R3 Normative/Trial-Use International flag

CDS Hooks, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0 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

Logical Model: CDSHooks Feedback (Logical Definition)

Official URL: http://cds-hooks.hl7.org/StructureDefinition/CDSHooksFeedback Version: 3.0.0
Standards status: Informative Maturity Level: 1 Computable Name: CDSHooksFeedback
Other Identifiers: OID:2.16.840.1.113883.4.642.40.93.42.4

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 Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksFeedback 0..* CDSHooksElement The request body for the CDS Hooks feedback endpoint

Elements defined in Ancestors:extension
CDSHooksFeedback.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
CDSHooksFeedback.feedback.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
CDSHooksFeedback.feedback.outcome 1..1 code accepted | overridden
CDSHooksFeedback.feedback.acceptedSuggestions 0..* CDSHooksElement Suggestions accepted by the user
CDSHooksFeedback.feedback.acceptedSuggestions.id 1..1 uuid Identifier of the accepted suggestion
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksFeedback.feedback.overrideReason C 0..1 CDSHooksElement Reason the user overrode the card
Constraints: cds-fb-3
CDSHooksFeedback.feedback.overrideReason.reason 0..1 Coding The override reason selected by the end user
CDSHooksFeedback.feedback.overrideReason.userComment 0..1 string Free text user comment
CDSHooksFeedback.feedback.outcomeTimestamp 1..1 instant When the user took action on the card

doco 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()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksFeedback 0..* CDSHooksElement The request body for the CDS Hooks feedback endpoint

Elements defined in Ancestors:extension
CDSHooksFeedback.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksFeedback.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
CDSHooksFeedback.feedback.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksFeedback.feedback.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
CDSHooksFeedback.feedback.outcome 1..1 code accepted | overridden
CDSHooksFeedback.feedback.acceptedSuggestions 0..* CDSHooksElement Suggestions accepted by the user
CDSHooksFeedback.feedback.acceptedSuggestions.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksFeedback.feedback.acceptedSuggestions.id 1..1 uuid Identifier of the accepted suggestion
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksFeedback.feedback.overrideReason C 0..1 CDSHooksElement Reason the user overrode the card
Constraints: cds-fb-3
CDSHooksFeedback.feedback.overrideReason.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksFeedback.feedback.overrideReason.reason 0..1 Coding The override reason selected by the end user
CDSHooksFeedback.feedback.overrideReason.userComment 0..1 string Free text user comment
CDSHooksFeedback.feedback.outcomeTimestamp 1..1 instant When the user took action on the card

doco 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()

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(4 nested mandatory elements)

Maturity: 1

Differential View

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksFeedback 0..* CDSHooksElement The request body for the CDS Hooks feedback endpoint

Elements defined in Ancestors:extension
CDSHooksFeedback.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
CDSHooksFeedback.feedback.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
CDSHooksFeedback.feedback.outcome 1..1 code accepted | overridden
CDSHooksFeedback.feedback.acceptedSuggestions 0..* CDSHooksElement Suggestions accepted by the user
CDSHooksFeedback.feedback.acceptedSuggestions.id 1..1 uuid Identifier of the accepted suggestion
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksFeedback.feedback.overrideReason C 0..1 CDSHooksElement Reason the user overrode the card
Constraints: cds-fb-3
CDSHooksFeedback.feedback.overrideReason.reason 0..1 Coding The override reason selected by the end user
CDSHooksFeedback.feedback.overrideReason.userComment 0..1 string Free text user comment
CDSHooksFeedback.feedback.outcomeTimestamp 1..1 instant When the user took action on the card

doco 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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
CDSHooksFeedback 0..* CDSHooksElement The request body for the CDS Hooks feedback endpoint

Elements defined in Ancestors:extension
CDSHooksFeedback.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksFeedback.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
CDSHooksFeedback.feedback.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksFeedback.feedback.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
CDSHooksFeedback.feedback.outcome 1..1 code accepted | overridden
CDSHooksFeedback.feedback.acceptedSuggestions 0..* CDSHooksElement Suggestions accepted by the user
CDSHooksFeedback.feedback.acceptedSuggestions.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksFeedback.feedback.acceptedSuggestions.id 1..1 uuid Identifier of the accepted suggestion
When this element is read urn:uuid: is prefixed to the value before validation
CDSHooksFeedback.feedback.overrideReason C 0..1 CDSHooksElement Reason the user overrode the card
Constraints: cds-fb-3
CDSHooksFeedback.feedback.overrideReason.extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
CDSHooksFeedback.feedback.overrideReason.reason 0..1 Coding The override reason selected by the end user
CDSHooksFeedback.feedback.overrideReason.userComment 0..1 string Free text user comment
CDSHooksFeedback.feedback.outcomeTimestamp 1..1 instant When the user took action on the card

doco 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()

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(4 nested mandatory elements)

Maturity: 1

 

Other representations of profile: CSV, Excel