Da Vinci - Coverage Requirements Discovery
2.2.0-snapshot - STU 2.2 Peer Review

Da Vinci - Coverage Requirements Discovery, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.0-snapshot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-crd/ and changes regularly. See the Directory of published versions

## Logical Model: CRD CDSHooks Request (Logical Definition) - JSON Profile

Page standards status: Trial-use | Maturity Level: 4

JSON representation of the CRDHooksRequest logical model.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "CRDHooksRequest",
      "language" : "en",
      "text" : {
        "status" : "extensions",
        "div" : "<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 &amp; 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, \" 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/1.0.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\">Request for decision support</td></tr>\r\n<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/1.0.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>\r\n<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>\r\n<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>\r\n<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>\r\n<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/1.0.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>\r\n<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>\r\n<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>\r\n<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>\r\n<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>\r\n<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>\r\n<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/1.0.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>\r\n<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>\r\n<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>\r\n<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>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-suppress-resourcetype",
          "valueBoolean" : true
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "fm"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
          "valueInteger" : 4,
          "_valueInteger" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd"
              }
            ]
          }
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
          "valueCode" : "trial-use",
          "_valueCode" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd"
              }
            ]
          }
        }
      ],
      "url" : "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDHooksRequest",
      "identifier" : [
        {
          "system" : "urn:ietf:rfc:3986",
          "value" : "urn:oid:2.16.840.1.113883.4.642.40.18.42.34"
        }
      ],
      "version" : "2.2.0-snapshot",
      "name" : "CRDHooksRequest",
      "title" : "CRD CDSHooks Request (Logical Definition)",
      "status" : "active",
      "date" : "2026-02-19T15:54:35+00:00",
      "publisher" : "HL7 International / Financial Management",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/fm"
            }
          ]
        }
      ],
      "description" : "Defines CRD-specific constraints on the CDS Hooks Request logical model",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US"
            }
          ]
        }
      ],
      "fhirVersion" : "4.0.1",
      "kind" : "logical",
      "abstract" : false,
      "type" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest",
      "baseDefinition" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest",
      "derivation" : "constraint",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "1.0.0"
          }
        ],
        "element" : [
          {
            "id" : "CDSHooksRequest",
            "path" : "CDSHooksRequest",
            "short" : "Request for decision support",
            "definition" : "The data structure that used when invoking a CDS Hook service",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Base",
              "min" : 0,
              "max" : "*"
            },
            "constraint" : [
              {
                "key" : "cds-r-1",
                "severity" : "error",
                "human" : "if fhirAuthorization details are provided, a fhirServer SHALL be specified",
                "expression" : "fhirAuthorization.exists() implies fhirServer.exists()",
                "source" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest"
              }
            ],
            "isModifier" : false
          },
          {
            "id" : "CDSHooksRequest.extension",
            "path" : "CDSHooksRequest.extension",
            "short" : "Extension",
            "definition" : "An Extension",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksElement.extension",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions"
              }
            ]
          },
          {
            "id" : "CDSHooksRequest.hook",
            "path" : "CDSHooksRequest.hook",
            "short" : "Hook event triggering call",
            "definition" : "The hook that triggered this CDS Service call",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.hook",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "mustSupport" : true,
            "binding" : {
              "strength" : "required",
              "valueSet" : "http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType"
            }
          },
          {
            "id" : "CDSHooksRequest.hookInstance",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/implied-string-prefix",
                "valueString" : "urn:uuid:"
              }
            ],
            "path" : "CDSHooksRequest.hookInstance",
            "short" : "Unique id for hook invocation",
            "definition" : "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" : "Note: the hookInstance is globally unique and should contain enough entropy to be un-guessable.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.hookInstance",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "uuid"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirServer",
            "path" : "CDSHooksRequest.fhirServer",
            "short" : "Location to query for data",
            "definition" : "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" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.fhirServer",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "url"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization",
            "path" : "CDSHooksRequest.fhirAuthorization",
            "short" : "Auth to use in queries",
            "definition" : "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" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.fhirAuthorization",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksElement"
              }
            ],
            "constraint" : [
              {
                "key" : "cds-r-2",
                "severity" : "error",
                "human" : "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" : "scope.contains('Patient/') implies patient.exists()",
                "source" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksRequest"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.extension",
            "path" : "CDSHooksRequest.fhirAuthorization.extension",
            "short" : "Object that has Named Extension Properties",
            "definition" : "A JSON object that has properties where the names are defined by the extension definitions",
            "comment" : "Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, e.g. com.cds-hooks.sandbox.myextension-practitionerspecialty. How to handle complex extensions (objects) is not defined",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksElement.extension",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtensions"
              }
            ]
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.accessToken",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-name",
                "valueString" : "access_token"
              }
            ],
            "path" : "CDSHooksRequest.fhirAuthorization.accessToken",
            "short" : "Auth token for query header",
            "definition" : "This is the OAuth 2.0 access token that provides access to the FHIR server",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.fhirAuthorization.accessToken",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.tokenType",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-name",
                "valueString" : "token_type"
              }
            ],
            "path" : "CDSHooksRequest.fhirAuthorization.tokenType",
            "short" : "Bearer",
            "definition" : "The type of token provided.  (Present to support future extensibility)",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.fhirAuthorization.tokenType",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "fixedCode" : "Bearer",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.expiresIn",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-name",
                "valueString" : "expires_in"
              }
            ],
            "path" : "CDSHooksRequest.fhirAuthorization.expiresIn",
            "short" : "Seconds token is valid",
            "definition" : "The lifetime in seconds of the access token.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.fhirAuthorization.expiresIn",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "integer"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.scope",
            "path" : "CDSHooksRequest.fhirAuthorization.scope",
            "short" : "Granted access scopes",
            "definition" : "The scopes the access token grants the CDS Service",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.fhirAuthorization.scope",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.subject",
            "path" : "CDSHooksRequest.fhirAuthorization.subject",
            "short" : "Patient id for access",
            "definition" : "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" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.fhirAuthorization.subject",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.patient",
            "path" : "CDSHooksRequest.fhirAuthorization.patient",
            "short" : "OAuth 2.0 client identifier of the CDS Service",
            "definition" : "The OAuth 2.0 client identifier of the CDS Service, as registered with the CDS Client's authorization server",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.fhirAuthorization.patient",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "id"
              }
            ]
          },
          {
            "id" : "CDSHooksRequest.context",
            "extension" : [
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'appointment-book'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookAppointmentBookContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'encounter-start'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookEncounterStartContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'encounter-discharge'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookEncounterDischargeContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'patient-view'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookPatientViewContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'order-dispatch'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderDispatchContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'order-sign'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSignContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'order-select'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              }
            ],
            "path" : "CDSHooksRequest.context",
            "short" : "Context for decision support",
            "definition" : "Hook-specific contextual data that the CDS service will need",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.context",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "http://hl7.org/fhir/tools/StructureDefinition/CDSHookContext"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.prefetch",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-property-key",
                "valueCode" : "key"
              }
            ],
            "path" : "CDSHooksRequest.prefetch",
            "short" : "Prefetch info requested by server",
            "definition" : "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" : "While this is mustSupport, CRD clients are not required to pass any or all prefetch data requested by the CRD server.",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "CDSHooksRequest.prefetch",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Base"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.prefetch.key",
            "path" : "CDSHooksRequest.prefetch.key",
            "short" : "Key as specfied in server prefetch config",
            "definition" : "Name of the FHIR query/read from the CDS Hooks Services object provided by the server",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.prefetch.key",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.prefetch.value",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/json-nullable",
                "valueBoolean" : true
              },
              {
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/id-expectation",
                "valueCode" : "optional"
              }
            ],
            "path" : "CDSHooksRequest.prefetch.value",
            "short" : "Resource(s) matching prefetch criteria",
            "definition" : "What was found by executing the search or read requested by the CDS Hooks Service in the context of this particular hook invocation",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "CDSHooksRequest.prefetch.value",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Resource"
              }
            ],
            "mustSupport" : true
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "CDSHooksRequest",
            "path" : "CDSHooksRequest",
            "short" : "Request for decision support"
          },
          {
            "id" : "CDSHooksRequest.extension",
            "path" : "CDSHooksRequest.extension"
          },
          {
            "id" : "CDSHooksRequest.hook",
            "path" : "CDSHooksRequest.hook",
            "short" : "Hook event triggering call",
            "type" : [
              {
                "code" : "code"
              }
            ],
            "mustSupport" : true,
            "binding" : {
              "strength" : "required",
              "valueSet" : "http://hl7.org/fhir/us/davinci-crd/ValueSet/cdsHookType"
            }
          },
          {
            "id" : "CDSHooksRequest.hookInstance",
            "path" : "CDSHooksRequest.hookInstance",
            "short" : "Unique id for hook invocation",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirServer",
            "path" : "CDSHooksRequest.fhirServer",
            "short" : "Location to query for data",
            "min" : 1,
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization",
            "path" : "CDSHooksRequest.fhirAuthorization",
            "short" : "Auth to use in queries",
            "min" : 1,
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.accessToken",
            "path" : "CDSHooksRequest.fhirAuthorization.accessToken",
            "short" : "Auth token for query header",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.tokenType",
            "path" : "CDSHooksRequest.fhirAuthorization.tokenType",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.expiresIn",
            "path" : "CDSHooksRequest.fhirAuthorization.expiresIn",
            "short" : "Seconds token is valid",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.scope",
            "path" : "CDSHooksRequest.fhirAuthorization.scope",
            "short" : "Granted access scopes",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.fhirAuthorization.subject",
            "path" : "CDSHooksRequest.fhirAuthorization.subject",
            "short" : "Patient id for access",
            "definition" : "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" : true
          },
          {
            "id" : "CDSHooksRequest.context",
            "extension" : [
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'appointment-book'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookAppointmentBookContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'encounter-start'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterStartContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'encounter-discharge'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/tools/StructureDefinition/CDSEncounterDischargeContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'order-dispatch'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDOrderDispatchContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'order-select'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              },
              {
                "extension" : [
                  {
                    "url" : "condition",
                    "valueString" : "%resource.hook = 'order-sign'"
                  },
                  {
                    "url" : "type",
                    "valueCode" : "http://hl7.org/fhir/us/davnci-crd/StructureDefinition/CRDHookOrderSignContext"
                  }
                ],
                "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-specifier"
              }
            ],
            "path" : "CDSHooksRequest.context",
            "short" : "Context for decision support",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.prefetch",
            "path" : "CDSHooksRequest.prefetch",
            "short" : "Prefetch info requested by server",
            "comment" : "While this is mustSupport, CRD clients are not required to pass any or all prefetch data requested by the CRD server.",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.prefetch.key",
            "path" : "CDSHooksRequest.prefetch.key",
            "short" : "Key as specfied in server prefetch config",
            "mustSupport" : true
          },
          {
            "id" : "CDSHooksRequest.prefetch.value",
            "path" : "CDSHooksRequest.prefetch.value",
            "short" : "Resource(s) matching prefetch criteria",
            "mustSupport" : true
          }
        ]
      }
    }