Da Vinci - Documentation Templates and Rules
2.0.1 - STU 2 United States of America flag

This page is part of the Documentation Templates and Rules (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: DTR SMART Client

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

DTR SMART on FHIR Client

  • Official URL:http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/dtr-smart-client
  • Implementation Guide Version: 1.1.0-ci-build
  • FHIR Version: 4.0.1
  • Intended Use: Requirements
  • Supported Formats: JSON
  • Published: 2023-08-31
  • Published by: HL7 Clinical Decision Support Work Group
  • 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.

Include And Support Everything In The Following CapabilityStatements:

FHIR Client RESTful Capabilities

A DTR SMART on FHIR 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

RESTful Capabilities by Resource/Profile:

Summary

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

Resource TypeSupported InteractionsSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
Coverageread♦, create♦, update♦, search-type♦ Coverage context♦, patient♦
Encounterread♦ DeviceRequest
DeviceRequestread♦ DeviceRequest
MedicationRequestread♦ MedicationRequest
NutritionOrderread♦ NutritionOrder
CommunicationRequestread♦ CommunicationRequest
ServiceRequestread♦ ServiceRequest
VisionPrescriptionread♦ CRD Vision Prescription
Taskread♦, create♦, update♦

Coverage

Conformance Expectation:(conformance expectation undefined)

Supported Profiles:

Profile Interaction Summary:

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

Modify Criteria:

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

Fetch and Search Criteria:

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

Search Parameter Summary:

ConformanceParameterTypeExample
SHALLcontextreferenceGET [base]/Coverage?context=[type]/[id]
SHALLpatientreferenceGET [base]/Coverage?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

Conformance Expectation:(conformance expectation undefined)

Supported Profiles:

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

Conformance Expectation:(conformance expectation undefined)

Supported Profiles:

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

Conformance Expectation:(conformance expectation undefined)

Supported Profiles:

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

Conformance Expectation:(conformance expectation undefined)

Supported Profiles:

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

Conformance Expectation:(conformance expectation undefined)

Supported Profiles:

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

Conformance Expectation:(conformance expectation undefined)

Supported Profiles:

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

Conformance Expectation:(conformance expectation undefined)

Supported Profiles:

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

Conformance Expectation:(conformance expectation undefined)

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]