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 Response (Logical Definition) - Detailed Descriptions

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

Definitions for the CRDHooksResponse 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()`)
Slicing | This element introduces a set of slices on `CDSHooksResponse.cards`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ $this
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.cards:externalReference
Slice Name | externalReference
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(CRD CDSHooks External Reference Response (Logical Definition))
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()`)
68. CDSHooksResponse.cards:externalReference.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.cards:externalReference.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
72. CDSHooksResponse.cards:externalReference.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
74. CDSHooksResponse.cards:externalReference.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
76. CDSHooksResponse.cards:externalReference.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
78. CDSHooksResponse.cards:externalReference.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
80. CDSHooksResponse.cards:externalReference.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
82. CDSHooksResponse.cards:externalReference.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
84. CDSHooksResponse.cards:externalReference.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
86. CDSHooksResponse.cards:externalReference.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
88. CDSHooksResponse.cards:externalReference.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
90. CDSHooksResponse.cards:externalReference.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())`)
92. CDSHooksResponse.cards:externalReference.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
94. CDSHooksResponse.cards:externalReference.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
96. CDSHooksResponse.cards:externalReference.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
98. CDSHooksResponse.cards:externalReference.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
100. CDSHooksResponse.cards:externalReference.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())`)
102. CDSHooksResponse.cards:externalReference.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
104. CDSHooksResponse.cards:externalReference.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
106. CDSHooksResponse.cards:externalReference.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
108. CDSHooksResponse.cards:externalReference.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
110. CDSHooksResponse.cards:externalReference.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
112. CDSHooksResponse.cards:externalReference.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
114. CDSHooksResponse.cards:externalReference.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())`)
116. CDSHooksResponse.cards:externalReference.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())`)
118. CDSHooksResponse.cards:externalReference.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
120. CDSHooksResponse.cards:externalReference.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
122. CDSHooksResponse.cards:externalReference.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
124. CDSHooksResponse.cards:externalReference.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
126. CDSHooksResponse.cards:externalReference.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
128. CDSHooksResponse.cards:instructions
Slice Name | instructions
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(CRD CDSHooks Instructions Response (Logical Definition))
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()`)
130. CDSHooksResponse.cards:instructions.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
132. CDSHooksResponse.cards:instructions.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
134. CDSHooksResponse.cards:instructions.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
136. CDSHooksResponse.cards:instructions.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
138. CDSHooksResponse.cards:instructions.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
140. CDSHooksResponse.cards:instructions.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
142. CDSHooksResponse.cards:instructions.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
144. CDSHooksResponse.cards:instructions.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
146. CDSHooksResponse.cards:instructions.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
148. CDSHooksResponse.cards:instructions.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
150. CDSHooksResponse.cards:instructions.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
152. CDSHooksResponse.cards:instructions.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())`)
154. CDSHooksResponse.cards:instructions.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
156. CDSHooksResponse.cards:instructions.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
158. CDSHooksResponse.cards:instructions.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
160. CDSHooksResponse.cards:instructions.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
162. CDSHooksResponse.cards:instructions.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())`)
164. CDSHooksResponse.cards:instructions.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
166. CDSHooksResponse.cards:instructions.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
168. CDSHooksResponse.cards:instructions.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
170. CDSHooksResponse.cards:instructions.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
172. CDSHooksResponse.cards:instructions.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
174. CDSHooksResponse.cards:instructions.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
176. CDSHooksResponse.cards:instructions.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())`)
178. CDSHooksResponse.cards:instructions.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())`)
180. CDSHooksResponse.cards:instructions.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
182. CDSHooksResponse.cards:instructions.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
184. CDSHooksResponse.cards:instructions.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
186. CDSHooksResponse.cards:instructions.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
188. CDSHooksResponse.cards:instructions.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
190. CDSHooksResponse.cards:alternateRequest
Slice Name | alternateRequest
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(CRD CDSHooks Alternate Request Response (Logical Definition))
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()`)
192. CDSHooksResponse.cards:alternateRequest.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
194. CDSHooksResponse.cards:alternateRequest.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
196. CDSHooksResponse.cards:alternateRequest.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
198. CDSHooksResponse.cards:alternateRequest.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
200. CDSHooksResponse.cards:alternateRequest.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
202. CDSHooksResponse.cards:alternateRequest.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
204. CDSHooksResponse.cards:alternateRequest.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
206. CDSHooksResponse.cards:alternateRequest.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
208. CDSHooksResponse.cards:alternateRequest.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
210. CDSHooksResponse.cards:alternateRequest.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
212. CDSHooksResponse.cards:alternateRequest.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
214. CDSHooksResponse.cards:alternateRequest.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())`)
216. CDSHooksResponse.cards:alternateRequest.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
218. CDSHooksResponse.cards:alternateRequest.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
220. CDSHooksResponse.cards:alternateRequest.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
222. CDSHooksResponse.cards:alternateRequest.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
224. CDSHooksResponse.cards:alternateRequest.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())`)
226. CDSHooksResponse.cards:alternateRequest.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
228. CDSHooksResponse.cards:alternateRequest.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
230. CDSHooksResponse.cards:alternateRequest.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
232. CDSHooksResponse.cards:alternateRequest.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
234. CDSHooksResponse.cards:alternateRequest.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
236. CDSHooksResponse.cards:alternateRequest.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
238. CDSHooksResponse.cards:alternateRequest.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())`)
240. CDSHooksResponse.cards:alternateRequest.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())`)
242. CDSHooksResponse.cards:alternateRequest.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
244. CDSHooksResponse.cards:alternateRequest.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
246. CDSHooksResponse.cards:alternateRequest.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
248. CDSHooksResponse.cards:alternateRequest.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
250. CDSHooksResponse.cards:alternateRequest.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
252. CDSHooksResponse.cards:additionalOrders
Slice Name | additionalOrders
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(CRD CDSHooks Additional Orders Response (Logical Definition))
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()`)
254. CDSHooksResponse.cards:additionalOrders.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
256. CDSHooksResponse.cards:additionalOrders.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
258. CDSHooksResponse.cards:additionalOrders.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
260. CDSHooksResponse.cards:additionalOrders.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
262. CDSHooksResponse.cards:additionalOrders.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
264. CDSHooksResponse.cards:additionalOrders.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
266. CDSHooksResponse.cards:additionalOrders.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
268. CDSHooksResponse.cards:additionalOrders.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
270. CDSHooksResponse.cards:additionalOrders.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
272. CDSHooksResponse.cards:additionalOrders.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
274. CDSHooksResponse.cards:additionalOrders.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
276. CDSHooksResponse.cards:additionalOrders.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())`)
278. CDSHooksResponse.cards:additionalOrders.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
280. CDSHooksResponse.cards:additionalOrders.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
282. CDSHooksResponse.cards:additionalOrders.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
284. CDSHooksResponse.cards:additionalOrders.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
286. CDSHooksResponse.cards:additionalOrders.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())`)
288. CDSHooksResponse.cards:additionalOrders.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
290. CDSHooksResponse.cards:additionalOrders.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
292. CDSHooksResponse.cards:additionalOrders.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
294. CDSHooksResponse.cards:additionalOrders.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
296. CDSHooksResponse.cards:additionalOrders.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
298. CDSHooksResponse.cards:additionalOrders.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
300. CDSHooksResponse.cards:additionalOrders.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())`)
302. CDSHooksResponse.cards:additionalOrders.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())`)
304. CDSHooksResponse.cards:additionalOrders.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
306. CDSHooksResponse.cards:additionalOrders.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
308. CDSHooksResponse.cards:additionalOrders.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
310. CDSHooksResponse.cards:additionalOrders.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
312. CDSHooksResponse.cards:additionalOrders.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
314. CDSHooksResponse.cards:formCompletion
Slice Name | formCompletion
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(CRD CDSHooks Form Completion Response (Logical Definition))
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()`)
316. CDSHooksResponse.cards:formCompletion.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
318. CDSHooksResponse.cards:formCompletion.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
320. CDSHooksResponse.cards:formCompletion.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
322. CDSHooksResponse.cards:formCompletion.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
324. CDSHooksResponse.cards:formCompletion.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
326. CDSHooksResponse.cards:formCompletion.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
328. CDSHooksResponse.cards:formCompletion.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
330. CDSHooksResponse.cards:formCompletion.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
332. CDSHooksResponse.cards:formCompletion.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
334. CDSHooksResponse.cards:formCompletion.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
336. CDSHooksResponse.cards:formCompletion.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
338. CDSHooksResponse.cards:formCompletion.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())`)
340. CDSHooksResponse.cards:formCompletion.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
342. CDSHooksResponse.cards:formCompletion.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
344. CDSHooksResponse.cards:formCompletion.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
346. CDSHooksResponse.cards:formCompletion.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
348. CDSHooksResponse.cards:formCompletion.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())`)
350. CDSHooksResponse.cards:formCompletion.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
352. CDSHooksResponse.cards:formCompletion.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
354. CDSHooksResponse.cards:formCompletion.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
356. CDSHooksResponse.cards:formCompletion.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
358. CDSHooksResponse.cards:formCompletion.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
360. CDSHooksResponse.cards:formCompletion.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
362. CDSHooksResponse.cards:formCompletion.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())`)
364. CDSHooksResponse.cards:formCompletion.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())`)
366. CDSHooksResponse.cards:formCompletion.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
368. CDSHooksResponse.cards:formCompletion.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
370. CDSHooksResponse.cards:formCompletion.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
372. CDSHooksResponse.cards:formCompletion.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
374. CDSHooksResponse.cards:formCompletion.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
376. CDSHooksResponse.cards:adjustCoverage
Slice Name | adjustCoverage
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(CRD CDSHooks Adjust Coverage Response (Logical Definition))
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()`)
378. CDSHooksResponse.cards:adjustCoverage.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
380. CDSHooksResponse.cards:adjustCoverage.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
382. CDSHooksResponse.cards:adjustCoverage.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
384. CDSHooksResponse.cards:adjustCoverage.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
386. CDSHooksResponse.cards:adjustCoverage.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
388. CDSHooksResponse.cards:adjustCoverage.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
390. CDSHooksResponse.cards:adjustCoverage.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
392. CDSHooksResponse.cards:adjustCoverage.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
394. CDSHooksResponse.cards:adjustCoverage.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
396. CDSHooksResponse.cards:adjustCoverage.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
398. CDSHooksResponse.cards:adjustCoverage.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
400. CDSHooksResponse.cards:adjustCoverage.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())`)
402. CDSHooksResponse.cards:adjustCoverage.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
404. CDSHooksResponse.cards:adjustCoverage.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
406. CDSHooksResponse.cards:adjustCoverage.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
408. CDSHooksResponse.cards:adjustCoverage.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
410. CDSHooksResponse.cards:adjustCoverage.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())`)
412. CDSHooksResponse.cards:adjustCoverage.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
414. CDSHooksResponse.cards:adjustCoverage.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
416. CDSHooksResponse.cards:adjustCoverage.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
418. CDSHooksResponse.cards:adjustCoverage.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
420. CDSHooksResponse.cards:adjustCoverage.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
422. CDSHooksResponse.cards:adjustCoverage.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
424. CDSHooksResponse.cards:adjustCoverage.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())`)
426. CDSHooksResponse.cards:adjustCoverage.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())`)
428. CDSHooksResponse.cards:adjustCoverage.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
430. CDSHooksResponse.cards:adjustCoverage.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
432. CDSHooksResponse.cards:adjustCoverage.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
434. CDSHooksResponse.cards:adjustCoverage.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
436. CDSHooksResponse.cards:adjustCoverage.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
438. CDSHooksResponse.cards:launchSMART
Slice Name | launchSMART
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(CRD CDSHooks SMART App Response (Logical Definition))
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()`)
440. CDSHooksResponse.cards:launchSMART.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
442. CDSHooksResponse.cards:launchSMART.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
444. CDSHooksResponse.cards:launchSMART.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
446. CDSHooksResponse.cards:launchSMART.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
448. CDSHooksResponse.cards:launchSMART.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
450. CDSHooksResponse.cards:launchSMART.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
452. CDSHooksResponse.cards:launchSMART.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
454. CDSHooksResponse.cards:launchSMART.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
456. CDSHooksResponse.cards:launchSMART.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
458. CDSHooksResponse.cards:launchSMART.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
460. CDSHooksResponse.cards:launchSMART.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
462. CDSHooksResponse.cards:launchSMART.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())`)
464. CDSHooksResponse.cards:launchSMART.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
466. CDSHooksResponse.cards:launchSMART.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
468. CDSHooksResponse.cards:launchSMART.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
470. CDSHooksResponse.cards:launchSMART.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
472. CDSHooksResponse.cards:launchSMART.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())`)
474. CDSHooksResponse.cards:launchSMART.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
476. CDSHooksResponse.cards:launchSMART.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
478. CDSHooksResponse.cards:launchSMART.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
480. CDSHooksResponse.cards:launchSMART.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
482. CDSHooksResponse.cards:launchSMART.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
484. CDSHooksResponse.cards:launchSMART.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
486. CDSHooksResponse.cards:launchSMART.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())`)
488. CDSHooksResponse.cards:launchSMART.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())`)
490. CDSHooksResponse.cards:launchSMART.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
492. CDSHooksResponse.cards:launchSMART.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
494. CDSHooksResponse.cards:launchSMART.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
496. CDSHooksResponse.cards:launchSMART.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
498. CDSHooksResponse.cards:launchSMART.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
500. 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)
Slicing | This element introduces a set of slices on `CDSHooksResponse.systemActions`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ $this
502. 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
504. 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
506. 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
508. 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
510. 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
512. CDSHooksResponse.systemActions:coverageInformation
Slice Name | coverageInformation
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(CRD CDSHooks Coverage Information Response (Logical Definition))
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)
514. CDSHooksResponse.systemActions:coverageInformation.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
516. CDSHooksResponse.systemActions:coverageInformation.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
518. CDSHooksResponse.systemActions:coverageInformation.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
520. CDSHooksResponse.systemActions:coverageInformation.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
522. CDSHooksResponse.systemActions:coverageInformation.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
524. CDSHooksResponse.systemActions:formCompletion
Slice Name | formCompletion
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(CRD CDSHooks Form Completion Response (Logical Definition))
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)
526. CDSHooksResponse.systemActions:formCompletion.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
528. CDSHooksResponse.systemActions:formCompletion.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
530. CDSHooksResponse.systemActions:formCompletion.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
532. CDSHooksResponse.systemActions:formCompletion.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
534. CDSHooksResponse.systemActions:formCompletion.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
536. CDSHooksResponse.systemActions:adjustCoverage
Slice Name | adjustCoverage
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(CRD CDSHooks Adjust Coverage Response (Logical Definition))
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)
538. CDSHooksResponse.systemActions:adjustCoverage.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
540. CDSHooksResponse.systemActions:adjustCoverage.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
542. CDSHooksResponse.systemActions:adjustCoverage.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
544. CDSHooksResponse.systemActions:adjustCoverage.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
546. CDSHooksResponse.systemActions:adjustCoverage.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
Slicing | This element introduces a set of slices on `CDSHooksResponse.cards`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ $this
4. CDSHooksResponse.cards:externalReference
Slice Name | externalReference
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks External Reference Response (Logical Definition))
6. CDSHooksResponse.cards:instructions
Slice Name | instructions
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks Instructions Response (Logical Definition))
8. CDSHooksResponse.cards:alternateRequest
Slice Name | alternateRequest
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks Alternate Request Response (Logical Definition))
10. CDSHooksResponse.cards:additionalOrders
Slice Name | additionalOrders
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks Additional Orders Response (Logical Definition))
12. CDSHooksResponse.cards:formCompletion
Slice Name | formCompletion
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks Form Completion Response (Logical Definition))
14. CDSHooksResponse.cards:adjustCoverage
Slice Name | adjustCoverage
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks Adjust Coverage Response (Logical Definition))
16. CDSHooksResponse.cards:launchSMART
Slice Name | launchSMART
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks SMART App Response (Logical Definition))
18. CDSHooksResponse.systemActions
Slicing | This element introduces a set of slices on `CDSHooksResponse.systemActions`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ $this
20. CDSHooksResponse.systemActions:coverageInformation
Slice Name | coverageInformation
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks Coverage Information Response (Logical Definition))
22. CDSHooksResponse.systemActions:formCompletion
Slice Name | formCompletion
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks Form Completion Response (Logical Definition))
24. CDSHooksResponse.systemActions:adjustCoverage
Slice Name | adjustCoverage
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement(CRD CDSHooks Adjust Coverage Response (Logical Definition))

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()`)
Slicing | This element introduces a set of slices on `CDSHooksResponse.cards`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ $this
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.cards:externalReference
Slice Name | externalReference
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(CRD CDSHooks External Reference Response (Logical Definition))
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()`)
68. CDSHooksResponse.cards:externalReference.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.cards:externalReference.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
72. CDSHooksResponse.cards:externalReference.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
74. CDSHooksResponse.cards:externalReference.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
76. CDSHooksResponse.cards:externalReference.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
78. CDSHooksResponse.cards:externalReference.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
80. CDSHooksResponse.cards:externalReference.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
82. CDSHooksResponse.cards:externalReference.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
84. CDSHooksResponse.cards:externalReference.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
86. CDSHooksResponse.cards:externalReference.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
88. CDSHooksResponse.cards:externalReference.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
90. CDSHooksResponse.cards:externalReference.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())`)
92. CDSHooksResponse.cards:externalReference.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
94. CDSHooksResponse.cards:externalReference.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
96. CDSHooksResponse.cards:externalReference.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
98. CDSHooksResponse.cards:externalReference.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
100. CDSHooksResponse.cards:externalReference.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())`)
102. CDSHooksResponse.cards:externalReference.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
104. CDSHooksResponse.cards:externalReference.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
106. CDSHooksResponse.cards:externalReference.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
108. CDSHooksResponse.cards:externalReference.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
110. CDSHooksResponse.cards:externalReference.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
112. CDSHooksResponse.cards:externalReference.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
114. CDSHooksResponse.cards:externalReference.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())`)
116. CDSHooksResponse.cards:externalReference.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())`)
118. CDSHooksResponse.cards:externalReference.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
120. CDSHooksResponse.cards:externalReference.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
122. CDSHooksResponse.cards:externalReference.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
124. CDSHooksResponse.cards:externalReference.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
126. CDSHooksResponse.cards:externalReference.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
128. CDSHooksResponse.cards:instructions
Slice Name | instructions
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(CRD CDSHooks Instructions Response (Logical Definition))
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()`)
130. CDSHooksResponse.cards:instructions.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
132. CDSHooksResponse.cards:instructions.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
134. CDSHooksResponse.cards:instructions.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
136. CDSHooksResponse.cards:instructions.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
138. CDSHooksResponse.cards:instructions.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
140. CDSHooksResponse.cards:instructions.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
142. CDSHooksResponse.cards:instructions.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
144. CDSHooksResponse.cards:instructions.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
146. CDSHooksResponse.cards:instructions.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
148. CDSHooksResponse.cards:instructions.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
150. CDSHooksResponse.cards:instructions.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
152. CDSHooksResponse.cards:instructions.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())`)
154. CDSHooksResponse.cards:instructions.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
156. CDSHooksResponse.cards:instructions.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
158. CDSHooksResponse.cards:instructions.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
160. CDSHooksResponse.cards:instructions.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
162. CDSHooksResponse.cards:instructions.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())`)
164. CDSHooksResponse.cards:instructions.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
166. CDSHooksResponse.cards:instructions.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
168. CDSHooksResponse.cards:instructions.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
170. CDSHooksResponse.cards:instructions.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
172. CDSHooksResponse.cards:instructions.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
174. CDSHooksResponse.cards:instructions.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
176. CDSHooksResponse.cards:instructions.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())`)
178. CDSHooksResponse.cards:instructions.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())`)
180. CDSHooksResponse.cards:instructions.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
182. CDSHooksResponse.cards:instructions.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
184. CDSHooksResponse.cards:instructions.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
186. CDSHooksResponse.cards:instructions.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
188. CDSHooksResponse.cards:instructions.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
190. CDSHooksResponse.cards:alternateRequest
Slice Name | alternateRequest
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(CRD CDSHooks Alternate Request Response (Logical Definition))
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()`)
192. CDSHooksResponse.cards:alternateRequest.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
194. CDSHooksResponse.cards:alternateRequest.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
196. CDSHooksResponse.cards:alternateRequest.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
198. CDSHooksResponse.cards:alternateRequest.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
200. CDSHooksResponse.cards:alternateRequest.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
202. CDSHooksResponse.cards:alternateRequest.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
204. CDSHooksResponse.cards:alternateRequest.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
206. CDSHooksResponse.cards:alternateRequest.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
208. CDSHooksResponse.cards:alternateRequest.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
210. CDSHooksResponse.cards:alternateRequest.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
212. CDSHooksResponse.cards:alternateRequest.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
214. CDSHooksResponse.cards:alternateRequest.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())`)
216. CDSHooksResponse.cards:alternateRequest.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
218. CDSHooksResponse.cards:alternateRequest.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
220. CDSHooksResponse.cards:alternateRequest.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
222. CDSHooksResponse.cards:alternateRequest.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
224. CDSHooksResponse.cards:alternateRequest.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())`)
226. CDSHooksResponse.cards:alternateRequest.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
228. CDSHooksResponse.cards:alternateRequest.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
230. CDSHooksResponse.cards:alternateRequest.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
232. CDSHooksResponse.cards:alternateRequest.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
234. CDSHooksResponse.cards:alternateRequest.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
236. CDSHooksResponse.cards:alternateRequest.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
238. CDSHooksResponse.cards:alternateRequest.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())`)
240. CDSHooksResponse.cards:alternateRequest.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())`)
242. CDSHooksResponse.cards:alternateRequest.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
244. CDSHooksResponse.cards:alternateRequest.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
246. CDSHooksResponse.cards:alternateRequest.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
248. CDSHooksResponse.cards:alternateRequest.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
250. CDSHooksResponse.cards:alternateRequest.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
252. CDSHooksResponse.cards:additionalOrders
Slice Name | additionalOrders
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(CRD CDSHooks Additional Orders Response (Logical Definition))
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()`)
254. CDSHooksResponse.cards:additionalOrders.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
256. CDSHooksResponse.cards:additionalOrders.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
258. CDSHooksResponse.cards:additionalOrders.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
260. CDSHooksResponse.cards:additionalOrders.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
262. CDSHooksResponse.cards:additionalOrders.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
264. CDSHooksResponse.cards:additionalOrders.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
266. CDSHooksResponse.cards:additionalOrders.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
268. CDSHooksResponse.cards:additionalOrders.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
270. CDSHooksResponse.cards:additionalOrders.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
272. CDSHooksResponse.cards:additionalOrders.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
274. CDSHooksResponse.cards:additionalOrders.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
276. CDSHooksResponse.cards:additionalOrders.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())`)
278. CDSHooksResponse.cards:additionalOrders.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
280. CDSHooksResponse.cards:additionalOrders.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
282. CDSHooksResponse.cards:additionalOrders.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
284. CDSHooksResponse.cards:additionalOrders.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
286. CDSHooksResponse.cards:additionalOrders.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())`)
288. CDSHooksResponse.cards:additionalOrders.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
290. CDSHooksResponse.cards:additionalOrders.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
292. CDSHooksResponse.cards:additionalOrders.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
294. CDSHooksResponse.cards:additionalOrders.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
296. CDSHooksResponse.cards:additionalOrders.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
298. CDSHooksResponse.cards:additionalOrders.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
300. CDSHooksResponse.cards:additionalOrders.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())`)
302. CDSHooksResponse.cards:additionalOrders.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())`)
304. CDSHooksResponse.cards:additionalOrders.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
306. CDSHooksResponse.cards:additionalOrders.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
308. CDSHooksResponse.cards:additionalOrders.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
310. CDSHooksResponse.cards:additionalOrders.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
312. CDSHooksResponse.cards:additionalOrders.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
314. CDSHooksResponse.cards:formCompletion
Slice Name | formCompletion
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(CRD CDSHooks Form Completion Response (Logical Definition))
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()`)
316. CDSHooksResponse.cards:formCompletion.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
318. CDSHooksResponse.cards:formCompletion.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
320. CDSHooksResponse.cards:formCompletion.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
322. CDSHooksResponse.cards:formCompletion.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
324. CDSHooksResponse.cards:formCompletion.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
326. CDSHooksResponse.cards:formCompletion.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
328. CDSHooksResponse.cards:formCompletion.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
330. CDSHooksResponse.cards:formCompletion.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
332. CDSHooksResponse.cards:formCompletion.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
334. CDSHooksResponse.cards:formCompletion.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
336. CDSHooksResponse.cards:formCompletion.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
338. CDSHooksResponse.cards:formCompletion.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())`)
340. CDSHooksResponse.cards:formCompletion.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
342. CDSHooksResponse.cards:formCompletion.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
344. CDSHooksResponse.cards:formCompletion.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
346. CDSHooksResponse.cards:formCompletion.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
348. CDSHooksResponse.cards:formCompletion.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())`)
350. CDSHooksResponse.cards:formCompletion.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
352. CDSHooksResponse.cards:formCompletion.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
354. CDSHooksResponse.cards:formCompletion.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
356. CDSHooksResponse.cards:formCompletion.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
358. CDSHooksResponse.cards:formCompletion.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
360. CDSHooksResponse.cards:formCompletion.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
362. CDSHooksResponse.cards:formCompletion.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())`)
364. CDSHooksResponse.cards:formCompletion.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())`)
366. CDSHooksResponse.cards:formCompletion.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
368. CDSHooksResponse.cards:formCompletion.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
370. CDSHooksResponse.cards:formCompletion.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
372. CDSHooksResponse.cards:formCompletion.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
374. CDSHooksResponse.cards:formCompletion.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
376. CDSHooksResponse.cards:adjustCoverage
Slice Name | adjustCoverage
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(CRD CDSHooks Adjust Coverage Response (Logical Definition))
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()`)
378. CDSHooksResponse.cards:adjustCoverage.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
380. CDSHooksResponse.cards:adjustCoverage.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
382. CDSHooksResponse.cards:adjustCoverage.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
384. CDSHooksResponse.cards:adjustCoverage.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
386. CDSHooksResponse.cards:adjustCoverage.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
388. CDSHooksResponse.cards:adjustCoverage.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
390. CDSHooksResponse.cards:adjustCoverage.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
392. CDSHooksResponse.cards:adjustCoverage.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
394. CDSHooksResponse.cards:adjustCoverage.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
396. CDSHooksResponse.cards:adjustCoverage.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
398. CDSHooksResponse.cards:adjustCoverage.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
400. CDSHooksResponse.cards:adjustCoverage.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())`)
402. CDSHooksResponse.cards:adjustCoverage.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
404. CDSHooksResponse.cards:adjustCoverage.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
406. CDSHooksResponse.cards:adjustCoverage.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
408. CDSHooksResponse.cards:adjustCoverage.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
410. CDSHooksResponse.cards:adjustCoverage.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())`)
412. CDSHooksResponse.cards:adjustCoverage.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
414. CDSHooksResponse.cards:adjustCoverage.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
416. CDSHooksResponse.cards:adjustCoverage.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
418. CDSHooksResponse.cards:adjustCoverage.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
420. CDSHooksResponse.cards:adjustCoverage.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
422. CDSHooksResponse.cards:adjustCoverage.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
424. CDSHooksResponse.cards:adjustCoverage.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())`)
426. CDSHooksResponse.cards:adjustCoverage.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())`)
428. CDSHooksResponse.cards:adjustCoverage.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
430. CDSHooksResponse.cards:adjustCoverage.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
432. CDSHooksResponse.cards:adjustCoverage.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
434. CDSHooksResponse.cards:adjustCoverage.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
436. CDSHooksResponse.cards:adjustCoverage.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
438. CDSHooksResponse.cards:launchSMART
Slice Name | launchSMART
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(CRD CDSHooks SMART App Response (Logical Definition))
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()`)
440. CDSHooksResponse.cards:launchSMART.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
442. CDSHooksResponse.cards:launchSMART.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
444. CDSHooksResponse.cards:launchSMART.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
446. CDSHooksResponse.cards:launchSMART.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
448. CDSHooksResponse.cards:launchSMART.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
450. CDSHooksResponse.cards:launchSMART.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
452. CDSHooksResponse.cards:launchSMART.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
454. CDSHooksResponse.cards:launchSMART.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
456. CDSHooksResponse.cards:launchSMART.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
458. CDSHooksResponse.cards:launchSMART.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
460. CDSHooksResponse.cards:launchSMART.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
462. CDSHooksResponse.cards:launchSMART.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())`)
464. CDSHooksResponse.cards:launchSMART.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
466. CDSHooksResponse.cards:launchSMART.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
468. CDSHooksResponse.cards:launchSMART.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
470. CDSHooksResponse.cards:launchSMART.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
472. CDSHooksResponse.cards:launchSMART.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())`)
474. CDSHooksResponse.cards:launchSMART.suggestions.actions.extension
Definition | An Extension
Short | Extension
Control | 0..1
Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions
476. CDSHooksResponse.cards:launchSMART.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
478. CDSHooksResponse.cards:launchSMART.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
480. CDSHooksResponse.cards:launchSMART.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
482. CDSHooksResponse.cards:launchSMART.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
484. CDSHooksResponse.cards:launchSMART.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
486. CDSHooksResponse.cards:launchSMART.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())`)
488. CDSHooksResponse.cards:launchSMART.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())`)
490. CDSHooksResponse.cards:launchSMART.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
492. CDSHooksResponse.cards:launchSMART.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
494. CDSHooksResponse.cards:launchSMART.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
496. CDSHooksResponse.cards:launchSMART.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
498. CDSHooksResponse.cards:launchSMART.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
500. 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)
Slicing | This element introduces a set of slices on `CDSHooksResponse.systemActions`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ $this
502. 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
504. 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
506. 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
508. 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
510. 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
512. CDSHooksResponse.systemActions:coverageInformation
Slice Name | coverageInformation
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(CRD CDSHooks Coverage Information Response (Logical Definition))
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)
514. CDSHooksResponse.systemActions:coverageInformation.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
516. CDSHooksResponse.systemActions:coverageInformation.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
518. CDSHooksResponse.systemActions:coverageInformation.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
520. CDSHooksResponse.systemActions:coverageInformation.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
522. CDSHooksResponse.systemActions:coverageInformation.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
524. CDSHooksResponse.systemActions:formCompletion
Slice Name | formCompletion
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(CRD CDSHooks Form Completion Response (Logical Definition))
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)
526. CDSHooksResponse.systemActions:formCompletion.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
528. CDSHooksResponse.systemActions:formCompletion.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
530. CDSHooksResponse.systemActions:formCompletion.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
532. CDSHooksResponse.systemActions:formCompletion.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
534. CDSHooksResponse.systemActions:formCompletion.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
536. CDSHooksResponse.systemActions:adjustCoverage
Slice Name | adjustCoverage
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(CRD CDSHooks Adjust Coverage Response (Logical Definition))
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)
538. CDSHooksResponse.systemActions:adjustCoverage.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
540. CDSHooksResponse.systemActions:adjustCoverage.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
542. CDSHooksResponse.systemActions:adjustCoverage.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
544. CDSHooksResponse.systemActions:adjustCoverage.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
546. CDSHooksResponse.systemActions:adjustCoverage.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