Da Vinci - Documentation Templates and Rules
2.2.0 - STU 2.2

Da Vinci - Documentation Templates and Rules, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-dtr/ and changes regularly. See the Directory of published versions

## CapabilityStatement: SMART DTR Client

Official URL: http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client | Version: 2.2.0 | Highlight text changes?
Standards status: Trial-use Active as of 2024-08-02 | Maturity Level: 2 | Computable Name: DTRSmartClient

This statement defines the expected capabilities of DTR SMART on FHIR applications. Such apps require client support for retrieving and editing QuestionnaireResponse resources and related resources, as well as client support for the Questionnaire Package, ValueSet Expand, and Next Question operations.

Raw OpenAPI-Swagger Definition file | Download

Language: en

## SMART on FHIR DTR Client

- Implementation Guide Version: 2.2.0
- FHIR Version: 4.0.1
- Supported Formats: `json`
- Published on: 2024-08-02
- Published by: HL7 International / Clinical Decision Support

> Note to Implementers: FHIR Capabilities

> 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.

This CapabilityStatement imports the CapabilityStatement US Core Client CapabilityStatementversion: 7.0.0)

## FHIR RESTful Capabilities

### Mode: `client`

A SMART on FHIR DTR Client provides an application conforming to the SMART on FHIR specification and related requirements declared in this Implementation Guide.

Security

> Implementations SHALL meet the general security requirements documented in the HRex implementation guide.

### Capabilities by Resource/Profile

#### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
QuestionnaireResponse | Supported Profiles DTR Questionnaire Responseversion: 2.2.0) | Y | Y | Y | Y | context, patient |  |  |
Encounter | Supported Profiles CRD Encounterversion: 2.2.1) | Y |  |  |  |  |  |  |
DeviceRequest | Supported Profiles CRD Device Requestversion: 2.2.1) | Y |  |  |  |  |  |  |
MedicationRequest | Supported Profiles CRD Medication Requestversion: 2.2.1) | Y |  |  |  |  |  |  |
NutritionOrder | Supported Profiles CRD Nutrition Orderversion: 2.2.1) | Y |  |  |  |  |  |  |
CommunicationRequest | Supported Profiles CRD Communication Requestversion: 2.2.1) | Y |  |  |  |  |  |  |
ServiceRequest | Supported Profiles CRD Service Requestversion: 2.2.1) | Y |  |  |  |  |  |  |
VisionPrescription | Supported Profiles CRD Vision Prescriptionversion: 2.2.1) | Y |  |  |  |  |  |  |
Task | Supported Profiles PAS Taskversion: 2.2.1) | Y |  | Y | Y |  |  |  |
Questionnaire |  |  |  |  |  |  |  |  | `$questionnaire-package`, `$next-question`, `$log-questionnaire-errors`
ValueSet |  |  |  |  |  |  |  |  | `$expand`

#### Resource Conformance: unspecifiedQuestionnaireResponse

Core FHIR Resource
QuestionnaireResponse
Reference Policy
Interaction summary

- SHALL support `read`, `create`, `update`, `search-type`.

Supported Profiles

DTR Questionnaire Responseversion: 2.2.0)

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | context | `reference` | Allows retrieving QuestionnaireResponse for a context
SHALL | patient | `reference` | Allows retrieving QuestionnaireResponse for a patient

#### Resource Conformance: unspecifiedEncounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary

- SHALL support `read`.

Supported Profiles

CRD Encounterversion: 2.2.1)

#### Resource Conformance: unspecifiedDeviceRequest

Core FHIR Resource
DeviceRequest
Reference Policy
Interaction summary

- SHALL support `read`.

Supported Profiles

CRD Device Requestversion: 2.2.1)

#### Resource Conformance: unspecifiedMedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary

- SHALL support `read`.

Supported Profiles

CRD Medication Requestversion: 2.2.1)

#### Resource Conformance: unspecifiedNutritionOrder

Core FHIR Resource
NutritionOrder
Reference Policy
Interaction summary

- SHALL support `read`.

Supported Profiles

CRD Nutrition Orderversion: 2.2.1)

#### Resource Conformance: unspecifiedCommunicationRequest

Core FHIR Resource
CommunicationRequest
Reference Policy
Interaction summary

- SHALL support `read`.

Supported Profiles

CRD Communication Requestversion: 2.2.1)

#### Resource Conformance: unspecifiedServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary

- SHALL support `read`.

Supported Profiles

CRD Service Requestversion: 2.2.1)

#### Resource Conformance: unspecifiedVisionPrescription

Core FHIR Resource
VisionPrescription
Reference Policy
Interaction summary

- SHALL support `read`.

Supported Profiles

CRD Vision Prescriptionversion: 2.2.1)

#### Resource Conformance: unspecifiedTask

Core FHIR Resource
Task
Reference Policy
Interaction summary

- SHALL support `read`, `create`, `update`.

Supported Profiles

PAS Taskversion: 2.2.1)

#### Resource Conformance: unspecifiedQuestionnaire

Core FHIR Resource
Questionnaire
Reference Policy
Interaction summary

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $questionnaire-package |
SHALL | $next-question |
SHALL | $log-questionnaire-errors |

#### Resource Conformance: unspecifiedValueSet

Core FHIR Resource
ValueSet
Reference Policy
Interaction summary

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $expand |