Da Vinci - Coverage Requirements Discovery
2.2.1 - STU 2.2

Da Vinci - Coverage Requirements Discovery, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-crd/ and changes regularly. See the Directory of published versions

## Logical Model: CRD CDSHooks Instructions Response (Logical Definition) - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 4

Definitions for the CRDHooksResponse-instructions logical model

- Key Elements Table
- Differential Table
- Snapshot Table

Guidance on how to interpret the contents of this table can be foundhere

0. CDSHooksResponse
Definition | The response to the discovery endpoint
Short | The response to the discovery endpoint
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. CDSHooksResponse.extension
Definition | A JSON object that has properties where the names are defined by the extension definitions
Short | Object that has Named Extension Properties
Comments | 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
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
4. CDSHooksResponse.cards
Definition | An array of Cards. Cards can provide a combination of information (for reading), suggested actions (to be applied if a user selects them), and links (to launch an app if the user selects them).
Short | CDS responses to show user
Comments | The CDS Client decides how to display cards, but this specification recommends displaying suggestions using buttons, and links using underlined text.
Control | 1..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Must Support | true
JSON Format | The JSON Array for this property is present even when there are no items in the instance (e.g. as an empty array)
Invariants | cds-resp-1: only one action can be suggested if selectionBehavior = at-most-one (`(selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1`) cds-resp-6: If suggestions are present, selectionBehavior MUST also be provided. (`suggestions.exists() implies selectionBehavior.exists()`)
6. CDSHooksResponse.cards.extension
Definition | A JSON object that has properties where the names are defined by the extension definitions
Short | Object that has Named Extension Properties
Comments | 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
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
8. CDSHooksResponse.cards.uuid
Definition | Unique identifier of the card. MAY be used for auditing and logging cards and SHALL be included in any subsequent calls to the CDS service's feedback endpoint.
Short | Unique identifier of the card (for logging/feedback)
Control | 1..1
Type | uuid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
String Format | When this element is read `urn:uuid:`is prefixed to the value before validation
10. CDSHooksResponse.cards.summary
Definition | One-sentence, <140-character summary message for display to the user inside of this card.
Short | Summary message for display to the user (<140 char)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
12. CDSHooksResponse.cards.detail
Definition | Optional detailed information to display; if provided MUST be represented in (GitHub Flavored) Markdown. (For non-urgent cards, the CDS Client MAY hide these details until the user clicks a link like 'view more details...').
Short | Optional detailed information to display (GitHub Flavored Markdown)
Control | 1..1
Type | markdown
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
14. CDSHooksResponse.cards.indicator
Definition | Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.
Short | info, warning, critical - Urgency/importance of what this card conveys
Comments | The CDS Client MAY use this field to help make UI display decisions such as sort order or coloring.
Control | 0..1
Binding | The codes SHALL be taken from CDSIndicator Codes ValueSet (required to `http://hl7.org/fhir/tools/ValueSet/CDSIndicator` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
16. CDSHooksResponse.cards.source
Definition | The source should be the primary source of guidance for the decision support the card represents.
Short | The primary source of guidance for the content the card represents.
Control | 1..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Must Support | true
18. CDSHooksResponse.cards.source.extension
Definition | A JSON object that has properties where the names are defined by the extension definitions
Short | Object that has Named Extension Properties
Comments | 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
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
20. CDSHooksResponse.cards.source.label
Definition | A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink.
Short | Short, human-readable label to display for the source.
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
22. CDSHooksResponse.cards.source.url
Definition | An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card.
Short | Link for when user clicks for more information about the source
Comments | Note that this URL should not be used to supply a context-specific 'drill-down' view of the information on this card. For that, use card.link.url instead.
Control | 0..1
Type | url
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
24. CDSHooksResponse.cards.source.icon
Definition | An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. The CDS Client may ignore or scale the image during display as appropriate for user experience.
Short | absolute URL to an icon for the source (<100x100 PNG))
Control | 0..1
Type | url
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
26. CDSHooksResponse.cards.source.topic
Definition | A topic describes the content of the card by providing a high-level categorization that can be useful for filtering, searching or ordered display of related cards in the CDS client's UI. This specification does not prescribe a standard set of topics
Short | Describes the content of the card
Comments | This specification does not prescribe a standard set of topics
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from CRD Response Types Value Set (extensible to `http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType` )
Type | Coding
Must Support | true
28. CDSHooksResponse.cards.suggestions
Definition | Allows a service to suggest a set of changes in the context of the current activity (e.g. changing the dose of a medication currently being prescribed, for the order-sign activity).
Short | Suggest a set of changes in the context of the current activity
Control | 0..0 This element is affected by the following invariants: cds-resp-1, cds-resp-6
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Invariants | cds-resp-5: All suggestion actions must have a description (`actions.all(description.exists())`)
40. CDSHooksResponse.cards.selectionBehavior
Definition | Describes the intended selection behavior of the suggestions in the card. Allowed values are: at-most-one, indicating that the user may choose none or at most one of the suggestions; any, indicating that the end user may choose any number of suggestions including none of them and all of them
Short | at-most-one | any
Comments | CDS Clients that do not understand the value MUST treat the card as an error.
Control | 0..1 This element is affected by the following invariants: cds-resp-1, cds-resp-6
Binding | The codes SHALL be taken from CDSSelectionBehavior Codes ValueSet (required to `http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
42. CDSHooksResponse.cards.overrideReasons
Definition | Override reasons can be selected by the end user when overriding a card without taking the suggested recommendations. The CDS service MAY return a list of override reasons to the CDS client.
Short | Feedback from user on card - why not acted on
Comments | The CDS Client SHOULD present these reasons to the clinician when they dismiss a card. A CDS Client MAY augment the override reasons presented to the user with its own reasons
Control | 0..*
Type | Coding
Invariants | cds-resp-4: the CDS Service MUST populate a display value for each reason's Coding (`all(display.exists())`)
44. CDSHooksResponse.cards.links
Definition | Allows a service to suggest a link to an app that the user might want to run for additional information or to help guide a decision.
Short | Link to app or additional information
Control | 0..0
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Invariants | cds-resp-3: AppContext only for smart Apps (`(type != 'smart') implies (appContext.empty())`)
51. CDSHooksResponse.systemActions
Definition | An array of Actions that the CDS Service proposes to auto-apply
Short | Actions to auto-apply
Comments | Each action follows the schema of a card-based suggestion.action. The CDS Client decides whether to auto-apply actions.
Control | 0..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
JSON Format | The JSON Array for this property is not present when there are no items in the instance (e.g. never as an empty array)
53. CDSHooksResponse.systemActions.extension
Definition | A JSON object that has properties where the names are defined by the extension definitions
Short | Object that has Named Extension Properties
Comments | 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
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
55. CDSHooksResponse.systemActions.type
Definition | The type of action being performed. Allowed values are: create, update, delete.
Short | create, update, delete - type of action performed
Control | 1..1
Binding | The codes SHALL be taken from CDSActionType Codes ValueSet (required to `http://hl7.org/fhir/tools/ValueSet/CDSActionType` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
57. CDSHooksResponse.systemActions.description
Definition | Human-readable description of the suggested action that MAY be presented to the end-user.
Short | Human-readable description of the suggested action
Control | 0..1 This element is affected by the following invariants: cds-resp-5
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
59. CDSHooksResponse.systemActions.resource
Definition | When the type attribute is create, the resource attribute SHALL contain a new FHIR resource to be created. For update, this holds the updated resource in its entirety and not just the changed fields.
Short | FHIR resource to create/update
Comments | Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead.
Control | 0..1
Type | Resource
61. CDSHooksResponse.systemActions.resourceId
Definition | A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete.
Short | A relative reference to the relevant resource.
Control | 0..1
Type | url
Primitive Value | This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. CDSHooksResponse
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. CDSHooksResponse.cards
Control | 1..?
Must Support | true
4. CDSHooksResponse.cards.detail
Control | 1..?
Must Support | true
6. CDSHooksResponse.cards.suggestions
Control | 0..0
8. CDSHooksResponse.cards.links
Control | 0..0

Guidance on how to interpret the contents of this table can be foundhere

0. CDSHooksResponse
Definition | The response to the discovery endpoint
Short | The response to the discovery endpoint
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. CDSHooksResponse.extension
Definition | A JSON object that has properties where the names are defined by the extension definitions
Short | Object that has Named Extension Properties
Comments | 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
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
4. CDSHooksResponse.cards
Definition | An array of Cards. Cards can provide a combination of information (for reading), suggested actions (to be applied if a user selects them), and links (to launch an app if the user selects them).
Short | CDS responses to show user
Comments | The CDS Client decides how to display cards, but this specification recommends displaying suggestions using buttons, and links using underlined text.
Control | 1..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Must Support | true
JSON Format | The JSON Array for this property is present even when there are no items in the instance (e.g. as an empty array)
Invariants | cds-resp-1: only one action can be suggested if selectionBehavior = at-most-one (`(selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1`) cds-resp-6: If suggestions are present, selectionBehavior MUST also be provided. (`suggestions.exists() implies selectionBehavior.exists()`)
6. CDSHooksResponse.cards.extension
Definition | A JSON object that has properties where the names are defined by the extension definitions
Short | Object that has Named Extension Properties
Comments | 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
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
8. CDSHooksResponse.cards.uuid
Definition | Unique identifier of the card. MAY be used for auditing and logging cards and SHALL be included in any subsequent calls to the CDS service's feedback endpoint.
Short | Unique identifier of the card (for logging/feedback)
Control | 1..1
Type | uuid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
String Format | When this element is read `urn:uuid:`is prefixed to the value before validation
10. CDSHooksResponse.cards.summary
Definition | One-sentence, <140-character summary message for display to the user inside of this card.
Short | Summary message for display to the user (<140 char)
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
12. CDSHooksResponse.cards.detail
Definition | Optional detailed information to display; if provided MUST be represented in (GitHub Flavored) Markdown. (For non-urgent cards, the CDS Client MAY hide these details until the user clicks a link like 'view more details...').
Short | Optional detailed information to display (GitHub Flavored Markdown)
Control | 1..1
Type | markdown
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
14. CDSHooksResponse.cards.indicator
Definition | Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.
Short | info, warning, critical - Urgency/importance of what this card conveys
Comments | The CDS Client MAY use this field to help make UI display decisions such as sort order or coloring.
Control | 0..1
Binding | The codes SHALL be taken from CDSIndicator Codes ValueSet (required to `http://hl7.org/fhir/tools/ValueSet/CDSIndicator` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
16. CDSHooksResponse.cards.source
Definition | The source should be the primary source of guidance for the decision support the card represents.
Short | The primary source of guidance for the content the card represents.
Control | 1..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Must Support | true
18. CDSHooksResponse.cards.source.extension
Definition | A JSON object that has properties where the names are defined by the extension definitions
Short | Object that has Named Extension Properties
Comments | 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
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
20. CDSHooksResponse.cards.source.label
Definition | A short, human-readable label to display for the source of the information displayed on this card. If a url is also specified, this MAY be the text for the hyperlink.
Short | Short, human-readable label to display for the source.
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
22. CDSHooksResponse.cards.source.url
Definition | An optional absolute URL to load (via GET, in a browser context) when a user clicks on this link to learn more about the organization or data set that provided the information on this card.
Short | Link for when user clicks for more information about the source
Comments | Note that this URL should not be used to supply a context-specific 'drill-down' view of the information on this card. For that, use card.link.url instead.
Control | 0..1
Type | url
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
24. CDSHooksResponse.cards.source.icon
Definition | An absolute URL to an icon for the source of this card. The icon returned by this URL SHOULD be a 100x100 pixel PNG image without any transparent regions. The CDS Client may ignore or scale the image during display as appropriate for user experience.
Short | absolute URL to an icon for the source (<100x100 PNG))
Control | 0..1
Type | url
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
26. CDSHooksResponse.cards.source.topic
Definition | A topic describes the content of the card by providing a high-level categorization that can be useful for filtering, searching or ordered display of related cards in the CDS client's UI. This specification does not prescribe a standard set of topics
Short | Describes the content of the card
Comments | This specification does not prescribe a standard set of topics
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from CRD Response Types Value Set (extensible to `http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType` )
Type | Coding
Must Support | true
28. CDSHooksResponse.cards.suggestions
Definition | Allows a service to suggest a set of changes in the context of the current activity (e.g. changing the dose of a medication currently being prescribed, for the order-sign activity).
Short | Suggest a set of changes in the context of the current activity
Control | 0..0 This element is affected by the following invariants: cds-resp-1, cds-resp-6
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Invariants | cds-resp-5: All suggestion actions must have a description (`actions.all(description.exists())`)
40. CDSHooksResponse.cards.selectionBehavior
Definition | Describes the intended selection behavior of the suggestions in the card. Allowed values are: at-most-one, indicating that the user may choose none or at most one of the suggestions; any, indicating that the end user may choose any number of suggestions including none of them and all of them
Short | at-most-one | any
Comments | CDS Clients that do not understand the value MUST treat the card as an error.
Control | 0..1 This element is affected by the following invariants: cds-resp-1, cds-resp-6
Binding | The codes SHALL be taken from CDSSelectionBehavior Codes ValueSet (required to `http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
42. CDSHooksResponse.cards.overrideReasons
Definition | Override reasons can be selected by the end user when overriding a card without taking the suggested recommendations. The CDS service MAY return a list of override reasons to the CDS client.
Short | Feedback from user on card - why not acted on
Comments | The CDS Client SHOULD present these reasons to the clinician when they dismiss a card. A CDS Client MAY augment the override reasons presented to the user with its own reasons
Control | 0..*
Type | Coding
Invariants | cds-resp-4: the CDS Service MUST populate a display value for each reason's Coding (`all(display.exists())`)
44. CDSHooksResponse.cards.links
Definition | Allows a service to suggest a link to an app that the user might want to run for additional information or to help guide a decision.
Short | Link to app or additional information
Control | 0..0
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Invariants | cds-resp-3: AppContext only for smart Apps (`(type != 'smart') implies (appContext.empty())`)
51. CDSHooksResponse.systemActions
Definition | An array of Actions that the CDS Service proposes to auto-apply
Short | Actions to auto-apply
Comments | Each action follows the schema of a card-based suggestion.action. The CDS Client decides whether to auto-apply actions.
Control | 0..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
JSON Format | The JSON Array for this property is not present when there are no items in the instance (e.g. never as an empty array)
53. CDSHooksResponse.systemActions.extension
Definition | A JSON object that has properties where the names are defined by the extension definitions
Short | Object that has Named Extension Properties
Comments | 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
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
55. CDSHooksResponse.systemActions.type
Definition | The type of action being performed. Allowed values are: create, update, delete.
Short | create, update, delete - type of action performed
Control | 1..1
Binding | The codes SHALL be taken from CDSActionType Codes ValueSet (required to `http://hl7.org/fhir/tools/ValueSet/CDSActionType` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
57. CDSHooksResponse.systemActions.description
Definition | Human-readable description of the suggested action that MAY be presented to the end-user.
Short | Human-readable description of the suggested action
Control | 0..1 This element is affected by the following invariants: cds-resp-5
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
59. CDSHooksResponse.systemActions.resource
Definition | When the type attribute is create, the resource attribute SHALL contain a new FHIR resource to be created. For update, this holds the updated resource in its entirety and not just the changed fields.
Short | FHIR resource to create/update
Comments | Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead.
Control | 0..1
Type | Resource
61. CDSHooksResponse.systemActions.resourceId
Definition | A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete.
Short | A relative reference to the relevant resource.
Control | 0..1
Type | url
Primitive Value | This primitive element may be present, or absent, or replaced by an extension