Da Vinci - Documentation Templates and Rules
2.1.0-preview - STU 2
Da Vinci - Documentation Templates and Rules
2.1.0-preview - STU 2
This page is part of the Documentation Templates and Rules (v2.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 2 |
{
"resourceType" : "CapabilityStatement",
"id" : "light-dtr-ehr-610",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">Light DTR EHR</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/light-dtr-ehr-610</code></li><li><b>Implementation Guide Version:</b> 2.1.0-preview</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats: </b>JSON</li><li><b>Published:</b> 2024-08-02</li><li><b>Published by:</b> HL7 International / Clinical Decision Support</li><li><b>Status:</b> Active</li></ul><p>This statement defines the expected capabilities of EHRs that rely on a SMART on FHIR application for USCDI 3 (US-Core 6.1) to handle the form filling function of DTR. This requires the server to provide access to the specified resources to allow such an app to retrieve and edit QuestionnaireResponses and related resources.</p> <!-- Imports --><h3 id=\"should_css\" class=\"no_toc\">Include And Support Everything In The Following CapabilityStatements:</h3><ul><li><a href=\"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server|6.1.0\">US Core Server CapabilityStatement</a></li></ul> <!-- REST Behavior --><h3 id=\"behavior\">FHIR Server RESTful Capabilities</h3><p>EHR systems which leverage a SMART app to manage data capture and rules execution, but which must be able to launch the SMART app.</p><p id=\"security\"><strong>Security:</strong></p><p>Implementations <strong>SHALL</strong> meet the general security requirements documented in the <a href=\"https://build.fhir.org/ig/HL7/davinci-ehrx\">HRex implementation guide</a>.</p><h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary</strong></p><p><i>♦ = <b>SHALL</b> expectation</i>;<i>⋄ = <b>SHOULD</b> expectation</i>;<i>▿ = <b>MAY</b> expectation</i>;</p><table class=\"grid\"><thead><tr><th>Resource Type</th><th>Supported Interactions</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href=\"#questionnaireresponse\"><span style=\"white-space: nowrap;\">QuestionnaireResponse</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHALL\"><sup>♦</sup></span></span>, <span style=\"white-space: nowrap;\">create<span title=\"SHALL\"><sup>♦</sup></span></span>, <span style=\"white-space: nowrap;\">update<span title=\"SHALL\"><sup>♦</sup></span></span>, <span style=\"white-space: nowrap;\">search-type<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported Profiles --><td><a href=\"StructureDefinition-dtr-questionnaireresponse.html\">DTR Questionnaire Response</a></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td><span style=\"white-space: nowrap;\">context<span title=\"SHALL\"><sup>♦</sup></span></span>, <span style=\"white-space: nowrap;\">patient<span title=\"SHALL\"><sup>♦</sup></span></span></td> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#encounter\"><span style=\"white-space: nowrap;\">Encounter</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><a href=\"https://build.fhir.org/ig/HL7/davinci-crd/StructureDefinition-profile-encounter6.1.html\">CRD Encounter - USCDI 3</a></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#devicerequest\"><span style=\"white-space: nowrap;\">DeviceRequest</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest\">CRD Device Request</a></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#medicationrequest\"><span style=\"white-space: nowrap;\">MedicationRequest</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest\">CRD Medication Request</a></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#nutritionorder\"><span style=\"white-space: nowrap;\">NutritionOrder</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder\">CRD Nutrition Order</a></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#communicationrequest\"><span style=\"white-space: nowrap;\">CommunicationRequest</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest\">CRD Communication Request</a></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#servicerequest\"><span style=\"white-space: nowrap;\">ServiceRequest</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest\">CRD Service Request</a></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#visionprescription\"><span style=\"white-space: nowrap;\">VisionPrescription</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription\">CRD Vision Prescription</a></td> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr><tr><td><a href=\"#task\"><span style=\"white-space: nowrap;\">Task</span></a></td><td><span style=\"white-space: nowrap;\">read<span title=\"SHOULD\"><sup>⋄</sup></span></span>, <span style=\"white-space: nowrap;\">create<span title=\"SHOULD\"><sup>⋄</sup></span></span>, <span style=\"white-space: nowrap;\">update<span title=\"SHOULD\"><sup>⋄</sup></span></span></td> <!-- Supported Profiles --><td/> <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out --><td/> <!-- Supported _includes --><td/> <!-- Supported _revincludes --><td> <!-- --></td> <!-- Supported Operations --><td/></tr></tbody></table> <!-- Resource Details --><h4 id=\"questionnaireresponse\" class=\"no_toc\">QuestionnaireResponse</h4><p>Supported Profiles:</p><ul><li><a href=\"StructureDefinition-dtr-questionnaireresponse.html\">DTR Questionnaire Response</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul><p>Modify Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of creating a QuestionnaireResponse resource using:<code class=\"highlighter-rouge\">POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code></li><li>A Server <strong>SHALL</strong> be capable of updating an existing QuestionnaireResponse resource using:<code class=\"highlighter-rouge\">PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code></li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHALL</strong> be capable of returning a QuestionnaireResponse resource using:<code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]</code></li><li>A Server <strong>SHALL</strong> be capable of returning resources matching a search query using:<code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}</code></li></ul> <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th style=\"white-space: nowrap;\">Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/questionnaireresponse.html#search\">context</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?context=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/questionnaireresponse.html#search\">patient</a></td><td>reference</td><td><code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse?patient=[type]/[id]</code></td></tr></tbody></table><div><p>Search Parameter Requirements (When Used Alone or in Combination):</p><ul><li><a href=\"http://hl7.org/fhir/R4/questionnaireresponse.html#search\">context</a> (reference):<p>Allows retrieving QuestionnaireResponse for a context</p></li><li><a href=\"http://hl7.org/fhir/R4/questionnaireresponse.html#search\">patient</a> (reference):<p>Allows retrieving QuestionnaireResponse for a patient</p></li></ul></div><h4 id=\"encounter\" class=\"no_toc\">Encounter</h4><p>Supported Profiles:</p><ul><li><a href=\"https://build.fhir.org/ig/HL7/davinci-crd/StructureDefinition-profile-encounter6.1.html\">CRD Encounter - USCDI 3</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning an Encounter resource using:<code class=\"highlighter-rouge\">GET [base]/Encounter/[id]</code></li></ul><h4 id=\"devicerequest\" class=\"no_toc\">DeviceRequest</h4><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest\">CRD Device Request</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning a DeviceRequest resource using:<code class=\"highlighter-rouge\">GET [base]/DeviceRequest/[id]</code></li></ul><h4 id=\"medicationrequest\" class=\"no_toc\">MedicationRequest</h4><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest\">CRD Medication Request</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning a MedicationRequest resource using:<code class=\"highlighter-rouge\">GET [base]/MedicationRequest/[id]</code></li></ul><h4 id=\"nutritionorder\" class=\"no_toc\">NutritionOrder</h4><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder\">CRD Nutrition Order</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning a NutritionOrder resource using:<code class=\"highlighter-rouge\">GET [base]/NutritionOrder/[id]</code></li></ul><h4 id=\"communicationrequest\" class=\"no_toc\">CommunicationRequest</h4><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest\">CRD Communication Request</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning a CommunicationRequest resource using:<code class=\"highlighter-rouge\">GET [base]/CommunicationRequest/[id]</code></li></ul><h4 id=\"servicerequest\" class=\"no_toc\">ServiceRequest</h4><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest\">CRD Service Request</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning a ServiceRequest resource using:<code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]</code></li></ul><h4 id=\"visionprescription\" class=\"no_toc\">VisionPrescription</h4><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription\">CRD Vision Prescription</a></li></ul><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning a VisionPrescription resource using:<code class=\"highlighter-rouge\">GET [base]/VisionPrescription/[id]</code></li></ul><h4 id=\"task\" class=\"no_toc\">Task</h4><p>Profile Interaction Summary:</p><ul><li><strong>SHOULD</strong> support <code>read</code>, <code>create</code>, <code>update</code>.</li></ul><p>Modify Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of creating a Task resource using:<code class=\"highlighter-rouge\">POST [base]/Task/[id]{?_format=[mime-type]}</code></li><li>A Server <strong>SHOULD</strong> be capable of updating an existing Task resource using:<code class=\"highlighter-rouge\">PUT [base]/Task/[id]{?_format=[mime-type]}</code></li></ul><p>Fetch and Search Criteria:</p><ul><li>A Server <strong>SHOULD</strong> be capable of returning a Task resource using:<code class=\"highlighter-rouge\">GET [base]/Task/[id]</code></li></ul></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "cds"
}
],
"url" : "http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/light-dtr-ehr-610",
"version" : "2.1.0-preview",
"name" : "LightDTREHR",
"title" : "Light DTR EHR",
"status" : "active",
"experimental" : false,
"date" : "2024-08-02",
"publisher" : "HL7 International / Clinical Decision Support",
"contact" : [
{
"name" : "HL7 International / Clinical Decision Support",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/dss"
}
]
}
],
"description" : "This statement defines the expected capabilities of EHRs that rely on a SMART on FHIR application for USCDI 3 (US-Core 6.1) to handle the form filling function of DTR. This requires the server to provide access to the specified resources to allow such an app to retrieve and edit QuestionnaireResponses and related resources.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"kind" : "requirements",
"imports" : [
🔗 "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server|6.1.0"
],
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"rest" : [
{
"mode" : "server",
"documentation" : "EHR systems which leverage a SMART app to manage data capture and rules execution, but which must be able to launch the SMART app.",
"security" : {
"description" : "Implementations **SHALL** meet the general security requirements documented in the <a href=\"https://build.fhir.org/ig/HL7/davinci-ehrx\">HRex implementation guide</a>."
},
"resource" : [
{
"type" : "QuestionnaireResponse",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaireresponse"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "context",
"definition" : "http://hl7.org/fhir/us/davinci-dtr/SearchParameter/dtr-context",
"type" : "reference",
"documentation" : "Allows retrieving QuestionnaireResponse for a context"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"type" : "reference",
"documentation" : "Allows retrieving QuestionnaireResponse for a patient"
}
]
},
{
"type" : "Encounter",
"supportedProfile" : [
🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter6.1"
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
}
]
},
{
"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" : "read"
}
]
},
{
"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" : "read"
}
]
},
{
"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" : "read"
}
]
},
{
"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" : "read"
}
]
},
{
"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" : "read"
}
]
},
{
"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" : "read"
}
]
},
{
"type" : "Task",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update"
}
]
}
]
}
]
}
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.us.davinci-dtr#2.1.0-preview based on FHIR 4.0.1. Generated 2024-09-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change