FHIR Tooling Extensions IG
0.8.0 - Release 0.2.0 International flag

This page is part of the HL7 Tools Extension IG (v0.8.0: Release - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Official URL: http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse Version: 0.8.0
Standards status: Informative Maturity Level: 1 Computable Name: CDSHooksResponse
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.7

This structure is defined to allow the FHIR Validator to validate a CDSHooks Response body. TODO: This content will be moved to the CDS Hooks specification in the future

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 of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... cards C 0..* 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 0..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 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 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source 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 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 0..1 Coding Describes the content of the card
.... suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
...... type 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.
.... 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 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label 1..1 string Human-readable label to display for this link
..... url 1..1 url URL to load
..... type 0..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
..... appContext 0..1 string Information to share when launching SMART app
... systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS(a valid code from CDSIndicator Codes)
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredCDSActionTypeCodesVS(a valid code from CDSActionType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSActionType
From this IG
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
From this IG
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
From this IG

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3errorCDSHooksResponse.cards.linksAppContext only for smart Apps
: (type != 'smart') implies (appContext.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... cards C 0..* 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
.... uuid 0..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 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 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
..... label 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 0..1 Coding Describes the content of the card
.... suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... label 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... type 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.
.... 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 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
..... label 1..1 string Human-readable label to display for this link
..... url 1..1 url URL to load
..... type 0..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
..... appContext 0..1 string Information to share when launching SMART app
... systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS(a valid code from CDSIndicator Codes)
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredCDSActionTypeCodesVS(a valid code from CDSActionType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSActionType
From this IG
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
From this IG
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
From this IG

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3errorCDSHooksResponse.cards.linksAppContext only for smart Apps
: (type != 'smart') implies (appContext.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... cards C 0..* 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 0..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 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 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source 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 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 0..1 Coding Describes the content of the card
.... suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
...... type 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.
.... 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 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label 1..1 string Human-readable label to display for this link
..... url 1..1 url URL to load
..... type 0..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
..... appContext 0..1 string Information to share when launching SMART app
... systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS(a valid code from CDSIndicator Codes)
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredCDSActionTypeCodesVS(a valid code from CDSActionType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSActionType
From this IG
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
From this IG
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
From this IG

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3errorCDSHooksResponse.cards.linksAppContext only for smart Apps
: (type != 'smart') implies (appContext.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(7 nested mandatory elements)

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... cards C 0..* 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 0..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 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 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source 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 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 0..1 Coding Describes the content of the card
.... suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
...... type 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.
.... 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 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label 1..1 string Human-readable label to display for this link
..... url 1..1 url URL to load
..... type 0..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
..... appContext 0..1 string Information to share when launching SMART app
... systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS(a valid code from CDSIndicator Codes)
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredCDSActionTypeCodesVS(a valid code from CDSActionType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSActionType
From this IG
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
From this IG
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
From this IG

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3errorCDSHooksResponse.cards.linksAppContext only for smart Apps
: (type != 'smart') implies (appContext.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

Differential View

This structure is derived from CDSHooksElement

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... cards C 0..* 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
.... uuid 0..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 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 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source 1..1 CDSHooksElement The primary source of guidance for the content the card represents.
..... label 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 0..1 Coding Describes the content of the card
.... suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... label 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... type 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.
.... 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 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
..... label 1..1 string Human-readable label to display for this link
..... url 1..1 url URL to load
..... type 0..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
..... appContext 0..1 string Information to share when launching SMART app
... systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS(a valid code from CDSIndicator Codes)
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredCDSActionTypeCodesVS(a valid code from CDSActionType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSActionType
From this IG
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
From this IG
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
From this IG

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3errorCDSHooksResponse.cards.linksAppContext only for smart Apps
: (type != 'smart') implies (appContext.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CDSHooksResponse 0..* CDSHooksElement
Elements defined in Ancestors:extension
The response to the discovery endpoint
... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
... cards C 0..* 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 0..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 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 0..1 code info, warning, critical - Urgency/importance of what this card conveys
Binding: CDSIndicator Codes ValueSet (required)
.... source 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 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 0..1 Coding Describes the content of the card
.... suggestions C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity
Constraints: cds-resp-5
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label 1..1 string Human-readable label to display for this suggestion
..... uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions
When this element is read urn:uuid: is prefixed to the value before validation
..... isRecommended 0..1 boolean Which suggestion is most preferred of a set
..... actions C 0..* CDSHooksElement Defines a suggested action (all apply)
Constraints: cds-resp-2
...... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
...... type 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.
.... 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 0..* CDSHooksElement Link to app or additional information
Constraints: cds-resp-3
..... extension 0..1 CDSHooksExtensions Object that has Named Extension Properties
..... label 1..1 string Human-readable label to display for this link
..... url 1..1 url URL to load
..... type 0..1 code absolute | smart
Binding: CDSLinkType Codes ValueSet (required)
..... appContext 0..1 string Information to share when launching SMART app
... systemActions 0..* See actions Actions to auto-apply
JSON: This element may be present as a JSON Array even when there are no items in the instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CDSHooksResponse.cards.indicatorrequiredCDSIndicatorCodesVS(a valid code from CDSIndicator Codes)
http://hl7.org/fhir/tools/ValueSet/CDSIndicator
From this IG
CDSHooksResponse.cards.suggestions.actions.typerequiredCDSActionTypeCodesVS(a valid code from CDSActionType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSActionType
From this IG
CDSHooksResponse.cards.selectionBehaviorrequiredCDSSelectionBehaviorCodesVS(a valid code from CDSSelectionBehavior Codes)
http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior
From this IG
CDSHooksResponse.cards.links.typerequiredCDSLinkTypeCodesVS(a valid code from CDSLinkType Codes)
http://hl7.org/fhir/tools/ValueSet/CDSLinkType
From this IG

Constraints

IdGradePath(s)DetailsRequirements
cds-resp-1errorCDSHooksResponse.cardsonly one action can be suggested if selectionBehavior = at-most-one
: (selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
cds-resp-2warningCDSHooksResponse.cards.suggestions.actionsA resourceId not a resource must be provided when type = delete
: (type = 'delete') implies (resourceId.exists() and resource.empty())
cds-resp-3errorCDSHooksResponse.cards.linksAppContext only for smart Apps
: (type != 'smart') implies (appContext.empty())
cds-resp-4errorCDSHooksResponse.cards.overrideReasonsthe CDS Service MUST populate a display value for each reason's Coding
: all(display.exists())
cds-resp-5errorCDSHooksResponse.cards.suggestionsAll suggestion actions must have a description
: actions.all(description.exists())
cds-resp-6errorCDSHooksResponse.cardsIf suggestions are present, selectionBehavior MUST also be provided.
: suggestions.exists() implies selectionBehavior.exists()

This structure is derived from CDSHooksElement

Summary

Mandatory: 0 element(7 nested mandatory elements)

Maturity: 1

 

Other representations of profile: CSV, Excel