Da Vinci - Documentation Templates and Rules
2.1.0 - STU 2.1

Publication Build: This will be filled in by the publication tooling

## CapabilityStatement: SMART DTR Client

Official URL: http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client | Version: 2.1.0
Standards status: Trial-use | 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

## SMART on FHIR DTR Client

- Official URL:`http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client`
- Implementation Guide Version: 2.1.0-preview
- FHIR Version: 4.0.1
- Intended Use: Requirements
- Supported Formats: JSON
- Published: 2024-08-02
- Published by: HL7 International / Clinical Decision Support
- Status: Active

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.

### FHIR Client RESTful Capabilities

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.

Summary of Client Wide Operations

- SHALL support the `$questionnaire-package` operation.
- SHALL support the `$expand` operation.
- SHALL support the `$next-question` operation.

### RESTful Capabilities by Resource/Profile:

Summary

♦ = SHALL expectation;⋄ = SHOULD expectation;▿ = MAY expectation;

Resource Type | Supported Interactions | Supported Profiles | Supported Searches | Supported `_includes` | Supported `_revincludes` | Supported Operations
--- | --- | --- | --- | --- | --- | ---
QuestionnaireResponse | read♦, create♦, update♦, search-type♦ | DTR Questionnaire Response | context♦, patient♦ |  |  |
Encounter | read♦ | CRD Encounter |  |  |  |
DeviceRequest | read♦ | CRD Device Request |  |  |  |
MedicationRequest | read♦ | CRD Medication Request |  |  |  |
NutritionOrder | read♦ | CRD Nutrition Order |  |  |  |
CommunicationRequest | read♦ | CRD Communication Request |  |  |  |
ServiceRequest | read♦ | CRD Service Request |  |  |  |
VisionPrescription | read♦ | CRD Vision Prescription |  |  |  |
Task | read♦, create♦, update♦ | PAS Task Profile |  |  |  |

#### QuestionnaireResponse

Supported Profiles:

- DTR Questionnaire Response

Profile Interaction Summary:

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

Modify Criteria:

- A Client SHALL be capable of posting a QuestionnaireResponse resource using:`POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}`
- A Client SHALL be capable of putting an existing QuestionnaireResponse resource using:`PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}`

Fetch and Search Criteria:

- A Client SHALL be capable of fetching a QuestionnaireResponse resource using:`GET [base]/QuestionnaireResponse/[id]`
- A Client SHALL be capable of fetching resources matching a search query using:`GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}`

Search Parameter Summary:

Conformance | Parameter | Type | Example
--- | --- | --- | ---
SHALL | context | reference | `GET [base]/QuestionnaireResponse?context=[type]/[id]`
SHALL | patient | reference | `GET [base]/QuestionnaireResponse?patient=[type]/[id]`

Search Parameter Requirements (When Used Alone or in Combination):

- context (reference):

  Allows retrieving QuestionnaireResponse for a context

- patient (reference):

  Allows retrieving QuestionnaireResponse for a patient

#### Encounter

Supported Profiles:

- CRD Encounter

Profile Interaction Summary:

- SHALL support `read`.

Fetch and Search Criteria:

- A Client SHALL be capable of fetching an Encounter resource using:`GET [base]/Encounter/[id]`

#### DeviceRequest

Supported Profiles:

- CRD Device Request

Profile Interaction Summary:

- SHALL support `read`.

Fetch and Search Criteria:

- A Client SHALL be capable of fetching a DeviceRequest resource using:`GET [base]/DeviceRequest/[id]`

#### MedicationRequest

Supported Profiles:

- CRD Medication Request

Profile Interaction Summary:

- SHALL support `read`.

Fetch and Search Criteria:

- A Client SHALL be capable of fetching a MedicationRequest resource using:`GET [base]/MedicationRequest/[id]`

#### NutritionOrder

Supported Profiles:

- CRD Nutrition Order

Profile Interaction Summary:

- SHALL support `read`.

Fetch and Search Criteria:

- A Client SHALL be capable of fetching a NutritionOrder resource using:`GET [base]/NutritionOrder/[id]`

#### CommunicationRequest

Supported Profiles:

- CRD Communication Request

Profile Interaction Summary:

- SHALL support `read`.

Fetch and Search Criteria:

- A Client SHALL be capable of fetching a CommunicationRequest resource using:`GET [base]/CommunicationRequest/[id]`

#### ServiceRequest

Supported Profiles:

- CRD Service Request

Profile Interaction Summary:

- SHALL support `read`.

Fetch and Search Criteria:

- A Client SHALL be capable of fetching a ServiceRequest resource using:`GET [base]/ServiceRequest/[id]`

#### VisionPrescription

Supported Profiles:

- CRD Vision Prescription

Profile Interaction Summary:

- SHALL support `read`.

Fetch and Search Criteria:

- A Client SHALL be capable of fetching a VisionPrescription resource using:`GET [base]/VisionPrescription/[id]`

#### Task

Supported Profiles:

- PAS Task Profile

Profile Interaction Summary:

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

Modify Criteria:

- A Client SHALL be capable of posting a Task resource using:`POST [base]/Task/[id]{?_format=[mime-type]}`
- A Client SHALL be capable of putting an existing Task resource using:`PUT [base]/Task/[id]{?_format=[mime-type]}`

Fetch and Search Criteria:

- A Client SHALL be capable of fetching a Task resource using:`GET [base]/Task/[id]`