CDS Hooks
3.0.0 - R3 Normative/Trial-Use
CDS Hooks
3.0.0 - R3 Normative/Trial-Use
CDS Hooks, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cds-hooks/ and changes regularly. See the Directory of published versions
| Page standards status: Informative | Maturity Level: 1 |
JSON representation of the CDSHooksResponse logical model.
{
"resourceType" : "StructureDefinition",
"id" : "CDSHooksResponse",
"language" : "en",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition CDSHooksResponse</b></p><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"xhtTableBorder0\"><tr class=\"xhtRowBorder1\"><th scope=\"col\" style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th scope=\"col\" style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th scope=\"col\" style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th scope=\"col\" style=\"; width: 100px\" class=\"hierarchy xhtCellBorder0\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th scope=\"col\" style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse\" title=\"The response to a CDS service request\">CDSHooksResponse</a><a name=\"CDSHooksResponse\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\"><span class=\"xhtPieceDeEmphasized\">0</span><span class=\"xhtPieceDeEmphasized\">..</span><span class=\"xhtPieceDeEmphasized\">*</span></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">The response to a CDS service request<br/><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-CDSHooksElement.html\" title=\"A JSON object that has properties where the names are defined by the extension definitions\">extension</a></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck11.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards\" title=\"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).\">cards</a><a name=\"CDSHooksResponse.cards\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-resp-1, cds-resp-6 )\" class=\"xhtConstraintStyle\">C</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><span title=\"This element is present as a JSON Array even when there are no items in the instance\">0</span><span title=\"This element is present as a JSON Array even when there are no items in the instance\">..</span><span title=\"This element is present as a JSON Array even when there are no items in the instance\">*</span></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">CDS responses to show user<br/>JSON: The type of this element is inferred from the JSON type in the instance<br class=\"constraint\"/><span class=\"constraint\">Constraints: </span><span title=\"only one action can be suggested if selectionBehavior = at-most-one\" class=\"xhtPieceBold constraint\">cds-resp-1</span><span class=\"constraint\">, </span><span title=\"If suggestions are present, selectionBehavior MUST also be provided.\" class=\"xhtPieceBold constraint\">cds-resp-6</span><br/></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.uuid\" title=\"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.\">uuid</a><a name=\"CDSHooksResponse.cards.uuid\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#uuid\">uuid</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Unique identifier of the card (for logging/feedback)<br/>When this element is read <code>urn:uuid:</code> is prefixed to the value before validation</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><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</a><a name=\"CDSHooksResponse.cards.summary\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Summary message for display to the user (<140 char)</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.detail\" title=\"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...').\">detail</a><a name=\"CDSHooksResponse.cards.detail\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#markdown\">markdown</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Optional detailed information to display (GitHub Flavored Markdown)</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.indicator\" title=\"Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical.\">indicator</a><a name=\"CDSHooksResponse.cards.indicator\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">info, warning, critical - Urgency/importance of what this card conveys<br class=\"binding\"/><span class=\"xhtPieceBold binding\">Binding: </span><a href=\"ValueSet-CDSIndicator.html\" title=\"http://cds-hooks.hl7.org/ValueSet/CDSIndicator\" class=\"binding\">CDSIndicator Codes ValueSet</a><span class=\"binding\"> (</span><a href=\"http://hl7.org/fhir/R4/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\" class=\"binding\">required</a><span class=\"binding\">)</span></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck111.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.source\" title=\"The source should be the primary source of guidance for the decision support the card represents.\">source</a><a name=\"CDSHooksResponse.cards.source\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">The primary source of guidance for the content the card represents.</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck1110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.source.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.source.label\" title=\"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.\">label</a><a name=\"CDSHooksResponse.cards.source.label\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Short, human-readable label to display for the source.</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.source.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.source.url\" title=\"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.\">url</a><a name=\"CDSHooksResponse.cards.source.url\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#url\">url</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Link for when user clicks for more information about the source</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck1110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.source.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.source.icon\" title=\"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.\">icon</a><a name=\"CDSHooksResponse.cards.source.icon\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#url\">url</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">absolute URL to an icon for the source (<100x100 PNG))</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1100.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.source.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.source.topic\" title=\"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\">topic</a><a name=\"CDSHooksResponse.cards.source.topic\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Describes the content of the card</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck111.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions\" title=\"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).\">suggestions</a><a name=\"CDSHooksResponse.cards.suggestions\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-resp-5, cds-resp-7, cds-resp-1, cds-resp-6 )\" class=\"xhtConstraintStyle\">C</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..*</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Suggest a set of changes in the context of the current activity<br class=\"constraint\"/><span class=\"constraint\">Constraints: </span><span title=\"All suggestion actions must have a description\" class=\"xhtPieceBold constraint\">cds-resp-5</span><span class=\"constraint\">, </span><span title=\"actionSelectionBehavior must be 'all', 'any', or 'at-most-one'\" class=\"xhtPieceBold constraint\">cds-resp-7</span><br/></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.label\" title=\"Human-readable label to display for this suggestion\">label</a><a name=\"CDSHooksResponse.cards.suggestions.label\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Human-readable label to display for this suggestion</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck1110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.uuid\" title=\"Unique identifier, used for auditing and logging suggestions\">uuid</a><a name=\"CDSHooksResponse.cards.suggestions.uuid\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#uuid\">uuid</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Unique identifier, used for auditing and logging suggestions<br/>When this element is read <code>urn:uuid:</code> is prefixed to the value before validation</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.isRecommended\" title=\"When there are multiple suggestions, allows a service to indicate that a specific suggestion is recommended from all the available suggestions on the card\">isRecommended</a><a name=\"CDSHooksResponse.cards.suggestions.isRecommended\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Which suggestion is most preferred of a set</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck1111.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.actions\" title=\"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\">actions</a><a name=\"CDSHooksResponse.cards.suggestions.actions\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-resp-2 )\" class=\"xhtConstraintStyle\">C</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..*</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Defines a suggested action (all apply)<br class=\"constraint\"/><span class=\"constraint\">Constraints: </span><span title=\"A resourceId not a resource must be provided when type = delete\" class=\"xhtPieceBold constraint\">cds-resp-2</span><br/></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck11110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.actions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.actions.type\" title=\"The type of action being performed. Allowed values are: create, update, delete.\">type</a><a name=\"CDSHooksResponse.cards.suggestions.actions.type\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">create, update, delete - type of action performed<br class=\"binding\"/><span class=\"xhtPieceBold binding\">Binding: </span><a href=\"ValueSet-CDSActionType.html\" title=\"http://cds-hooks.hl7.org/ValueSet/CDSActionType\" class=\"binding\">CDSActionType Codes ValueSet</a><span class=\"binding\"> (</span><a href=\"http://hl7.org/fhir/R4/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\" class=\"binding\">required</a><span class=\"binding\">)</span></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck11110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.actions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.actions.description\" title=\"Human-readable description of the suggested action that may be presented to the end-user.\">description</a><a name=\"CDSHooksResponse.cards.suggestions.actions.description\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-resp-5 )\" class=\"xhtConstraintStyle\">C</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Human-readable description of the suggested action</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck11110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.actions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.actions.resource\" title=\"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.\">resource</a><a name=\"CDSHooksResponse.cards.suggestions.actions.resource\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Resource</td><td style=\"\" class=\"hierarchy xhtCellBorder0\">FHIR resource to create/update</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck11100.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.actions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.actions.resourceId\" title=\"A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete.\">resourceId</a><a name=\"CDSHooksResponse.cards.suggestions.actions.resourceId\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">A relative reference to the relevant resource.</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1100.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.suggestions.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.suggestions.actionSelectionBehavior\" title=\"Indicates whether the end user may select any, none, or only a single action from those included in the suggestion. Allowed values are: all, indicating that a user selecting a suggestion is selecting all of the actions within it; any, indicating that the end user may choose any number of actions including none of them or all of them; at-most-one, indicating that the user may choose none or at most one of the actions. If not provided, the default is all. Note: this is an STU element.\">actionSelectionBehavior</a><a name=\"CDSHooksResponse.cards.suggestions.actionSelectionBehavior\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">all | any | at-most-one (default: all)</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><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><a name=\"CDSHooksResponse.cards.selectionBehavior\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-resp-1, cds-resp-6 )\" class=\"xhtConstraintStyle\">C</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">at-most-one | any<br class=\"binding\"/><span class=\"xhtPieceBold binding\">Binding: </span><a href=\"ValueSet-CDSSelectionBehavior.html\" title=\"http://cds-hooks.hl7.org/ValueSet/CDSSelectionBehavior\" class=\"binding\">CDSSelectionBehavior Codes ValueSet</a><span class=\"binding\"> (</span><a href=\"http://hl7.org/fhir/R4/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\" class=\"binding\">required</a><span class=\"binding\">)</span></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck110.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.overrideReasons\" title=\"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.\">overrideReasons</a><a name=\"CDSHooksResponse.cards.overrideReasons\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-resp-4 )\" class=\"xhtConstraintStyle\">C</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..*</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Feedback from user on card - why not acted on<br class=\"constraint\"/><span class=\"constraint\">Constraints: </span><span title=\"the CDS Service MUST populate a display value for each reason's Coding\" class=\"xhtPieceBold constraint\">cds-resp-4</span><br/></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck101.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.links\" title=\"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.\">links</a><a name=\"CDSHooksResponse.cards.links\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( cds-resp-3 )\" class=\"xhtConstraintStyle\">C</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..*</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"StructureDefinition-CDSHooksElement.html\">CDSHooksElement</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Link to app or additional information<br class=\"constraint\"/><span class=\"constraint\">Constraints: </span><span title=\"AppContext only for smart Apps\" class=\"xhtPieceBold constraint\">cds-resp-3</span><br/></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1010.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.links.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.links.label\" title=\"Human-readable label to display for this link (e.g. the CDS Client might render this as the underlined text of a clickable link).\">label</a><a name=\"CDSHooksResponse.cards.links.label\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Human-readable label to display for this link</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck1010.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.links.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.links.url\" title=\"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.\">url</a><a name=\"CDSHooksResponse.cards.links.url\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#url\">url</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">URL to load</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1010.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.links.</span><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</a><a name=\"CDSHooksResponse.cards.links.type\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">1..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">absolute | smart<br class=\"binding\"/><span class=\"xhtPieceBold binding\">Binding: </span><a href=\"ValueSet-CDSLinkType.html\" title=\"http://cds-hooks.hl7.org/ValueSet/CDSLinkType\" class=\"binding\">CDSLinkType Codes ValueSet</a><span class=\"binding\"> (</span><a href=\"http://hl7.org/fhir/R4/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\" class=\"binding\">required</a><span class=\"binding\">)</span></td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck1010.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.links.</span><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</a><a name=\"CDSHooksResponse.cards.links.appContext\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Information to share when launching SMART app</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowEven\"><td style=\"background-image: url(tbl_bck1000.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\"\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.cards.links.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.cards.links.autolaunchable\" title=\"This field serves as a hint to the CDS Client suggesting this link be immediately launched, without displaying the card and without manual user interaction. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.\">autolaunchable</a><a name=\"CDSHooksResponse.cards.links.autolaunchable\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\">0..1</td><td style=\"\" class=\"hierarchy xhtCellBorder0\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">This field serves as a hint to the CDS Client suggesting this link be immediately launched, without displaying the card and without manual user interaction. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.</td></tr>\r\n<tr class=\"xhtRowBorder0 xhtRowOdd\"><td style=\"background-image: url(tbl_bck00.png)\" class=\"hierarchy xhtCellBorder0 xhtCellNoWrap\"><img src=\"tbl_spacer.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\"\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\"\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <span style=\"position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0\" class=\"sr-only\">CDSHooksResponse.</span><a href=\"StructureDefinition-CDSHooksResponse-definitions.html#CDSHooksResponse.systemActions\" title=\"An array of Actions that the CDS Service proposes to auto-apply\">systemActions</a><a name=\"CDSHooksResponse.systemActions\"> </a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\"/><td style=\"\" class=\"hierarchy xhtCellBorder0\"><span title=\"This element may be present as a JSON Array even when there are no items in the instance\">0</span><span title=\"This element may be present as a JSON Array even when there are no items in the instance\">..</span><span title=\"This element may be present as a JSON Array even when there are no items in the instance\">*</span></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">See <a href=\"#CDSHooksResponse.cards.suggestions.actions\" title=\"CDSHooksResponse.cards.suggestions.actions\">actions</a></td><td style=\"\" class=\"hierarchy xhtCellBorder0\">Actions to auto-apply<br/>JSON: This element may be present as a JSON Array even when there are no items in the instance<br/></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 1
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "informative"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-suppress-resourcetype",
"valueBoolean" : true
}
],
"url" : "http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse",
"identifier" : [
{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.40.93.42.6"
}
],
"version" : "3.0.0",
"name" : "CDSHooksResponse",
"title" : "CDSHooks Response (Logical Definition)",
"status" : "active",
"experimental" : false,
"date" : "2026-10-22T15:56:14+00:00",
"publisher" : "HL7 International / Clinical Decision Support",
"contact" : [
{
"name" : "HL7 International / Clinical Decision Support",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
},
{
"system" : "email",
"value" : "cds@lists.HL7.org"
}
]
}
],
"description" : "This structure is defined to allow the FHIR Validator to validate a CDSHooks Response body.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"fhirVersion" : "4.0.1",
"kind" : "logical",
"abstract" : false,
"type" : "http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse",
"baseDefinition" : "http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "3.0.0"
}
],
"element" : [
{
"id" : "CDSHooksResponse",
"path" : "CDSHooksResponse",
"short" : "The response to a CDS service request",
"definition" : "The response to a CDS service request",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"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://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"
}
]
},
{
"id" : "CDSHooksResponse.cards",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior",
"valueCode" : "present"
}
],
"path" : "CDSHooksResponse.cards",
"short" : "CDS responses to show user",
"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://cds-hooks.hl7.org/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://cds-hooks.hl7.org/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://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id" : "CDSHooksResponse.cards.extension",
"path" : "CDSHooksResponse.cards.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://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"
}
]
},
{
"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" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksResponse.cards.indicator",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cds-hooks.hl7.org/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://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"
}
]
},
{
"id" : "CDSHooksResponse.cards.source.extension",
"path" : "CDSHooksResponse.cards.source.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://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"
}
]
},
{
"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",
"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://cds-hooks.hl7.org/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://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
},
{
"key" : "cds-resp-7",
"severity" : "error",
"human" : "actionSelectionBehavior must be 'all', 'any', or 'at-most-one'",
"expression" : "actionSelectionBehavior.empty() or actionSelectionBehavior = 'all' or actionSelectionBehavior = 'any' or actionSelectionBehavior = 'at-most-one'",
"source" : "http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id" : "CDSHooksResponse.cards.suggestions.extension",
"path" : "CDSHooksResponse.cards.suggestions.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://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"
}
]
},
{
"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",
"short" : "Which suggestion is most preferred of a set",
"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://cds-hooks.hl7.org/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://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id" : "CDSHooksResponse.cards.suggestions.actions.extension",
"path" : "CDSHooksResponse.cards.suggestions.actions.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://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"
}
]
},
{
"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://cds-hooks.hl7.org/ValueSet/CDSActionType"
}
},
{
"id" : "CDSHooksResponse.cards.suggestions.actions.description",
"path" : "CDSHooksResponse.cards.suggestions.actions.description",
"short" : "Human-readable description of the suggested action",
"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" : "string"
}
]
},
{
"id" : "CDSHooksResponse.cards.suggestions.actionSelectionBehavior",
"path" : "CDSHooksResponse.cards.suggestions.actionSelectionBehavior",
"short" : "all | any | at-most-one (default: all)",
"definition" : "Indicates whether the end user may select any, none, or only a single action from those included in the suggestion. Allowed values are: all, indicating that a user selecting a suggestion is selecting all of the actions within it; any, indicating that the end user may choose any number of actions including none of them or all of them; at-most-one, indicating that the user may choose none or at most one of the actions. If not provided, the default is all. Note: this is an STU element.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CDSHooksResponse.cards.suggestions.actionSelectionBehavior",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "all"
},
{
"id" : "CDSHooksResponse.cards.selectionBehavior",
"path" : "CDSHooksResponse.cards.selectionBehavior",
"short" : "at-most-one | any",
"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://cds-hooks.hl7.org/ValueSet/CDSSelectionBehavior"
}
},
{
"id" : "CDSHooksResponse.cards.overrideReasons",
"path" : "CDSHooksResponse.cards.overrideReasons",
"short" : "Feedback from user on card - why not acted on",
"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://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id" : "CDSHooksResponse.cards.links",
"path" : "CDSHooksResponse.cards.links",
"short" : "Link to app or additional information",
"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://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"
}
],
"constraint" : [
{
"key" : "cds-resp-3",
"severity" : "error",
"human" : "AppContext only for smart Apps",
"expression" : "(type != 'smart') implies (appContext.empty())",
"source" : "http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id" : "CDSHooksResponse.cards.links.extension",
"path" : "CDSHooksResponse.cards.links.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://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"
}
]
},
{
"id" : "CDSHooksResponse.cards.links.label",
"path" : "CDSHooksResponse.cards.links.label",
"short" : "Human-readable label to display for this 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",
"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",
"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" : 1,
"max" : "1",
"base" : {
"path" : "CDSHooksResponse.cards.links.type",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cds-hooks.hl7.org/ValueSet/CDSLinkType"
}
},
{
"id" : "CDSHooksResponse.cards.links.appContext",
"path" : "CDSHooksResponse.cards.links.appContext",
"short" : "Information to share when launching 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.cards.links.autolaunchable",
"path" : "CDSHooksResponse.cards.links.autolaunchable",
"short" : "This field serves as a hint to the CDS Client suggesting this link be immediately launched, without displaying the card and without manual user interaction. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.",
"definition" : "This field serves as a hint to the CDS Client suggesting this link be immediately launched, without displaying the card and without manual user interaction. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CDSHooksResponse.cards.links.autolaunchable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "CDSHooksResponse.systemActions",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior",
"valueCode" : "absent"
}
],
"path" : "CDSHooksResponse.systemActions",
"short" : "Actions 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://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse#CDSHooksResponse.cards.suggestions.actions"
}
]
},
"differential" : {
"element" : [
{
"id" : "CDSHooksResponse",
"path" : "CDSHooksResponse",
"short" : "The response to a CDS service request",
"definition" : "The response to a CDS service request"
},
{
"id" : "CDSHooksResponse.cards",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior",
"valueCode" : "present"
}
],
"path" : "CDSHooksResponse.cards",
"short" : "CDS responses to show user",
"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" : "*",
"type" : [
{
"code" : "http://cds-hooks.hl7.org/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://cds-hooks.hl7.org/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://cds-hooks.hl7.org/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",
"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",
"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",
"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" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cds-hooks.hl7.org/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",
"type" : [
{
"code" : "http://cds-hooks.hl7.org/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",
"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",
"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",
"type" : [
{
"code" : "url"
}
]
},
{
"id" : "CDSHooksResponse.cards.source.topic",
"path" : "CDSHooksResponse.cards.source.topic",
"short" : "Describes the content of the card",
"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",
"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" : "*",
"type" : [
{
"code" : "http://cds-hooks.hl7.org/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://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
},
{
"key" : "cds-resp-7",
"severity" : "error",
"human" : "actionSelectionBehavior must be 'all', 'any', or 'at-most-one'",
"expression" : "actionSelectionBehavior.empty() or actionSelectionBehavior = 'all' or actionSelectionBehavior = 'any' or actionSelectionBehavior = 'at-most-one'",
"source" : "http://cds-hooks.hl7.org/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",
"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",
"type" : [
{
"code" : "uuid"
}
]
},
{
"id" : "CDSHooksResponse.cards.suggestions.isRecommended",
"path" : "CDSHooksResponse.cards.suggestions.isRecommended",
"short" : "Which suggestion is most preferred of a set",
"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",
"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" : "*",
"type" : [
{
"code" : "http://cds-hooks.hl7.org/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://cds-hooks.hl7.org/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",
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cds-hooks.hl7.org/ValueSet/CDSActionType"
}
},
{
"id" : "CDSHooksResponse.cards.suggestions.actions.description",
"path" : "CDSHooksResponse.cards.suggestions.actions.description",
"short" : "Human-readable description of the suggested action",
"definition" : "Human-readable description of the suggested action that may be presented to the end-user.",
"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",
"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",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksResponse.cards.suggestions.actionSelectionBehavior",
"path" : "CDSHooksResponse.cards.suggestions.actionSelectionBehavior",
"short" : "all | any | at-most-one (default: all)",
"definition" : "Indicates whether the end user may select any, none, or only a single action from those included in the suggestion. Allowed values are: all, indicating that a user selecting a suggestion is selecting all of the actions within it; any, indicating that the end user may choose any number of actions including none of them or all of them; at-most-one, indicating that the user may choose none or at most one of the actions. If not provided, the default is all. Note: this is an STU element.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"defaultValueCode" : "all"
},
{
"id" : "CDSHooksResponse.cards.selectionBehavior",
"path" : "CDSHooksResponse.cards.selectionBehavior",
"short" : "at-most-one | any",
"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",
"type" : [
{
"code" : "code"
}
],
"condition" : [
"cds-resp-1",
"cds-resp-6"
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cds-hooks.hl7.org/ValueSet/CDSSelectionBehavior"
}
},
{
"id" : "CDSHooksResponse.cards.overrideReasons",
"path" : "CDSHooksResponse.cards.overrideReasons",
"short" : "Feedback from user on card - why not acted on",
"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" : "*",
"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://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id" : "CDSHooksResponse.cards.links",
"path" : "CDSHooksResponse.cards.links",
"short" : "Link to app or additional information",
"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" : "*",
"type" : [
{
"code" : "http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"
}
],
"constraint" : [
{
"key" : "cds-resp-3",
"severity" : "error",
"human" : "AppContext only for smart Apps",
"expression" : "(type != 'smart') implies (appContext.empty())",
"source" : "http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"
}
]
},
{
"id" : "CDSHooksResponse.cards.links.label",
"path" : "CDSHooksResponse.cards.links.label",
"short" : "Human-readable label to display for this 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",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksResponse.cards.links.url",
"path" : "CDSHooksResponse.cards.links.url",
"short" : "URL to load",
"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",
"type" : [
{
"code" : "url"
}
]
},
{
"id" : "CDSHooksResponse.cards.links.type",
"path" : "CDSHooksResponse.cards.links.type",
"short" : "absolute | smart",
"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" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://cds-hooks.hl7.org/ValueSet/CDSLinkType"
}
},
{
"id" : "CDSHooksResponse.cards.links.appContext",
"path" : "CDSHooksResponse.cards.links.appContext",
"short" : "Information to share when launching 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",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "CDSHooksResponse.cards.links.autolaunchable",
"path" : "CDSHooksResponse.cards.links.autolaunchable",
"short" : "This field serves as a hint to the CDS Client suggesting this link be immediately launched, without displaying the card and without manual user interaction. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.",
"definition" : "This field serves as a hint to the CDS Client suggesting this link be immediately launched, without displaying the card and without manual user interaction. Note that CDS Hooks cards which contain links with this field set to true, may not be shown to the user. Sufficiently advanced CDS Clients may support automatically launching multiple links or multiple cards. Implementer guidance is requested to determine if the specification should preclude these advanced scenarios.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "CDSHooksResponse.systemActions",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior",
"valueCode" : "absent"
}
],
"path" : "CDSHooksResponse.systemActions",
"short" : "Actions 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" : "*",
"contentReference" : "http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse#CDSHooksResponse.cards.suggestions.actions"
}
]
}
}
IG © 2019+ HL7 International / Clinical Decision Support.
Package hl7.fhir.uv.cds-hooks#3.0.0 based on FHIR 4.0.1.
Generated
2026-10-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change