| Package | hl7.fhir.us.davinci-crd |
| Type | StructureDefinition |
| Id | CRDHooksResponse |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-crd/https://build.fhir.org/ig/HL7/davinci-crd/StructureDefinition-CRDHooksResponse.html |
| URL | http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse |
| Version | 2.2.0-ballot |
| Status | draft |
| Date | 2025-07-22T17:00:27+00:00 |
| Name | CRDHooksResponse |
| Title | CRD CDSHooks Response (Logical Definition) |
| Realm | us |
| Authority | hl7 |
| Description | This defines CRD-specific constraints on the CDS Hooks Response body |
| Type | http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse |
| Kind | logical |
No resources found
| StructureDefinition | |
| CDSHooksElement | CDSHooks Services Base Extensible Element |
| CDSHooksResponse | CDSHooks Response (Logical Definition) |
| CDSHooksElement | CDSHooks Services Base Extensible Element |
| CDSHooksResponse | CDSHooks Response (Logical Definition) |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition CRDHooksResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CDSHooksResponse | 0..* | CDSHooksResponse | Elements defined in Ancestors:extension, cards, systemActions The response to the discovery endpoint | |
  cards | 0..* | CDSHooksElement | An array of Cards that provide information, suggested actions, and links | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "CRDHooksResponse",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/json-suppress-resourcetype",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fm"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd"
}
]
}
}
],
"url": "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.40.18.42.35"
}
],
"version": "2.2.0-ballot",
"name": "CRDHooksResponse",
"title": "CRD CDSHooks Response (Logical Definition)",
"status": "draft",
"experimental": true,
"date": "2025-07-22T17:00:27+00:00",
"publisher": "HL7 International / Financial Management",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm"
}
]
}
],
"description": "This defines CRD-specific constraints on the CDS Hooks Response body",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse",
"baseDefinition": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.7.0"
}
],
"element": [
{
"id": "CDSHooksResponse",
"path": "CDSHooksResponse",
"short": "The response to the discovery endpoint",
"definition": "The response to the discovery endpoint",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CDSHooksResponse.extension",
"path": "CDSHooksResponse.extension",
"short": "Object that has Named Extension Properties",
"definition": "A JSON object that has properties where the names are defined by the extension definitions",
"comment": "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",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksElement.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions"
}
]
},
{
"id": "CDSHooksResponse.cards",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior",
"valueCode": "present"
}
],
"path": "CDSHooksResponse.cards",
"short": "An array of Cards that provide information, suggested actions, and links",
"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).",
"comment": "The CDS Client decides how to display cards, but this specification recommends displaying suggestions using buttons, and links using underlined text.",
"min": 0,
"max": "*",
"base": {
"path": "CDSHooksResponse.cards",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
],
"constraint": [
{
"key": "cds-resp-1",
"severity": "error",
"human": "only one action can be suggested if selectionBehavior = at-most-one",
"expression": "(selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1",
"source": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"
},
{
"key": "cds-resp-6",
"severity": "error",
"human": "If suggestions are present, selectionBehavior MUST also be provided.",
"expression": "suggestions.exists() implies selectionBehavior.exists()",
"source": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id": "CDSHooksResponse.cards.uuid",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix",
"valueString": "urn:uuid:"
}
],
"path": "CDSHooksResponse.cards.uuid",
"short": "Unique identifier of the card (for logging/feedback)",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.uuid",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uuid"
}
]
},
{
"id": "CDSHooksResponse.cards.summary",
"path": "CDSHooksResponse.cards.summary",
"short": "Summary message for display to the user (<140 char)",
"definition": "One-sentence, <140-character summary message for display to the user inside of this card.",
"min": 1,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.summary",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CDSHooksResponse.cards.detail",
"path": "CDSHooksResponse.cards.detail",
"short": "Optional detailed information to display (GitHub Flavored Markdown)",
"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...').",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.detail",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
]
},
{
"id": "CDSHooksResponse.cards.indicator",
"path": "CDSHooksResponse.cards.indicator",
"short": "info, warning, critical - Urgency/importance of what this card conveys",
"definition": "Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.",
"comment": "The CDS Client MAY use this field to help make UI display decisions such as sort order or coloring.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.indicator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/tools/ValueSet/CDSIndicator"
}
},
{
"id": "CDSHooksResponse.cards.source",
"path": "CDSHooksResponse.cards.source",
"short": "The primary source of guidance for the content the card represents.",
"definition": "The source should be the primary source of guidance for the decision support the card represents.",
"min": 1,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.source",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
]
},
{
"id": "CDSHooksResponse.cards.source.label",
"path": "CDSHooksResponse.cards.source.label",
"short": "Short, human-readable label to display for the source.",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.source.label",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CDSHooksResponse.cards.source.url",
"path": "CDSHooksResponse.cards.source.url",
"short": "Link for when user clicks for more information about the source",
"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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.source.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "CDSHooksResponse.cards.source.icon",
"path": "CDSHooksResponse.cards.source.icon",
"short": "absolute URL to an icon for the source (<100x100 PNG))",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.source.icon",
"min": 0,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "CDSHooksResponse.cards.source.topic",
"path": "CDSHooksResponse.cards.source.topic",
"short": "Describes the content of the card - can be useful for filtering, searching or ordered display",
"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",
"comment": "This specification does not prescribe a standard set of topics",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.source.topic",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
]
},
{
"id": "CDSHooksResponse.cards.suggestions",
"path": "CDSHooksResponse.cards.suggestions",
"short": "Suggest a set of changes in the context of the current activity",
"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).",
"min": 0,
"max": "*",
"base": {
"path": "CDSHooksResponse.cards.suggestions",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
],
"condition": [
"cds-resp-1",
"cds-resp-6"
],
"constraint": [
{
"key": "cds-resp-5",
"severity": "error",
"human": "All suggestion actions must have a description",
"expression": "actions.all(description.exists())",
"source": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id": "CDSHooksResponse.cards.suggestions.label",
"path": "CDSHooksResponse.cards.suggestions.label",
"short": "Human-readable label to display for this suggestion",
"definition": "Human-readable label to display for this suggestion",
"comment": "e.g. the CDS Client might render this as the text on a button tied to this suggestion",
"min": 1,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.suggestions.label",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CDSHooksResponse.cards.suggestions.uuid",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix",
"valueString": "urn:uuid:"
}
],
"path": "CDSHooksResponse.cards.suggestions.uuid",
"short": "Unique identifier, used for auditing and logging suggestions",
"definition": "Unique identifier, used for auditing and logging suggestions",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.suggestions.uuid",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uuid"
}
]
},
{
"id": "CDSHooksResponse.cards.suggestions.isRecommended",
"path": "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",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.suggestions.isRecommended",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "CDSHooksResponse.cards.suggestions.actions",
"path": "CDSHooksResponse.cards.suggestions.actions",
"short": "Defines a suggested action (all apply)",
"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",
"comment": "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).",
"min": 0,
"max": "*",
"base": {
"path": "CDSHooksResponse.cards.suggestions.actions",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
],
"constraint": [
{
"key": "cds-resp-2",
"severity": "warning",
"human": "A resourceId not a resource must be provided when type = delete",
"expression": "(type = 'delete') implies (resourceId.exists() and resource.empty())",
"source": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id": "CDSHooksResponse.cards.suggestions.actions.type",
"path": "CDSHooksResponse.cards.suggestions.actions.type",
"short": "create, update, delete - type of action performed",
"definition": "The type of action being performed. Allowed values are: create, update, delete.",
"min": 1,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.suggestions.actions.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/tools/ValueSet/CDSActionType"
}
},
{
"id": "CDSHooksResponse.cards.suggestions.actions.description",
"path": "CDSHooksResponse.cards.suggestions.actions.description",
"short": "Human-readable description of the suggested action (MAY be presented to the end-user)",
"definition": "Human-readable description of the suggested action that MAY be presented to the end-user.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.suggestions.actions.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"cds-resp-5"
]
},
{
"id": "CDSHooksResponse.cards.suggestions.actions.resource",
"path": "CDSHooksResponse.cards.suggestions.actions.resource",
"short": "FHIR resource to create/update",
"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.",
"comment": "Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.suggestions.actions.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
]
},
{
"id": "CDSHooksResponse.cards.suggestions.actions.resourceId",
"path": "CDSHooksResponse.cards.suggestions.actions.resourceId",
"short": "A relative reference to the relevant resource.",
"definition": "A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.suggestions.actions.resourceId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "CDSHooksResponse.cards.selectionBehavior",
"path": "CDSHooksResponse.cards.selectionBehavior",
"short": "at-most-one, any - intended selection behavior of the suggestions in the card",
"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",
"comment": "CDS Clients that do not understand the value MUST treat the card as an error.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.selectionBehavior",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"cds-resp-1",
"cds-resp-6"
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/tools/ValueSet/CDSSelectionBehavior"
}
},
{
"id": "CDSHooksResponse.cards.overrideReasons",
"path": "CDSHooksResponse.cards.overrideReasons",
"short": "Can be selected by the end user when overriding a card without taking the suggested recommendations.",
"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.",
"comment": "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",
"min": 0,
"max": "*",
"base": {
"path": "CDSHooksResponse.cards.overrideReasons",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"constraint": [
{
"key": "cds-resp-4",
"severity": "error",
"human": "the CDS Service MUST populate a display value for each reason's Coding",
"expression": "all(display.exists())",
"source": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id": "CDSHooksResponse.cards.links",
"path": "CDSHooksResponse.cards.links",
"short": "Link to an app that the user might want to run for additional information or to help guide a decision",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "CDSHooksResponse.cards.links",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
],
"constraint": [
{
"key": "cds-resp-3",
"severity": "error",
"human": "AppContext only for smart Apps",
"expression": "(type != 'smart') implies (appContext.empty())",
"source": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id": "CDSHooksResponse.cards.links.label",
"path": "CDSHooksResponse.cards.links.label",
"short": "Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).",
"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).",
"min": 1,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.links.label",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CDSHooksResponse.cards.links.url",
"path": "CDSHooksResponse.cards.links.url",
"short": "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.",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.links.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "CDSHooksResponse.cards.links.type",
"path": "CDSHooksResponse.cards.links.type",
"short": "absolute, smart - how to use the link",
"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",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.links.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/tools/ValueSet/CDSLinkType"
}
},
{
"id": "CDSHooksResponse.cards.links.appContext",
"path": "CDSHooksResponse.cards.links.appContext",
"short": "Allows the CDS Service to share information from the CDS card with a subsequently launched SMART app",
"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.",
"comment": "CDS Client support for appContext requires additional coordination with the authorization server that is not described or specified in CDS Hooks nor SMART.",
"min": 0,
"max": "1",
"base": {
"path": "CDSHooksResponse.cards.links.appContext",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CDSHooksResponse.systemActions",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior",
"valueCode": "absent"
}
],
"path": "CDSHooksResponse.systemActions",
"short": "An array of Actions that the CDS Service proposes to auto-apply",
"definition": "An array of Actions that the CDS Service proposes to auto-apply",
"comment": "Each action follows the schema of a card-based suggestion.action. The CDS Client decides whether to auto-apply actions.",
"min": 0,
"max": "*",
"base": {
"path": "CDSHooksResponse.systemActions",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse#CDSHooksResponse.cards.suggestions.actions"
}
]
},
"differential": {
"element": [
{
"id": "CDSHooksResponse",
"path": "CDSHooksResponse"
},
{
"id": "CDSHooksResponse.cards",
"path": "CDSHooksResponse.cards",
"type": [
{
"code": "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
}
]
}
]
}
}