Da Vinci - Coverage Requirements Discovery
2.0.1 - STU 2
Da Vinci - Coverage Requirements Discovery
2.0.1 - STU 2
This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
{
"resourceType" : "CapabilityStatement",
"id" : "crd-client",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">CRD Client</h2><ul><li>Implementation Guide Version: 2.0.1</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: Fri Nov 25 00:00:00 UTC 2022</li><li>Published by: HL7 International / Financial Management</li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>A CRD Client provides a FHIR server endpoint, returning patient information to the CRD server, ensuring it has the needed information to perform decision support.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Implementations <strong>SHALL</strong> meet the general security requirements documented in the [[http://hl7.org/fhir/us/davinci-hrex/STU1/security.html|HRex implementation guide]].</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Appointment1-1\">Appointment</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-appointment.html\">CRD Appointment</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#CommunicationRequest1-2\">CommunicationRequest</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-communicationrequest.html\">CRD Communication Request</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Coverage1-3\">Coverage</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-coverage.html\">CRD Coverage</a></td><td></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>patient, status</td><td/><td/><td/></tr><tr><td><a href=\"#Device1-4\">Device</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-device.html\">CRD Device</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#DeviceRequest1-5\">DeviceRequest</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-devicerequest.html\">CRD Device Request</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Encounter1-6\">Encounter</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-encounter.html\">CRD Encounter</a></td><td></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td>_id, organization</td><td><code>Encounter:location</code></td><td/><td/></tr><tr><td><a href=\"#Patient1-7\">Patient</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-patient.html\">CRD Patient</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Practitioner1-8\">Practitioner</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-practitioner.html\">CRD Practitioner</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#PractitionerRole1-9\">PractitionerRole</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html\">US Core PractitionerRole Profile</a></td><td></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, organization, practitioner</td><td><code>PractitionerRole:organization</code>, <code>PractitionerRole:practitioner</code></td><td/><td/></tr><tr><td><a href=\"#Location1-10\">Location</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-location.html\">CRD Location</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#MedicationRequest1-11\">MedicationRequest</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-medicationrequest.html\">CRD Medication Request</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#NutritionOrder1-12\">NutritionOrder</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-nutritionorder.html\">CRD Nutrition Order</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Organization1-13\">Organization</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-organization.html\">CRD Organization</a></td><td>y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#ServiceRequest1-14\">ServiceRequest</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-servicerequest.html\">CRD Service Request</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr><tr><td><a href=\"#ClaimResponse1-15\">ClaimResponse</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"http://hl7.org/fhir/us/davinci-hrex/STU1/StructureDefinition-hrex-claimresponse.html\">HRex Prior authorization</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Task1-16\">Task</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-taskquestionnaire.html\">CRD Questionnaire Task</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#VisionPrescription1-17\">VisionPrescription</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-profile-visionprescription.html\">CRD Vision Prescription</a></td><td></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Appointment1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Appointment</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/appointment.html\">Appointment</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-appointment.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"CommunicationRequest1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>CommunicationRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/communicationrequest.html\">CommunicationRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-communicationrequest.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Coverage1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL</span>Coverage</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/coverage.html\">Coverage</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-coverage.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/coverage.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows retrieving coverages for the patient</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/coverage.html#search\">status</a></td><td><code>token</code></td><td><div><p>Allows filtering to only active coverages</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Device1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Device</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/device.html\">Device</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-device.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-device</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DeviceRequest1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>DeviceRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/devicerequest.html\">DeviceRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-devicerequest.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Encounter1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL</span>Encounter</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/encounter.html\">Encounter</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-encounter.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows searching for a Encounter by id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/encounter.html#search\">organization</a></td><td><code>reference</code></td><td><div><p>Allows performing an _include on Location when retrieving an Encounter</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-patient.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Practitioner1-8\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Practitioner</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/practitioner.html\">Practitioner</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-practitioner.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-practitioner</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"PractitionerRole1-9\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL</span>PractitionerRole</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/practitionerrole.html\">PractitionerRole</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html\">http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows searching for a PractitionerRole by id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/practitionerrole.html#search\">organization</a></td><td><code>reference</code></td><td><div><p>Allows performing an _include on Organization when retrieving a PractitionerRole</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/practitionerrole.html#search\">practitioner</a></td><td><code>reference</code></td><td><div><p>Allows performing an _include on Practitioner when retrieving a PractitionerRole</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Location1-10\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Location</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/location.html\">Location</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-location.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"MedicationRequest1-11\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>MedicationRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/medicationrequest.html\">MedicationRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-medicationrequest.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"NutritionOrder1-12\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>NutritionOrder</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/nutritionorder.html\">NutritionOrder</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-nutritionorder.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Organization1-13\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Organization</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/organization.html\">Organization</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-organization.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ServiceRequest1-14\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>ServiceRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/servicerequest.html\">ServiceRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-servicerequest.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ClaimResponse1-15\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>ClaimResponse</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/claimresponse.html\">ClaimResponse</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/davinci-hrex/STU1/StructureDefinition-hrex-claimresponse.html\">http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-claimresponse</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Task1-16\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>Task</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/task.html\">Task</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-taskquestionnaire.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-taskquestionnaire</a></p></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"VisionPrescription1-17\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD</span>VisionPrescription</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/visionprescription.html\">VisionPrescription</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <code>update</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-profile-visionprescription.html\">http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription</a></p></div></div><p/></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2,
"_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/CapabilityStatement/crd-client",
"version" : "2.0.1",
"name" : "CRDClient",
"title" : "CRD Client",
"status" : "active",
"experimental" : false,
"date" : "2022-11-25",
"publisher" : "HL7 International / Financial Management",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm"
}
]
}
],
"description" : "This statement defines the expected capabilities of systems wishing to conform to the ''CRD Client'' role. This role is responsible for initiating CDS Hooks calls and consuming received decision support. It is *also* responsible for returning data requested by the CRD Server needed to provide that decision support. This capability statement doesn't define the CDS Hooks capabilities as there is no standard way to do that as yet. Instead, it focuses on the 'server' capabilities needed to respond to CRD Server queries. These capabilities are based on US Core.\n\nIn addition to the U.S. core expectations, the CRD Client **SHALL** support all 'SHOULD' 'read' and 'search' capabilities listed below for resources referenced in supported hooks and order types if it does not support returning the associated resources as part of CDS Hooks pre-fetch. The CRD Client **SHALL** also support 'update' functionality for all resources listed below where the client allows invoking hooks based on the resource.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"kind" : "requirements",
"imports" : [
🔗 "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server"
],
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"rest" : [
{
"mode" : "server",
"documentation" : "A CRD Client provides a FHIR server endpoint, returning patient information to the CRD server, ensuring it has the needed information to perform decision support.",
"security" : {
"description" : "Implementations **SHALL** meet the general security requirements documented in the [[http://hl7.org/fhir/us/davinci-hrex/STU1/security.html|HRex implementation guide]]."
},
"resource" : [
{
"type" : "Appointment",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows annotating the appointment in response to a card. (Support is mandatory if the system supports Appointments)"
}
],
"versioning" : "versioned-update"
},
{
"type" : "CommunicationRequest",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows annotating the communication request in response to a card. (Support is mandatory if the system supports CommunicationRequests)"
}
],
"versioning" : "versioned-update"
},
{
"type" : "Coverage",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of the patient's coverage information if it is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.) Note that only coverages relevant to the payer(s) associated with the requesting CRD Server are allowed to be returned."
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-patient",
"type" : "reference",
"documentation" : "Allows retrieving coverages for the patient"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Coverage-status",
"type" : "token",
"documentation" : "Allows filtering to only active coverages"
}
]
},
{
"type" : "Device",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-device"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of the device requested in a DeviceRequest if it is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)"
}
]
},
{
"type" : "DeviceRequest",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows annotating the device request in response to a card. (Support is mandatory if the system supports DeviceRequests.)"
}
],
"versioning" : "versioned-update"
},
{
"type" : "Encounter",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows annotating the encounter in response to a card. (Support is mandatory if the system supports Encounters)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of the encounter for a nutrition order (including referenced location) if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)"
}
],
"versioning" : "versioned-update",
"searchInclude" : [
"Encounter:location"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows searching for a Encounter by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-location",
"type" : "reference",
"documentation" : "Allows performing an _include on Location when retrieving an Encounter"
}
]
},
{
"type" : "Patient",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of the patient demographics if patient is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)"
}
]
},
{
"type" : "Practitioner",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-practitioner"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of ordering and/or performing provider's information if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)"
}
]
},
{
"type" : "PractitionerRole",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows retrieval of ordering and/or performing provider's (including associated Practitioners and Organizations) if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)"
}
],
"searchInclude" : [
"PractitionerRole:organization",
"PractitionerRole:practitioner"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows searching for a PractitionerRole by id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "organization",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-organization",
"type" : "reference",
"documentation" : "Allows performing an _include on Organization when retrieving a PractitionerRole"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "practitioner",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner",
"type" : "reference",
"documentation" : "Allows performing an _include on Practitioner when retrieving a PractitionerRole"
}
]
},
{
"type" : "Location",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of the location associated with an order or appointment if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)"
}
]
},
{
"type" : "MedicationRequest",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows annotating the medication request in response to a card. (Support is mandatory if the system supports MedicationRequests)"
}
],
"versioning" : "versioned-update"
},
{
"type" : "NutritionOrder",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows annotating the nutrition order in response to a card. (Support is mandatory if the system supports NutritionOrders.)"
}
],
"versioning" : "versioned-update"
},
{
"type" : "Organization",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows retrieval of ordering and/or performing organization's information if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)"
}
]
},
{
"type" : "ServiceRequest",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows annotating the service requests in response to a card. (Support is mandatory if the system supports ServiceRequests.)"
}
],
"versioning" : "versioned-update"
},
{
"type" : "ClaimResponse",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-claimresponse"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Needed to allow support for cards returning preemptive determiniations."
}
]
},
{
"type" : "Task",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-taskquestionnaire"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Needed to allow support for cards returning deferrable cards and/or requests to complete Questionnaires."
}
]
},
{
"type" : "VisionPrescription",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows annotating the vision prescription in response to a card. (Support is mandatory if the system supports VisionPrescriptions)"
}
],
"versioning" : "versioned-update"
}
]
}
]
}
IG © 2019+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-crd#2.0.1 based on FHIR 4.0.1. Generated 2024-01-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change