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 CRDHooksRequest logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CRDHooksRequest"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition CRDHooksRequest</b></p><a name="CRDHooksRequest"> </a><a name="hcCRDHooksRequest"> </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-CRDHooksRequest-definitions.html#CDSHooksRequest">CDSHooksRequest</a><a name="CDSHooksRequest"> </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="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksRequest.html">CDSHooksRequest</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"><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-CDSHooksRequest.html" title="The hook that triggered this CDS Service call">hook</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksRequest.html" title="While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation">hookInstance</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksRequest.html" title="The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged">fhirServer</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksRequest.html" title="A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token">fhirAuthorization</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksRequest.html" title="Hook-specific contextual data that the CDS service will need">context</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksRequest.html" title="An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query">prefetch</a><br/>Request for decision support</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_bck10.png)" class="hierarchy"><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_extension_simple.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Simple Extension" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.extension">extension</a><a name="CDSHooksRequest.extension"> </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="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 style="opacity: 0.5; opacity: 0.5" href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHooksExtensions.html">CDSHooksExtensions</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">Extension</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_bck10.png)" class="hierarchy"><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_primitive.png" alt="." style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.hook">hook</a><a name="CDSHooksRequest.hook"> </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 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">Hook event triggering call<br class="binding"/><span style="font-weight:bold" title="null" class="binding">Binding: </span><a href="ValueSet-cdsHookType.html" title="http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType" class="binding">CDS Hook Types Value Set</a><span title="null" 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 title="null" class="binding">)</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_bck10.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.hookInstance">hookInstance</a><a name="CDSHooksRequest.hookInstance"> </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">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: #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/R4/datatypes.html#uuid">uuid</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">Unique id for hook invocation</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_bck10.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.fhirServer">fhirServer</a><a name="CDSHooksRequest.fhirServer"> </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">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#url">url</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">Location to query for data</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_bck11.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization">fhirAuthorization</a><a name="CDSHooksRequest.fhirAuthorization"> </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">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 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">Auth to use in queries</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_bck110.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.accessToken">accessToken</a><a name="CDSHooksRequest.fhirAuthorization.accessToken"> </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#string">string</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">Auth token for query header</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_bck110.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.tokenType">tokenType</a><a name="CDSHooksRequest.fhirAuthorization.tokenType"> </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">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: #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/R4/datatypes.html#code">code</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">Bearer</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_bck110.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.expiresIn">expiresIn</a><a name="CDSHooksRequest.fhirAuthorization.expiresIn"> </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#integer">integer</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">Seconds token is valid</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_bck110.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.scope">scope</a><a name="CDSHooksRequest.fhirAuthorization.scope"> </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">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: #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/R4/datatypes.html#string">string</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">Granted access scopes</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_bck100.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.fhirAuthorization.subject" title="If the granted SMART scopes include patient scopes (i.e. 'patient/'), the access token is restricted to a specific patient. This field SHOULD be populated to identify the FHIR id of that patient.">subject</a><a name="CDSHooksRequest.fhirAuthorization.subject"> </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#string">string</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">Patient id for access</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_bck10.png)" class="hierarchy"><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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.context">context</a><a name="CDSHooksRequest.context"> </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">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: #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-CDSHookContext.html">CDSHookContext</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">Context for decision support<br/>JSON: If<code>%resource.hook = 'appointment-book'</code>then the type is <code>http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookAppointmentBookContext</code><br/>JSON: If<code>%resource.hook = 'encounter-start'</code>then the type is <code>http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterStartContext</code><br/>JSON: If<code>%resource.hook = 'encounter-discharge'</code>then the type is <code>http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterDischargeContext</code><br/>JSON: If<code>%resource.hook = 'order-dispatch'</code>then the type is <code>http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDOrderDispatchContext</code><br/>JSON: If<code>%resource.hook = 'order-select'</code>then the type is <code>http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext</code><br/>JSON: If<code>%resource.hook = 'order-sign'</code>then the type is <code>http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext</code></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_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: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.prefetch">prefetch</a><a name="CDSHooksRequest.prefetch"> </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">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"><span style="opacity: 0.5">Base</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">Prefetch info requested by server</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_bck010.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: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.prefetch.key">key</a><a name="CDSHooksRequest.prefetch.key"> </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">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: #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/R4/datatypes.html#code">code</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">Key as specfied in server prefetch config</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_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: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CRDHooksRequest-definitions.html#CDSHooksRequest.prefetch.value">value</a><a name="CDSHooksRequest.prefetch.value"> </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"><span style="opacity: 0.5">Resource</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">Resource(s) matching prefetch criteria</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/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/CRDHooksRequest"/>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:oid:2.16.840.1.113883.4.642.40.18.42.34"/>
</identifier>
<version value="2.2.0-ballot"/>
<name value="CRDHooksRequest"/>
<title value="CRD CDSHooks Request (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 on the CDS Hooks Request logical model"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</coding>
</jurisdiction>
<fhirVersion value="4.0.1"/>
<kind value="logical"/>
<abstract value="false"/>
<type
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest"/>
<baseDefinition
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest"/>
<derivation value="constraint"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="0.8.0"/>
</extension>
<element id="CDSHooksRequest">
<path value="CDSHooksRequest"/>
<short value="Request for decision support"/>
<definition
value="The data structure that used when invoking a CDS Hook service"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="cds-r-1"/>
<severity value="error"/>
<human
value="if fhirAuthorization details are provided, a fhirServer SHALL be specified"/>
<expression
value="fhirAuthorization.exists() implies fhirServer.exists()"/>
<source
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest"/>
</constraint>
<isModifier value="false"/>
</element>
<element id="CDSHooksRequest.extension">
<path value="CDSHooksRequest.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="CDSHooksRequest.hook">
<path value="CDSHooksRequest.hook"/>
<short value="Hook event triggering call"/>
<definition value="The hook that triggered this CDS Service call"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.hook"/>
<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/us/davinci-crd/ValueSet/cdsHookType"/>
</binding>
</element>
<element id="CDSHooksRequest.hookInstance">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix">
<valueString value="urn:uuid:"/>
</extension>
<path value="CDSHooksRequest.hookInstance"/>
<short value="Unique id for hook invocation"/>
<definition
value="While working in the CDS Client, a user can perform multiple actions in series or in parallel. For example, a clinician might prescribe two drugs in a row; each prescription action would be assigned a unique hookInstance. This allows a CDS Service to uniquely identify each hook invocation"/>
<comment
value="Note: the hookInstance is globally unique and should contain enough entropy to be un-guessable."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.hookInstance"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="uuid"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirServer">
<path value="CDSHooksRequest.fhirServer"/>
<short value="Location to query for data"/>
<definition
value="The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.fhirServer"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="url"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization">
<path value="CDSHooksRequest.fhirAuthorization"/>
<short value="Auth to use in queries"/>
<definition
value="A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.fhirAuthorization"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"/>
</type>
<constraint>
<key value="cds-r-2"/>
<severity value="error"/>
<human
value="If the granted SMART scopes include patient scopes (i.e. 'patient/'), the patient field SHOULD be populated to identify the FHIR id of that patient."/>
<expression
value="scope.contains('Patient/') implies patient.exists()"/>
<source
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest"/>
</constraint>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.extension">
<path value="CDSHooksRequest.fhirAuthorization.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="CDSHooksRequest.fhirAuthorization.accessToken">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-name">
<valueString value="access_token"/>
</extension>
<path value="CDSHooksRequest.fhirAuthorization.accessToken"/>
<short value="Auth token for query header"/>
<definition
value="This is the OAuth 2.0 access token that provides access to the FHIR server"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.fhirAuthorization.accessToken"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.tokenType">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-name">
<valueString value="token_type"/>
</extension>
<path value="CDSHooksRequest.fhirAuthorization.tokenType"/>
<short value="Bearer"/>
<definition
value="The type of token provided. (Present to support future extensibility)"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.fhirAuthorization.tokenType"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<fixedCode value="Bearer"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.expiresIn">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-name">
<valueString value="expires_in"/>
</extension>
<path value="CDSHooksRequest.fhirAuthorization.expiresIn"/>
<short value="Seconds token is valid"/>
<definition value="The lifetime in seconds of the access token."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.fhirAuthorization.expiresIn"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="integer"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.scope">
<path value="CDSHooksRequest.fhirAuthorization.scope"/>
<short value="Granted access scopes"/>
<definition value="The scopes the access token grants the CDS Service"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.fhirAuthorization.scope"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.subject">
<path value="CDSHooksRequest.fhirAuthorization.subject"/>
<short value="Patient id for access"/>
<definition
value="If the granted SMART scopes include patient scopes (i.e. 'patient/'), the access token is restricted to a specific patient. This field SHOULD be populated to identify the FHIR id of that patient."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.fhirAuthorization.subject"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.patient">
<path value="CDSHooksRequest.fhirAuthorization.patient"/>
<short value="OAuth 2.0 client identifier of the CDS Service"/>
<definition
value="The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.fhirAuthorization.patient"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="id"/>
</type>
</element>
<element id="CDSHooksRequest.context">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'appointment-book'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookAppointmentBookContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'encounter-start'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookEncounterStartContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'encounter-discharge'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookEncounterDischargeContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'patient-view'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookPatientViewContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'order-dispatch'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderDispatchContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'order-sign'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSignContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'order-select'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext"/>
</extension>
</extension>
<path value="CDSHooksRequest.context"/>
<short value="Context for decision support"/>
<definition
value="Hook-specific contextual data that the CDS service will need"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.context"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.prefetch">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-property-key">
<valueCode value="key"/>
</extension>
<path value="CDSHooksRequest.prefetch"/>
<short value="Prefetch info requested by server"/>
<definition
value="An object containing key/value pairs of FHIR queries that this Request is requesting the CDS Client to perform and provide on each Request call. The key is a string that describes the type of data being requested and the value is a string representing the FHIR query"/>
<comment
value="While this is mustSupport, CRD clients are not required to pass any or all prefetch data requested by the CRD service."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="CDSHooksRequest.prefetch"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Base"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.prefetch.key">
<path value="CDSHooksRequest.prefetch.key"/>
<short value="Key as specfied in server prefetch config"/>
<definition
value="Name of the FHIR query/read from the CDS Hooks Services object provided by the server"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.prefetch.key"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.prefetch.value">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-nullable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/id-expectation">
<valueCode value="optional"/>
</extension>
<path value="CDSHooksRequest.prefetch.value"/>
<short value="Resource(s) matching prefetch criteria"/>
<definition
value="What was found by executing the search or read requested by the CDS Hooks Service in the context of this particular hook invocation"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="CDSHooksRequest.prefetch.value"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="Resource"/>
</type>
<mustSupport value="true"/>
</element>
</snapshot>
<differential>
<element id="CDSHooksRequest">
<path value="CDSHooksRequest"/>
<short value="Request for decision support"/>
</element>
<element id="CDSHooksRequest.extension">
<path value="CDSHooksRequest.extension"/>
</element>
<element id="CDSHooksRequest.hook">
<path value="CDSHooksRequest.hook"/>
<short value="Hook event triggering call"/>
<type>
<code value="code"/>
</type>
<mustSupport value="true"/>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType"/>
</binding>
</element>
<element id="CDSHooksRequest.hookInstance">
<path value="CDSHooksRequest.hookInstance"/>
<short value="Unique id for hook invocation"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirServer">
<path value="CDSHooksRequest.fhirServer"/>
<short value="Location to query for data"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization">
<path value="CDSHooksRequest.fhirAuthorization"/>
<short value="Auth to use in queries"/>
<min value="1"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.accessToken">
<path value="CDSHooksRequest.fhirAuthorization.accessToken"/>
<short value="Auth token for query header"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.tokenType">
<path value="CDSHooksRequest.fhirAuthorization.tokenType"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.expiresIn">
<path value="CDSHooksRequest.fhirAuthorization.expiresIn"/>
<short value="Seconds token is valid"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.scope">
<path value="CDSHooksRequest.fhirAuthorization.scope"/>
<short value="Granted access scopes"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.fhirAuthorization.subject">
<path value="CDSHooksRequest.fhirAuthorization.subject"/>
<short value="Patient id for access"/>
<definition
value="If the granted SMART scopes include patient scopes (i.e. 'patient/'), the access token is restricted to a specific patient. This field SHOULD be populated to identify the FHIR id of that patient."/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.context">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'appointment-book'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookAppointmentBookContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'encounter-start'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterStartContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'encounter-discharge'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterDischargeContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'order-dispatch'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDOrderDispatchContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'order-select'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-specifier">
<extension url="condition">
<valueString value="%resource.hook = 'order-sign'"/>
</extension>
<extension url="type">
<valueCode
value="http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext"/>
</extension>
</extension>
<path value="CDSHooksRequest.context"/>
<short value="Context for decision support"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.prefetch">
<path value="CDSHooksRequest.prefetch"/>
<short value="Prefetch info requested by server"/>
<comment
value="While this is mustSupport, CRD clients are not required to pass any or all prefetch data requested by the CRD service."/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.prefetch.key">
<path value="CDSHooksRequest.prefetch.key"/>
<short value="Key as specfied in server prefetch config"/>
<mustSupport value="true"/>
</element>
<element id="CDSHooksRequest.prefetch.value">
<path value="CDSHooksRequest.prefetch.value"/>
<short value="Resource(s) matching prefetch criteria"/>
<mustSupport value="true"/>
</element>
</differential>
</StructureDefinition>