Spanish Generated Narrative: StructureDefinition CDSHooksResponse Language: en Name Flags Card. Type Description & Constraints CDSHooksResponse 0..* CDSHooksElement The response to the discovery endpoint Elements defined in Ancestors:extension #xD; cards <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cds-resp-1, cds-resp-6 )">C 0..* CDSHooksElement CDS responses to show user JSON: The type of this element is inferred from the JSON type in the instance Constraints: cds-resp-1, cds-resp-6 #xD; uuid 0..1 uuid Unique identifier of the card (for logging/feedback) When this element is read urn:uuid: is prefixed to the value before validation #xD; <a href="StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.summary" title="One-sentence, <140-character summary message for display to the user inside of this card.">summary 1..1 string Summary message for display to the user (<140 char) #xD; detail 0..1 markdown Optional detailed information to display (GitHub Flavored Markdown) #xD; indicator 0..1 code info, warning, critical - Urgency/importance of what this card conveys Binding: CDSIndicator Codes ValueSet (required) #xD; source 1..1 CDSHooksElement The primary source of guidance for the content the card represents. #xD; label 1..1 string Short, human-readable label to display for the source. #xD; url 0..1 url Link for when user clicks for more information about the source #xD; icon 0..1 url absolute URL to an icon for the source (<100x100 PNG)) #xD; topic 0..1 Coding Describes the content of the card #xD; suggestions <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cds-resp-5, cds-resp-1, cds-resp-6 )">C 0..* CDSHooksElement Suggest a set of changes in the context of the current activity Constraints: cds-resp-5 #xD; label 1..1 string Human-readable label to display for this suggestion #xD; uuid 0..1 uuid Unique identifier, used for auditing and logging suggestions When this element is read urn:uuid: is prefixed to the value before validation #xD; isRecommended 0..1 boolean Which suggestion is most preferred of a set #xD; actions C 0..* CDSHooksElement Defines a suggested action (all apply) Constraints: cds-resp-2 #xD; type 1..1 code create, update, delete - type of action performed Binding: CDSActionType Codes ValueSet (required) #xD; description C 0..1 string Human-readable description of the suggested action #xD; resource 0..1 Resource FHIR resource to create/update #xD; resourceId 0..1 url A relative reference to the relevant resource. #xD; <a href="StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.selectionBehavior" title="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">selectionBehavior <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( cds-resp-1, cds-resp-6 )">C 0..1 code at-most-one | any Binding: CDSSelectionBehavior Codes ValueSet (required) #xD; overrideReasons C 0..* Coding Feedback from user on card - why not acted on Constraints: cds-resp-4 #xD; links C 0..* CDSHooksElement Link to app or additional information Constraints: cds-resp-3 #xD; label 1..1 string Human-readable label to display for this link #xD; url 1..1 url URL to load #xD; <a href="StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.links.type" title="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">type 0..1 code absolute | smart Binding: CDSLinkType Codes ValueSet (required) #xD; <a href="StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.links.appContext" title="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.">appContext 0..1 string Information to share when launching SMART app #xD; systemActions 0..* See actions Actions to auto-apply JSON: This element may be present as a JSON Array even when there are no items in the instance #xD; Documentation for this format
This structure is defined to allow the FHIR Validator to validate a CDSHooks Response body. TODO: This content will be moved to the CDS Hooks specification in the future
Object that has Named Extension Properties
A JSON object that has properties where the names are defined by the extension definitions
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
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).
The CDS Client decides how to display cards, but this specification recommends displaying suggestions using buttons, and links using underlined text.
only one action can be suggested if selectionBehavior = at-most-one
(selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1
If suggestions are present, selectionBehavior MUST also be provided.
suggestions.exists() implies selectionBehavior.exists()
Unique identifier of the card (for logging/feedback)
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.
Summary message for display to the user (<140 char)
One-sentence, <140-character summary message for display to the user inside of this card.
Optional detailed information to display (GitHub Flavored Markdown)
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...').
info, warning, critical - Urgency/importance of what this card conveys
Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.
The CDS Client MAY use this field to help make UI display decisions such as sort order or coloring.
The primary source of guidance for the content the card represents.
The source should be the primary source of guidance for the decision support the card represents.
Short, human-readable label to display for the source.
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.
Link for when user clicks for more information about the source
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.
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.
absolute URL to an icon for the source (<100x100 PNG))
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.
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
This specification does not prescribe a standard set of topics
Suggest a set of changes in the context of the current activity
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).
All suggestion actions must have a description
Human-readable label to display for this suggestion
e.g. the CDS Client might render this as the text on a button tied to this suggestion
Unique identifier, used for auditing and logging suggestions
Which suggestion is most preferred of a set
When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card
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.
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
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).
A resourceId not a resource must be provided when type = delete
(type = 'delete') implies (resourceId.exists() and resource.empty())
create, update, delete - type of action performed
The type of action being performed. Allowed values are: create, update, delete.
Human-readable description of the suggested action
Human-readable description of the suggested action that MAY be presented to the end-user.
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.
Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead.
A relative reference to the relevant resource.
A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete.
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
CDS Clients that do not understand the value MUST treat the card as an error.
Feedback from user on card - why not acted on
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.
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
the CDS Service MUST populate a display value for each reason's Coding
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.
(type != 'smart') implies (appContext.empty())
Human-readable label to display for this link
Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).
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.
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
Information to share when launching SMART app
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.
CDS Client support for appContext requires additional coordination with the authorization server that is not described or specified in CDS Hooks nor SMART.
An array of Actions that the CDS Service proposes to auto-apply
Each action follows the schema of a card-based suggestion.action. The CDS Client decides whether to auto-apply actions.