Da Vinci - Coverage Requirements Discovery
2.2.0-ballot - STU 2.2 Ballot
Da Vinci - Coverage Requirements Discovery
2.2.0-ballot - STU 2.2 Ballot
This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.2.0-ballot: STU 2.2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.1.0. For a full list of available versions, see the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 4 |
XML representation of the CRDHooksResponse-additionalOrders logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CRDHooksResponse-additionalOrders"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition CRDHooksResponse-additionalOrders</b></p><a name="CRDHooksResponse-additionalOrders"> </a><a name="hcCRDHooksResponse-additionalOrders"> </a><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><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 style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><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 style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><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 style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px" class="hierarchy"><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 style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><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 style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><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-CRDHooksResponse-additionalOrders-definitions.html#CDSHooksResponse">CDSHooksResponse</a><a name="CDSHooksResponse"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-CRDHooksResponseBase.html">CRDHooksResponseBase</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">This is an abstract profile. <br/>Elements defined in Ancestors:<a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksElement.html" title="A JSON object that has properties where the names are defined by the extension definitions">extension</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksResponse.html" 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 href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksResponse.html" title="An array of Actions that the CDS Service proposes to auto-apply">systemActions</a>, <a href="StructureDefinition-CRDHooksResponseBase.html">cards</a><br/><span style="opacity: 0.5">The response to the discovery endpoint</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)" class="hierarchy"><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"/> <a href="StructureDefinition-CRDHooksResponse-additionalOrders-definitions.html#CDSHooksResponse.cards">cards</a><a name="CDSHooksResponse.cards"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5; opacity: 0.5" href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksElement.html">CDSHooksElement</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">CDS responses to show user</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck011.png)" class="hierarchy"><img src="tbl_spacer.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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksResponse-additionalOrders-definitions.html#CDSHooksResponse.cards.suggestions">suggestions</a><a name="CDSHooksResponse.cards.suggestions"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5; opacity: 0.5" href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksElement.html">CDSHooksElement</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Suggest a set of changes in the context of the current activity</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0101.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksResponse-additionalOrders-definitions.html#CDSHooksResponse.cards.suggestions.actions">actions</a><a name="CDSHooksResponse.cards.suggestions.actions"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5; opacity: 0.5" href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksElement.html">CDSHooksElement</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Defines a suggested action (all apply)</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01010.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksResponse-additionalOrders-definitions.html#CDSHooksResponse.cards.suggestions.actions.type">type</a><a name="CDSHooksResponse.cards.suggestions.actions.type"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5; opacity: 0.5" href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">create, update, delete - type of action performed</span><br/><span style="font-weight:bold">Required Pattern: </span><span style="color: darkgreen">create</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01010.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.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_resource.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-CRDHooksResponse-additionalOrders-definitions.html#CDSHooksResponse.cards.suggestions.actions.resource">resource</a><a name="CDSHooksResponse.cards.suggestions.actions.resource"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-profile-appointment-with-order.html" title="Resource">CRDAppointmentWithOrder</a>, <a href="StructureDefinition-profile-appointment-no-order.html" title="Resource">CRDAppointmentNoOrder</a>, <a href="StructureDefinition-profile-communicationrequest.html" title="Resource">CRDCommunicationRequest</a>, <a href="StructureDefinition-profile-devicerequest.html" title="Resource">CRDDeviceRequest</a>, <a href="StructureDefinition-profile-medicationrequest.html" title="Resource">CRDMedicationRequest</a>, <a href="StructureDefinition-profile-nutritionorder.html" title="Resource">CRDNutritionOrder</a>, <a href="StructureDefinition-profile-servicerequest.html" title="Resource">CRDServiceRequest</a>, <a href="StructureDefinition-profile-visionprescription.html" title="Resource">CRDVisionPrescription</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01000.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <span style="text-decoration:line-through">resourceId</span><a name="CDSHooksResponse.cards.suggestions.actions.resourceId"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="text-decoration:line-through"/><span style="text-decoration:line-through">0</span><span style="text-decoration:line-through">..</span><span style="text-decoration:line-through">0</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)" class="hierarchy"><img src="tbl_spacer.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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <span style="text-decoration:line-through">links</span><a name="CDSHooksResponse.cards.links"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="text-decoration:line-through"/><span style="text-decoration:line-through">0</span><span style="text-decoration:line-through">..</span><span style="text-decoration:line-through">0</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></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/tools/StructureDefinition/json-suppress-resourcetype">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="fm"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="4">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponse-additionalOrders"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:oid:2.16.840.1.113883.4.642.40.18.42.40"/>
</identifier>
<version value="2.2.0-ballot"/>
<name value="CRDHooksResponseAdditionalOrders"/>
<title
value="CRD CDSHooks Additional Orders Response (Logical Definition)"/>
<status value="active"/>
<date value="2025-08-06T17:27:13+00:00"/>
<publisher value="HL7 International / Financial Management"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/fm"/>
</telecom>
</contact>
<description
value="Defines CRD-specific constraints for the Additional Orders response type"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<fhirVersion value="4.0.1"/>
<kind value="logical"/>
<abstract value="true"/>
<type
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"/>
<baseDefinition
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksResponseBase"/>
<derivation value="constraint"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="2.2.0-ballot"/>
</extension>
<element id="CDSHooksResponse">
<path value="CDSHooksResponse"/>
<short value="The response to the discovery endpoint"/>
<definition value="The response to the discovery endpoint"/>
<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://hl7.org/fhir/tools/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="1"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.cards"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/fhir/tools/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://hl7.org/fhir/tools/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://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"/>
</constraint>
<mustSupport value="true"/>
</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://hl7.org/fhir/tools/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="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.uuid"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uuid"/>
</type>
<mustSupport value="true"/>
</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>
<mustSupport value="true"/>
</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="0"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.indicator"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<mustSupport value="true"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/tools/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://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/>
</type>
<mustSupport value="true"/>
</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://hl7.org/fhir/tools/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>
<mustSupport value="true"/>
</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="1"/>
<max value="1"/>
<base>
<path value="CDSHooksResponse.cards.source.topic"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Coding"/>
</type>
<mustSupport value="true"/>
<binding>
<strength value="extensible"/>
<valueSet
value="http://hl7.org/fhir/us/davinci-crd/ValueSet/cardType"/>
</binding>
</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="1"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.cards.suggestions"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/fhir/tools/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://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"/>
</constraint>
<mustSupport value="true"/>
</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://hl7.org/fhir/tools/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>
<mustSupport value="true"/>
</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="1"/>
<max value="*"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.actions"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/fhir/tools/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://hl7.org/fhir/tools/StructureDefinition/CDSHooksResponse"/>
</constraint>
<mustSupport value="true"/>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.extension">
<path value="CDSHooksResponse.cards.suggestions.actions.extension"/>
<short value="Extension"/>
<definition value="An Extension"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksElement.extension"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/fhir/tools/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>
<patternCode value="create"/>
<mustSupport value="true"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/tools/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="1"/>
<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"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.resource">
<path value="CDSHooksResponse.cards.suggestions.actions.resource"/>
<short
value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)"/>
<definition
value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)."/>
<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"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment-with-order"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment-no-order"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription"/>
</type>
<mustSupport value="true"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Entity. Role, or Act"/>
</mapping>
<mapping>
<identity value="workflow"/>
<map value="Request"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Act[@moodCode <= 'INT']"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="VEVENT"/>
</mapping>
</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="0"/>
<base>
<path value="CDSHooksResponse.cards.suggestions.actions.resourceId"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="url"/>
</type>
</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://hl7.org/fhir/tools/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://hl7.org/fhir/tools/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="0"/>
<base>
<path value="CDSHooksResponse.cards.links"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://hl7.org/fhir/tools/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://hl7.org/fhir/tools/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://hl7.org/fhir/tools/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>
<mustSupport value="true"/>
</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>
<mustSupport value="true"/>
</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="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<mustSupport value="true"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/tools/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>
<mustSupport value="true"/>
</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>
<type>
<code
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/>
</type>
</element>
<element id="CDSHooksResponse.systemActions.extension">
<path value="CDSHooksResponse.systemActions.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://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions"/>
</type>
</element>
<element id="CDSHooksResponse.systemActions.type">
<path value="CDSHooksResponse.systemActions.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>
<mustSupport value="true"/>
<binding>
<strength value="required"/>
<valueSet value="http://hl7.org/fhir/tools/ValueSet/CDSActionType"/>
</binding>
</element>
<element id="CDSHooksResponse.systemActions.description">
<path value="CDSHooksResponse.systemActions.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.systemActions.resource">
<path value="CDSHooksResponse.systemActions.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.systemActions.resourceId">
<path value="CDSHooksResponse.systemActions.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="url"/>
</type>
</element>
</snapshot>
<differential>
<element id="CDSHooksResponse">
<path value="CDSHooksResponse"/>
</element>
<element id="CDSHooksResponse.cards">
<path value="CDSHooksResponse.cards"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksResponse.cards.suggestions">
<path value="CDSHooksResponse.cards.suggestions"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions">
<path value="CDSHooksResponse.cards.suggestions.actions"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.type">
<path value="CDSHooksResponse.cards.suggestions.actions.type"/>
<patternCode value="create"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.resource">
<path value="CDSHooksResponse.cards.suggestions.actions.resource"/>
<type>
<code value="Resource"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment-with-order"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment-no-order"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest"/>
<profile
value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksResponse.cards.suggestions.actions.resourceId">
<path value="CDSHooksResponse.cards.suggestions.actions.resourceId"/>
<max value="0"/>
</element>
<element id="CDSHooksResponse.cards.links">
<path value="CDSHooksResponse.cards.links"/>
<max value="0"/>
</element>
</differential>
</StructureDefinition>
IG © 2019+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-crd#2.2.0-ballot based on FHIR 4.0.1. Generated 2025-08-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change