Da Vinci - Documentation Templates and Rules
2.2.0-snapshot - STU 2.2 - Peer Review United States of America flag

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

Summary of System-wide Operations
ConformanceOperationDocumentation
SHALL$questionnaire-package
SHALL$expand
SHALL$next-question

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 TypeProfileRSUCSearches_include_revincludeOperations
QuestionnaireResponseSupported Profiles
  DTR Questionnaire Response		YYYYcontext, patient
EncounterSupported Profiles
  CRD Encounterversion: 2.1.0)		Y
DeviceRequestSupported Profiles
  CRD Device Requestversion: 2.1.0)		Y
MedicationRequestSupported Profiles
  CRD Medication Requestversion: 2.1.0)		Y
NutritionOrderSupported Profiles
  CRD Nutrition Orderversion: 2.1.0)		Y
CommunicationRequestSupported Profiles
  CRD Communication Requestversion: 2.1.0)		Y
ServiceRequestSupported Profiles
  CRD Service Requestversion: 2.1.0)		Y
VisionPrescriptionSupported Profiles
  CRD Vision Prescriptionversion: 2.1.0)		Y
TaskSupported Profiles
  PAS Task		YYY
Core FHIR Resource
QuestionnaireResponse
Reference Policy
Interaction summary
  • SHALL support read, create, update, search-type.

Supported Profiles

DTR Questionnaire Response

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcontextreference

Allows retrieving QuestionnaireResponse for a context

SHALLpatientreference

Allows retrieving QuestionnaireResponse for a patient

 
Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

CRD Encounterversion: 2.1.0)

Core FHIR Resource
DeviceRequest
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

CRD Device Requestversion: 2.1.0)

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

CRD Medication Requestversion: 2.1.0)

Core FHIR Resource
NutritionOrder
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

CRD Nutrition Orderversion: 2.1.0)

Core FHIR Resource
CommunicationRequest
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

CRD Communication Requestversion: 2.1.0)

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

CRD Service Requestversion: 2.1.0)

Core FHIR Resource
VisionPrescription
Reference Policy
Interaction summary
  • SHALL support read.

Supported Profiles

CRD Vision Prescriptionversion: 2.1.0)

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • SHALL support read, create, update.

Supported Profiles

PAS Task