FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/smart-dtr-client

Packagehl7.fhir.us.davinci-dtr
TypeCapabilityStatement
Idsmart-dtr-client
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/davinci-dtr/https://build.fhir.org/ig/HL7/davinci-dtr/CapabilityStatement-smart-dtr-client.html
URLhttp://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client
Version2.2.0-cibuild
Statusactive
Date2024-08-02
NameDTRSmartClient
TitleSMART on FHIR DTR Client
Realmus
Authorityhl7
DescriptionThis 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.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

CapabilityStatement
us-core-clientUS Core Client CapabilityStatement
OperationDefinition
Questionnaire-next-questionAdaptive Questionnaire - Next Question Operation
questionnaire-packageGet Questionnaire Packge for given order(s)
Questionnaire-next-questionAdaptive Questionnaire - Next Question Operation
SearchParameter
qr-contextQRcontext
StructureDefinition
profile-taskPAS Task
profile-communicationrequestCRD Communication Request
profile-devicerequestCRD Device Request
profile-encounterCRD Encounter
profile-medicationrequestCRD Medication Request
profile-nutritionorderCRD Nutrition Order
profile-servicerequestCRD Service Request
profile-visionprescriptionCRD Vision Prescription
dtr-questionnaireresponseDTR Questionnaire Response

Narrative

Note: links and images are rebased to the (stated) source

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

RESTful Capabilities by Resource/Profile:

Summary

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

Resource TypeSupported InteractionsSupported ProfilesSupported SearchesSupported _includesSupported _revincludesSupported Operations
QuestionnaireResponseread, create, update, search-type DTR Questionnaire Response context, patient
Encounterread CRD Encounter
DeviceRequestread CRD Device Request
MedicationRequestread CRD Medication Request
NutritionOrderread CRD Nutrition Order
CommunicationRequestread CRD Communication Request
ServiceRequestread CRD Service Request
VisionPrescriptionread CRD Vision Prescription
Taskread, create, update PAS Task Profile

QuestionnaireResponse

Supported Profiles:

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:

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

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:

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:

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:

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:

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:

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:

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:

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]

Source

{
  "resourceType": "CapabilityStatement",
  "id": "smart-dtr-client",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client",
  "version": "2.2.0-cibuild",
  "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": "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"
          ],
          "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",
              "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.1.0"
          ],
          "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.1.0"
          ],
          "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.1.0"
          ],
          "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.1.0"
          ],
          "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.1.0"
          ],
          "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.1.0"
          ],
          "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.1.0"
          ],
          "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"
          ],
          "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"
            }
          ]
        }
      ],
      "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"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "name": "expand",
          "definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
        },
        {
          "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"
        }
      ]
    }
  ]
}