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 |
XML representation of the CDSHooksResponse logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CDSHooksResponse"/>
<language value="en"/>
<text>
<status value="extensions"/>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="1"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="cds"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="informative"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-suppress-resourcetype">
<valueBoolean value="true"/>
</extension>
<url value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:oid:2.16.840.1.113883.4.642.40.93.42.6"/>
</identifier>
<version value="3.0.0"/>
<name value="CDSHooksResponse"/>
<title value="CDSHooks Response (Logical Definition)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2026-10-19T12:39:41+00:00"/>
<publisher value="HL7 International / Clinical Decision Support"/>
<contact>
<name value="HL7 International / Clinical Decision Support"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/dss/index.cfm"/>
</telecom>
<telecom>
<system value="email"/>
<value value="cds@lists.HL7.org"/>
</telecom>
</contact>
<description
value="This structure is defined to allow the FHIR Validator to validate a CDSHooks Response body."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<fhirVersion value="4.0.1"/>
<kind value="logical"/>
<abstract value="false"/>
<type
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
<baseDefinition
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
<derivation value="specialization"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="3.0.0"/>
</extension>
<element id="CDSHooksResponse">
<path value="CDSHooksResponse"/>
<short value="The response to a CDS service request"/>
<definition value="The response to a CDS service request"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
</element>
<element id="CDSHooksResponse.extension">
<path value="CDSHooksResponse.extension"/>
<short value="Object that has Named Extension Properties"/>
<definition
value="A JSON object that has properties where the names are defined by the extension definitions"/>
<comment
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksElement.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"/>
</type>
</element>
<element id="CDSHooksResponse.cards">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior">
<valueCode value="present"/>
</extension>
<path value="CDSHooksResponse.cards"/>
<short value="CDS responses to show user"/>
<definition
value="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
value="The CDS Client decides how to display cards, but this specification recommends displaying suggestions using buttons, and links using underlined text."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.cards"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
<constraint>
<key value="cds-resp-1"/>
<severity value="error"/>
<human
value="only one action can be suggested if selectionBehavior = at-most-one"/>
<expression
value="(selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
<constraint>
<key value="cds-resp-6"/>
<severity value="error"/>
<human
value="If suggestions are present, selectionBehavior MUST also be provided."/>
<expression
value="suggestions.exists() implies selectionBehavior.exists()"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.extension">
<path value="CDSHooksResponse.cards.extension"/>
<short value="Object that has Named Extension Properties"/>
<definition
value="A JSON object that has properties where the names are defined by the extension definitions"/>
<comment
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksElement.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"/>
</type>
</element>
<element id="CDSHooksResponse.cards.uuid">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix">
<valueString value="urn:uuid:"/>
</extension>
<path value="CDSHooksResponse.cards.uuid"/>
<short value="Unique identifier of the card (for logging/feedback)"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.uuid"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uuid"/>
</type>
</element>
<element id="CDSHooksResponse.cards.summary">
<path value="CDSHooksResponse.cards.summary"/>
<short value="Summary message for display to the user (<140 char)"/>
<definition
value="One-sentence, <140-character summary message for display to the user inside of this card."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.summary"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.detail">
<path value="CDSHooksResponse.cards.detail"/>
<short
value="Optional detailed information to display (GitHub Flavored Markdown)"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.detail"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="markdown"/>
</type>
</element>
<element id="CDSHooksResponse.cards.indicator">
<path value="CDSHooksResponse.cards.indicator"/>
<short
value="info, warning, critical - Urgency/importance of what this card conveys"/>
<definition
value="Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical."/>
<comment
value="The CDS Client MAY use this field to help make UI display decisions such as sort order or coloring."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.indicator"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://cds-hooks.hl7.org/ValueSet/CDSIndicator"/>
</binding>
</element>
<element id="CDSHooksResponse.cards.source">
<path value="CDSHooksResponse.cards.source"/>
<short
value="The primary source of guidance for the content the card represents."/>
<definition
value="The source should be the primary source of guidance for the decision support the card represents."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.source"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.extension">
<path value="CDSHooksResponse.cards.source.extension"/>
<short value="Object that has Named Extension Properties"/>
<definition
value="A JSON object that has properties where the names are defined by the extension definitions"/>
<comment
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksElement.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.label">
<path value="CDSHooksResponse.cards.source.label"/>
<short value="Short, human-readable label to display for the source."/>
<definition
value="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 value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.source.label"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.url">
<path value="CDSHooksResponse.cards.source.url"/>
<short
value="Link for when user clicks for more information about the source"/>
<definition
value="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
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.source.url"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="url"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.icon">
<path value="CDSHooksResponse.cards.source.icon"/>
<short
value="absolute URL to an icon for the source (<100x100 PNG))"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.source.icon"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="url"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.topic">
<path value="CDSHooksResponse.cards.source.topic"/>
<short value="Describes the content of the card"/>
<definition
value="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
value="This specification does not prescribe a standard set of topics"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.source.topic"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Coding"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions">
<path value="CDSHooksResponse.cards.suggestions"/>
<short
value="Suggest a set of changes in the context of the current activity"/>
<definition
value="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 value="0"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.cards.suggestions"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
<condition value="cds-resp-1"/>
<condition value="cds-resp-6"/>
<constraint>
<key value="cds-resp-5"/>
<severity value="error"/>
<human value="All suggestion actions must have a description"/>
<expression value="actions.all(description.exists())"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
<constraint>
<key value="cds-resp-7"/>
<severity value="error"/>
<human
value="actionSelectionBehavior must be 'all', 'any', or 'at-most-one'"/>
<expression
value="actionSelectionBehavior.empty() or actionSelectionBehavior = 'all' or actionSelectionBehavior = 'any' or actionSelectionBehavior = 'at-most-one'"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.suggestions.extension">
<path value="CDSHooksResponse.cards.suggestions.extension"/>
<short value="Object that has Named Extension Properties"/>
<definition
value="A JSON object that has properties where the names are defined by the extension definitions"/>
<comment
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksElement.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.label">
<path value="CDSHooksResponse.cards.suggestions.label"/>
<short value="Human-readable label to display for this suggestion"/>
<definition
value="Human-readable label to display for this suggestion"/>
<comment
value="e.g. the CDS Client might render this as the text on a button tied to this suggestion"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.label"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.uuid">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix">
<valueString value="urn:uuid:"/>
</extension>
<path value="CDSHooksResponse.cards.suggestions.uuid"/>
<short
value="Unique identifier, used for auditing and logging suggestions"/>
<definition
value="Unique identifier, used for auditing and logging suggestions"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.uuid"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uuid"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.isRecommended">
<path value="CDSHooksResponse.cards.suggestions.isRecommended"/>
<short value="Which suggestion is most preferred of a set"/>
<definition
value="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
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.isRecommended"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions">
<path value="CDSHooksResponse.cards.suggestions.actions"/>
<short value="Defines a suggested action (all apply)"/>
<definition
value="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
value="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 value="0"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.actions"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
<constraint>
<key value="cds-resp-2"/>
<severity value="warning"/>
<human
value="A resourceId not a resource must be provided when type = delete"/>
<expression
value="(type = 'delete') implies (resourceId.exists() and resource.empty())"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.extension">
<path value="CDSHooksResponse.cards.suggestions.actions.extension"/>
<short value="Object that has Named Extension Properties"/>
<definition
value="A JSON object that has properties where the names are defined by the extension definitions"/>
<comment
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksElement.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.type">
<path value="CDSHooksResponse.cards.suggestions.actions.type"/>
<short value="create, update, delete - type of action performed"/>
<definition
value="The type of action being performed. Allowed values are: create, update, delete."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.actions.type"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://cds-hooks.hl7.org/ValueSet/CDSActionType"/>
</binding>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.description">
<path value="CDSHooksResponse.cards.suggestions.actions.description"/>
<short value="Human-readable description of the suggested action"/>
<definition
value="Human-readable description of the suggested action that may be presented to the end-user."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.actions.description"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<condition value="cds-resp-5"/>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.resource">
<path value="CDSHooksResponse.cards.suggestions.actions.resource"/>
<short value="FHIR resource to create/update"/>
<definition
value="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
value="Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.actions.resource"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Resource"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.resourceId">
<path value="CDSHooksResponse.cards.suggestions.actions.resourceId"/>
<short value="A relative reference to the relevant resource."/>
<definition
value="A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.actions.resourceId"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.actionSelectionBehavior">
<path
value="CDSHooksResponse.cards.suggestions.actionSelectionBehavior"/>
<short value="all | any | at-most-one (default: all)"/>
<definition
value="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 value="0"/>
<max value="1"/>
<base>
<path
value="CDSHooksResponse.cards.suggestions.actionSelectionBehavior"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<defaultValueCode value="all"/>
</element>
<element id="CDSHooksResponse.cards.selectionBehavior">
<path value="CDSHooksResponse.cards.selectionBehavior"/>
<short value="at-most-one | any"/>
<definition
value="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
value="CDS Clients that do not understand the value MUST treat the card as an error."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.selectionBehavior"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<condition value="cds-resp-1"/>
<condition value="cds-resp-6"/>
<binding>
<strength value="required"/>
<valueSet
value="http://cds-hooks.hl7.org/ValueSet/CDSSelectionBehavior"/>
</binding>
</element>
<element id="CDSHooksResponse.cards.overrideReasons">
<path value="CDSHooksResponse.cards.overrideReasons"/>
<short value="Feedback from user on card - why not acted on"/>
<definition
value="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
value="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 value="0"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.cards.overrideReasons"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Coding"/>
</type>
<constraint>
<key value="cds-resp-4"/>
<severity value="error"/>
<human
value="the CDS Service MUST populate a display value for each reason's Coding"/>
<expression value="all(display.exists())"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.links">
<path value="CDSHooksResponse.cards.links"/>
<short value="Link to app or additional information"/>
<definition
value="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 value="0"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.cards.links"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
<constraint>
<key value="cds-resp-3"/>
<severity value="error"/>
<human value="AppContext only for smart Apps"/>
<expression value="(type != 'smart') implies (appContext.empty())"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.links.extension">
<path value="CDSHooksResponse.cards.links.extension"/>
<short value="Object that has Named Extension Properties"/>
<definition
value="A JSON object that has properties where the names are defined by the extension definitions"/>
<comment
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksElement.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksExtensions"/>
</type>
</element>
<element id="CDSHooksResponse.cards.links.label">
<path value="CDSHooksResponse.cards.links.label"/>
<short value="Human-readable label to display for this link"/>
<definition
value="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 value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.links.label"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.links.url">
<path value="CDSHooksResponse.cards.links.url"/>
<short value="URL to load"/>
<definition
value="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 value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.links.url"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="url"/>
</type>
</element>
<element id="CDSHooksResponse.cards.links.type">
<path value="CDSHooksResponse.cards.links.type"/>
<short value="absolute | smart"/>
<definition
value="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 value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.links.type"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://cds-hooks.hl7.org/ValueSet/CDSLinkType"/>
</binding>
</element>
<element id="CDSHooksResponse.cards.links.appContext">
<path value="CDSHooksResponse.cards.links.appContext"/>
<short value="Information to share when launching SMART app"/>
<definition
value="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
value="CDS Client support for appContext requires additional coordination with the authorization server that is not described or specified in CDS Hooks nor SMART."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.links.appContext"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.links.autolaunchable">
<path value="CDSHooksResponse.cards.links.autolaunchable"/>
<short
value="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
value="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 value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.links.autolaunchable"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
</element>
<element id="CDSHooksResponse.systemActions">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior">
<valueCode value="absent"/>
</extension>
<path value="CDSHooksResponse.systemActions"/>
<short value="Actions to auto-apply"/>
<definition
value="An array of Actions that the CDS Service proposes to auto-apply"/>
<comment
value="Each action follows the schema of a card-based suggestion.action. The CDS Client decides whether to auto-apply actions."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.systemActions"/>
<min value="0"/>
<max value="*"/>
</base>
<contentReference
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse#CDSHooksResponse.cards.suggestions.actions"/>
</element>
</snapshot>
<differential>
<element id="CDSHooksResponse">
<path value="CDSHooksResponse"/>
<short value="The response to a CDS service request"/>
<definition value="The response to a CDS service request"/>
</element>
<element id="CDSHooksResponse.cards">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior">
<valueCode value="present"/>
</extension>
<path value="CDSHooksResponse.cards"/>
<short value="CDS responses to show user"/>
<definition
value="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
value="The CDS Client decides how to display cards, but this specification recommends displaying suggestions using buttons, and links using underlined text."/>
<min value="0"/>
<max value="*"/>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
<constraint>
<key value="cds-resp-1"/>
<severity value="error"/>
<human
value="only one action can be suggested if selectionBehavior = at-most-one"/>
<expression
value="(selectionBehavior = 'at-most-one') implies suggestions.where(isRecommended).count() <= 1"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
<constraint>
<key value="cds-resp-6"/>
<severity value="error"/>
<human
value="If suggestions are present, selectionBehavior MUST also be provided."/>
<expression
value="suggestions.exists() implies selectionBehavior.exists()"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.uuid">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix">
<valueString value="urn:uuid:"/>
</extension>
<path value="CDSHooksResponse.cards.uuid"/>
<short value="Unique identifier of the card (for logging/feedback)"/>
<definition
value="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 value="0"/>
<max value="1"/>
<type>
<code value="uuid"/>
</type>
</element>
<element id="CDSHooksResponse.cards.summary">
<path value="CDSHooksResponse.cards.summary"/>
<short value="Summary message for display to the user (<140 char)"/>
<definition
value="One-sentence, <140-character summary message for display to the user inside of this card."/>
<min value="1"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.detail">
<path value="CDSHooksResponse.cards.detail"/>
<short
value="Optional detailed information to display (GitHub Flavored Markdown)"/>
<definition
value="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 value="0"/>
<max value="1"/>
<type>
<code value="markdown"/>
</type>
</element>
<element id="CDSHooksResponse.cards.indicator">
<path value="CDSHooksResponse.cards.indicator"/>
<short
value="info, warning, critical - Urgency/importance of what this card conveys"/>
<definition
value="Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: info, warning, critical."/>
<comment
value="The CDS Client MAY use this field to help make UI display decisions such as sort order or coloring."/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://cds-hooks.hl7.org/ValueSet/CDSIndicator"/>
</binding>
</element>
<element id="CDSHooksResponse.cards.source">
<path value="CDSHooksResponse.cards.source"/>
<short
value="The primary source of guidance for the content the card represents."/>
<definition
value="The source should be the primary source of guidance for the decision support the card represents."/>
<min value="1"/>
<max value="1"/>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.label">
<path value="CDSHooksResponse.cards.source.label"/>
<short value="Short, human-readable label to display for the source."/>
<definition
value="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 value="1"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.url">
<path value="CDSHooksResponse.cards.source.url"/>
<short
value="Link for when user clicks for more information about the source"/>
<definition
value="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
value="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 value="0"/>
<max value="1"/>
<type>
<code value="url"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.icon">
<path value="CDSHooksResponse.cards.source.icon"/>
<short
value="absolute URL to an icon for the source (<100x100 PNG))"/>
<definition
value="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 value="0"/>
<max value="1"/>
<type>
<code value="url"/>
</type>
</element>
<element id="CDSHooksResponse.cards.source.topic">
<path value="CDSHooksResponse.cards.source.topic"/>
<short value="Describes the content of the card"/>
<definition
value="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
value="This specification does not prescribe a standard set of topics"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Coding"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions">
<path value="CDSHooksResponse.cards.suggestions"/>
<short
value="Suggest a set of changes in the context of the current activity"/>
<definition
value="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 value="0"/>
<max value="*"/>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
<condition value="cds-resp-1"/>
<condition value="cds-resp-6"/>
<constraint>
<key value="cds-resp-5"/>
<severity value="error"/>
<human value="All suggestion actions must have a description"/>
<expression value="actions.all(description.exists())"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
<constraint>
<key value="cds-resp-7"/>
<severity value="error"/>
<human
value="actionSelectionBehavior must be 'all', 'any', or 'at-most-one'"/>
<expression
value="actionSelectionBehavior.empty() or actionSelectionBehavior = 'all' or actionSelectionBehavior = 'any' or actionSelectionBehavior = 'at-most-one'"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.suggestions.label">
<path value="CDSHooksResponse.cards.suggestions.label"/>
<short value="Human-readable label to display for this suggestion"/>
<definition
value="Human-readable label to display for this suggestion"/>
<comment
value="e.g. the CDS Client might render this as the text on a button tied to this suggestion"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.uuid">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix">
<valueString value="urn:uuid:"/>
</extension>
<path value="CDSHooksResponse.cards.suggestions.uuid"/>
<short
value="Unique identifier, used for auditing and logging suggestions"/>
<definition
value="Unique identifier, used for auditing and logging suggestions"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="uuid"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.isRecommended">
<path value="CDSHooksResponse.cards.suggestions.isRecommended"/>
<short value="Which suggestion is most preferred of a set"/>
<definition
value="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
value="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 value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions">
<path value="CDSHooksResponse.cards.suggestions.actions"/>
<short value="Defines a suggested action (all apply)"/>
<definition
value="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
value="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 value="0"/>
<max value="*"/>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
<constraint>
<key value="cds-resp-2"/>
<severity value="warning"/>
<human
value="A resourceId not a resource must be provided when type = delete"/>
<expression
value="(type = 'delete') implies (resourceId.exists() and resource.empty())"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.type">
<path value="CDSHooksResponse.cards.suggestions.actions.type"/>
<short value="create, update, delete - type of action performed"/>
<definition
value="The type of action being performed. Allowed values are: create, update, delete."/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://cds-hooks.hl7.org/ValueSet/CDSActionType"/>
</binding>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.description">
<path value="CDSHooksResponse.cards.suggestions.actions.description"/>
<short value="Human-readable description of the suggested action"/>
<definition
value="Human-readable description of the suggested action that may be presented to the end-user."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
<condition value="cds-resp-5"/>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.resource">
<path value="CDSHooksResponse.cards.suggestions.actions.resource"/>
<short value="FHIR resource to create/update"/>
<definition
value="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
value="Use of this field to communicate a string of a FHIR id for delete suggestions is DEPRECATED and resourceId SHOULD be used instead."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="Resource"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.resourceId">
<path value="CDSHooksResponse.cards.suggestions.actions.resourceId"/>
<short value="A relative reference to the relevant resource."/>
<definition
value="A relative reference to the relevant resource. SHOULD be provided when the type attribute is delete."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.suggestions.actionSelectionBehavior">
<path
value="CDSHooksResponse.cards.suggestions.actionSelectionBehavior"/>
<short value="all | any | at-most-one (default: all)"/>
<definition
value="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 value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<defaultValueCode value="all"/>
</element>
<element id="CDSHooksResponse.cards.selectionBehavior">
<path value="CDSHooksResponse.cards.selectionBehavior"/>
<short value="at-most-one | any"/>
<definition
value="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
value="CDS Clients that do not understand the value MUST treat the card as an error."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<condition value="cds-resp-1"/>
<condition value="cds-resp-6"/>
<binding>
<strength value="required"/>
<valueSet
value="http://cds-hooks.hl7.org/ValueSet/CDSSelectionBehavior"/>
</binding>
</element>
<element id="CDSHooksResponse.cards.overrideReasons">
<path value="CDSHooksResponse.cards.overrideReasons"/>
<short value="Feedback from user on card - why not acted on"/>
<definition
value="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
value="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 value="0"/>
<max value="*"/>
<type>
<code value="Coding"/>
</type>
<constraint>
<key value="cds-resp-4"/>
<severity value="error"/>
<human
value="the CDS Service MUST populate a display value for each reason's Coding"/>
<expression value="all(display.exists())"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.links">
<path value="CDSHooksResponse.cards.links"/>
<short value="Link to app or additional information"/>
<definition
value="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 value="0"/>
<max value="*"/>
<type>
<code
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksElement"/>
</type>
<constraint>
<key value="cds-resp-3"/>
<severity value="error"/>
<human value="AppContext only for smart Apps"/>
<expression value="(type != 'smart') implies (appContext.empty())"/>
<source
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse"/>
</constraint>
</element>
<element id="CDSHooksResponse.cards.links.label">
<path value="CDSHooksResponse.cards.links.label"/>
<short value="Human-readable label to display for this link"/>
<definition
value="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 value="1"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.links.url">
<path value="CDSHooksResponse.cards.links.url"/>
<short value="URL to load"/>
<definition
value="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 value="1"/>
<max value="1"/>
<type>
<code value="url"/>
</type>
</element>
<element id="CDSHooksResponse.cards.links.type">
<path value="CDSHooksResponse.cards.links.type"/>
<short value="absolute | smart"/>
<definition
value="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 value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://cds-hooks.hl7.org/ValueSet/CDSLinkType"/>
</binding>
</element>
<element id="CDSHooksResponse.cards.links.appContext">
<path value="CDSHooksResponse.cards.links.appContext"/>
<short value="Information to share when launching SMART app"/>
<definition
value="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
value="CDS Client support for appContext requires additional coordination with the authorization server that is not described or specified in CDS Hooks nor SMART."/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="CDSHooksResponse.cards.links.autolaunchable">
<path value="CDSHooksResponse.cards.links.autolaunchable"/>
<short
value="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
value="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 value="0"/>
<max value="1"/>
<type>
<code value="boolean"/>
</type>
</element>
<element id="CDSHooksResponse.systemActions">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-empty-behavior">
<valueCode value="absent"/>
</extension>
<path value="CDSHooksResponse.systemActions"/>
<short value="Actions to auto-apply"/>
<definition
value="An array of Actions that the CDS Service proposes to auto-apply"/>
<comment
value="Each action follows the schema of a card-based suggestion.action. The CDS Client decides whether to auto-apply actions."/>
<min value="0"/>
<max value="*"/>
<contentReference
value="http://cds-hooks.hl7.org/StructureDefinition/CDSHooksResponse#CDSHooksResponse.cards.suggestions.actions"/>
</element>
</differential>
</StructureDefinition>
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-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change