Package | hl7.fhir.us.davinci-dtr |
Type | CapabilityStatement |
Id | smart-dtr-client |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/davinci-dtr/https://build.fhir.org/ig/HL7/davinci-dtr/CapabilityStatement-smart-dtr-client.html |
URL | http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client |
Version | 2.2.0-cibuild |
Status | active |
Date | 2024-08-02 |
Name | DTRSmartClient |
Title | SMART on FHIR DTR Client |
Realm | us |
Authority | hl7 |
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. |
Kind | requirements |
No resources found
CapabilityStatement | |
us-core-client | US Core Client CapabilityStatement |
OperationDefinition | |
Questionnaire-next-question | Adaptive Questionnaire - Next Question Operation |
questionnaire-package | Get Questionnaire Packge for given order(s) |
Questionnaire-next-question | Adaptive Questionnaire - Next Question Operation |
SearchParameter | |
qr-context | QRcontext |
StructureDefinition | |
profile-task | PAS Task |
profile-communicationrequest | CRD Communication Request |
profile-devicerequest | CRD Device Request |
profile-encounter | CRD Encounter |
profile-medicationrequest | CRD Medication Request |
profile-nutritionorder | CRD Nutrition Order |
profile-servicerequest | CRD Service Request |
profile-visionprescription | CRD Vision Prescription |
dtr-questionnaireresponse | DTR Questionnaire Response |
Note: links and images are rebased to the (stated) source
http://hl7.org/fhir/us/davinci-dtr/CapabilityStatement/smart-dtr-client
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.
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
$questionnaire-package
operation.$expand
operation.$next-question
operation.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 |
Supported Profiles:
Profile Interaction Summary:
read
, create
, update
, search-type
.Modify Criteria:
POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
Fetch and Search Criteria:
GET [base]/QuestionnaireResponse/[id]
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):
Supported Profiles:
Profile Interaction Summary:
read
.Fetch and Search Criteria:
GET [base]/Encounter/[id]
Supported Profiles:
Profile Interaction Summary:
read
.Fetch and Search Criteria:
GET [base]/DeviceRequest/[id]
Supported Profiles:
Profile Interaction Summary:
read
.Fetch and Search Criteria:
GET [base]/MedicationRequest/[id]
Supported Profiles:
Profile Interaction Summary:
read
.Fetch and Search Criteria:
GET [base]/NutritionOrder/[id]
Supported Profiles:
Profile Interaction Summary:
read
.Fetch and Search Criteria:
GET [base]/CommunicationRequest/[id]
Supported Profiles:
Profile Interaction Summary:
read
.Fetch and Search Criteria:
GET [base]/ServiceRequest/[id]
Supported Profiles:
Profile Interaction Summary:
read
.Fetch and Search Criteria:
GET [base]/VisionPrescription/[id]
Supported Profiles:
Profile Interaction Summary:
read
, create
, update
.Modify Criteria:
POST [base]/Task/[id]{?_format=[mime-type]}
PUT [base]/Task/[id]{?_format=[mime-type]}
Fetch and Search Criteria:
GET [base]/Task/[id]
{ "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" } ] } ] }