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

## : SMART DTR Client

Page standards status: Trial-use | Maturity Level: 2

Raw json | Download

    {
      "resourceType" : "CapabilityStatement",
      "id" : "smart-dtr-client",
      "language" : "en",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement smart-dtr-client</b></p><a name=\"smart-dtr-client\"> </a><a name=\"hcsmart-dtr-client\"> </a><h2 id=\"title\">SMART on FHIR DTR Client</h2><ul><li>Implementation Guide Version: 2.2.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Published on: 2024-08-02 </li><li>Published by: HL7 International / Clinical Decision Support </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><p>This CapabilityStatement imports the CapabilityStatement <a href=\"http://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatementversion: 7.0.0)</a></p><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>A SMART on FHIR DTR Client provides an application conforming to the SMART on FHIR specification and related requirements declared in this Implementation Guide.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>caps-6^dtr-server,dtr-client^exchange: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>.caps-6^dtr-server,dtr-client^exchange: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>.extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "cds"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
          "valueInteger" : 2,
          "_valueInteger" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
              }
            ]
          }
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
          "valueCode" : "trial-use",
          "_valueCode" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr"
              }
            ]
          }
        }
      ],
      "url" : "http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client",
      "version" : "2.2.0",
      "name" : "DTRSmartClient",
      "title" : "SMART on FHIR DTR Client",
      "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 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.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US"
            }
          ]
        }
      ],
      "kind" : "requirements",
      "imports" : [
        🔗 "http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|7.0.0"
      ],
      "fhirVersion" : "4.0.1",
      "format" : [
        "json"
      ],
      "rest" : [
        {
          "mode" : "client",
          "documentation" : "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" : {
            "description" : "caps-6^dtr-server,dtr-client^exchange:Implementations **SHALL** meet the general security requirements documented in the [HRex implementation guide](https://build.fhir.org/ig/HL7/davinci-ehrx).caps-6^dtr-server,dtr-client^exchange:Implementations **SHALL** meet the general security requirements documented in the [HRex implementation guide](https://build.fhir.org/ig/HL7/davinci-ehrx).resource" : [
            {
              "type" : "QuestionnaireResponse",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-questionnaireresponse|2.2.0"
              ],
              "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/qr-context|2.2.0",
                  "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-encounter|2.2.1"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                }
              ]
            },
            {
              "type" : "DeviceRequest",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-devicerequest|2.2.1"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                }
              ]
            },
            {
              "type" : "MedicationRequest",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-medicationrequest|2.2.1"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                }
              ]
            },
            {
              "type" : "NutritionOrder",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-nutritionorder|2.2.1"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                }
              ]
            },
            {
              "type" : "CommunicationRequest",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-communicationrequest|2.2.1"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                }
              ]
            },
            {
              "type" : "ServiceRequest",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-servicerequest|2.2.1"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                }
              ]
            },
            {
              "type" : "VisionPrescription",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-visionprescription|2.2.1"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                }
              ]
            },
            {
              "type" : "Task",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-task|2.2.1"
              ],
              "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"
                }
              ]
            },
            {
              "type" : "Questionnaire",
              "operation" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "questionnaire-package",
                  "definition" : "http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/questionnaire-package|2.2.0"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "next-question",
                  "definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question|4.0.0"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "log-questionnaire-errors",
                  "definition" : "http://hl7.org/fhir/us/davinci-dtr/OperationDefinition/log-questionnaire-errors|2.2.0"
                }
              ]
            },
            {
              "type" : "ValueSet",
              "operation" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "expand",
                  "definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
                }
              ]
            }
          ]
        }
      ]
    }