Da Vinci - Coverage Requirements Discovery
2.2.0-snapshot - STU 2.2 Peer Review

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.0-snapshot 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 Base for Response (Logical Definition) - Detailed Descriptions

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

Definitions for the CRDHooksResponseBase 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 | 0..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
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 | 0..1
Type | markdown
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
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..* 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())`)
30. CDSHooksResponse.cards.suggestions.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
32. CDSHooksResponse.cards.suggestions.label
Definition | Human-readable label to display for this suggestion
Short | Human-readable label to display for this suggestion
Comments | e.g. the CDS Client might render this as the text on a button tied to this suggestion
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
34. CDSHooksResponse.cards.suggestions.uuid
Definition | Unique identifier, used for auditing and logging suggestions
Short | Unique identifier, used for auditing and logging suggestions
Control | 0..1
Type | uuid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
String Format | When this element is read `urn:uuid:`is prefixed to the value before validation
36. CDSHooksResponse.cards.suggestions.isRecommended
Definition | When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card
Short | Which suggestion is most preferred of a set
Comments | CDS Hooks clients may choose to influence their UI based on this value, such as pre-selecting, or highlighting recommended suggestions. Multiple suggestions MAY be recommended, if card.selectionBehavior is any.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
38. CDSHooksResponse.cards.suggestions.actions
Definition | Defines a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within it
Short | Defines a suggested action (all apply)
Comments | When a suggestion contains multiple actions, the actions SHOULD be processed as per FHIR's rules for processing transactions with the CDS Client's fhirServer as the base url for the inferred full URL of the transaction bundle entries. (Specifically, deletes happen first, then creates, then updates).
Control | 0..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Invariants | cds-resp-2: A resourceId not a resource must be provided when type = delete (`(type = 'delete') implies (resourceId.exists() and resource.empty())`)
40. CDSHooksResponse.cards.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
42. CDSHooksResponse.cards.suggestions.actions.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
44. CDSHooksResponse.cards.suggestions.actions.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 | 1..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
Must Support | true
46. CDSHooksResponse.cards.suggestions.actions.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
48. CDSHooksResponse.cards.suggestions.actions.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
50. 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
52. 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())`)
54. 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..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Invariants | cds-resp-3: AppContext only for smart Apps (`(type != 'smart') implies (appContext.empty())`)
56. CDSHooksResponse.cards.links.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
58. CDSHooksResponse.cards.links.label
Definition | Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).
Short | Human-readable label to display for this link
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
60. CDSHooksResponse.cards.links.url
Definition | URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash.
Short | URL to load
Control | 1..1
Type | url
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
62. CDSHooksResponse.cards.links.type
Definition | The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters
Short | absolute | smart
Control | 1..1
Binding | The codes SHALL be taken from CDSLinkType Codes ValueSet (required to `http://hl7.org/fhir/tools/ValueSet/CDSLinkType` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
64. CDSHooksResponse.cards.links.appContext
Definition | An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it.
Short | Information to share when launching SMART app
Comments | CDS Client support for appContext requires additional coordination with the authorization server that is not described or specified in CDS Hooks nor SMART.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
66. 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)
68. 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
70. 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
72. 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
74. 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
76. 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
4. CDSHooksResponse.cards.uuid
Control | 1..?
Must Support | true
6. CDSHooksResponse.cards.summary
Must Support | true
8. CDSHooksResponse.cards.detail
10. CDSHooksResponse.cards.indicator
Must Support | true
12. CDSHooksResponse.cards.source
Must Support | true
14. CDSHooksResponse.cards.source.label
Must Support | true
16. CDSHooksResponse.cards.source.url
18. CDSHooksResponse.cards.source.icon
20. CDSHooksResponse.cards.source.topic
Control | 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` )
Must Support | true
22. CDSHooksResponse.cards.suggestions
24. CDSHooksResponse.cards.suggestions.label
Must Support | true
26. CDSHooksResponse.cards.suggestions.uuid
28. CDSHooksResponse.cards.suggestions.actions
30. CDSHooksResponse.cards.suggestions.actions.extension
32. CDSHooksResponse.cards.suggestions.actions.type
Must Support | true
34. CDSHooksResponse.cards.suggestions.actions.description
Control | 1..?
Must Support | true
36. CDSHooksResponse.cards.suggestions.actions.resource
38. CDSHooksResponse.cards.suggestions.actions.resourceId
40. CDSHooksResponse.cards.links
42. CDSHooksResponse.cards.links.label
Must Support | true
44. CDSHooksResponse.cards.links.url
Must Support | true
46. CDSHooksResponse.cards.links.type
Control | 1..?
Must Support | true
48. CDSHooksResponse.cards.links.appContext
Must Support | true
50. CDSHooksResponse.systemActions
52. CDSHooksResponse.systemActions.type
Must Support | true
54. CDSHooksResponse.systemActions.description
56. CDSHooksResponse.systemActions.resource
58. CDSHooksResponse.systemActions.resourceId

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 | 0..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
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 | 0..1
Type | markdown
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
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..* 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())`)
30. CDSHooksResponse.cards.suggestions.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
32. CDSHooksResponse.cards.suggestions.label
Definition | Human-readable label to display for this suggestion
Short | Human-readable label to display for this suggestion
Comments | e.g. the CDS Client might render this as the text on a button tied to this suggestion
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
34. CDSHooksResponse.cards.suggestions.uuid
Definition | Unique identifier, used for auditing and logging suggestions
Short | Unique identifier, used for auditing and logging suggestions
Control | 0..1
Type | uuid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
String Format | When this element is read `urn:uuid:`is prefixed to the value before validation
36. CDSHooksResponse.cards.suggestions.isRecommended
Definition | When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card
Short | Which suggestion is most preferred of a set
Comments | CDS Hooks clients may choose to influence their UI based on this value, such as pre-selecting, or highlighting recommended suggestions. Multiple suggestions MAY be recommended, if card.selectionBehavior is any.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
38. CDSHooksResponse.cards.suggestions.actions
Definition | Defines a suggested action. Within a suggestion, all actions are logically AND'd together, such that a user selecting a suggestion selects all of the actions within it
Short | Defines a suggested action (all apply)
Comments | When a suggestion contains multiple actions, the actions SHOULD be processed as per FHIR's rules for processing transactions with the CDS Client's fhirServer as the base url for the inferred full URL of the transaction bundle entries. (Specifically, deletes happen first, then creates, then updates).
Control | 0..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Invariants | cds-resp-2: A resourceId not a resource must be provided when type = delete (`(type = 'delete') implies (resourceId.exists() and resource.empty())`)
40. CDSHooksResponse.cards.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
42. CDSHooksResponse.cards.suggestions.actions.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
44. CDSHooksResponse.cards.suggestions.actions.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 | 1..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
Must Support | true
46. CDSHooksResponse.cards.suggestions.actions.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
48. CDSHooksResponse.cards.suggestions.actions.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
50. 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
52. 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())`)
54. 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..*
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement
Invariants | cds-resp-3: AppContext only for smart Apps (`(type != 'smart') implies (appContext.empty())`)
56. CDSHooksResponse.cards.links.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
58. CDSHooksResponse.cards.links.label
Definition | Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).
Short | Human-readable label to display for this link
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
60. CDSHooksResponse.cards.links.url
Definition | URL to load (via GET, in a browser context) when a user clicks on this link. Note that this MAY be a 'deep link' with context embedded in path segments, query parameters, or a hash.
Short | URL to load
Control | 1..1
Type | url
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
62. CDSHooksResponse.cards.links.type
Definition | The type of the given URL. There are two possible values for this field. A type of absolute indicates that the URL is absolute and should be treated as-is. A type of smart indicates that the URL is a SMART app launch URL and the CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters
Short | absolute | smart
Control | 1..1
Binding | The codes SHALL be taken from CDSLinkType Codes ValueSet (required to `http://hl7.org/fhir/tools/ValueSet/CDSLinkType` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
64. CDSHooksResponse.cards.links.appContext
Definition | An optional field that allows the CDS Service to share information from the CDS card with a subsequently launched SMART app. The appContext field should only be valued if the link type is smart and is not valid for absolute links. The appContext field and value will be sent to the SMART app as part of the OAuth 2.0 access token response, alongside the other SMART launch parameters when the SMART app is launched. Note that appContext could be escaped JSON, base64 encoded XML, or even a simple string, so long as the SMART app can recognize it.
Short | Information to share when launching SMART app
Comments | CDS Client support for appContext requires additional coordination with the authorization server that is not described or specified in CDS Hooks nor SMART.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
66. 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)
68. 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
70. 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
72. 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
74. 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
76. 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