This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.1.0: STU 2.1) 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
| Official URL: http://hl7.org/fhir/us/davinci-crd/CapabilityStatement/crd-client7.0 | Version: 2.1.0 | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: CRDClient7_0 | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.18.13.3 | ||||
This statement defines the expected capabilities of systems wishing to conform to the ''CRD Client'' role for USCDI 4 (US-Core 7.9.0). This role is responsible for initiating CDS Hooks calls and consuming received decision support. It is also responsible for returning data requested by the CRD Server needed to provide that decision support. This capability statement doesn't define the CDS Hooks capabilities as there is no standard way to do that as yet. Instead, it focuses on the 'server' capabilities needed to respond to CRD Server queries. These capabilities are based on US Core.
In addition to the U.S. core expectations, the CRD Client SHALL support all 'SHOULD' 'read' and 'search' capabilities listed below for resources referenced in supported hooks and order types if it does not support returning the associated resources as part of CDS Hooks pre-fetch. The CRD Client SHALL also support 'update' functionality for all resources listed below where the client allows invoking hooks based on the resource.
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement crd-client7.0
jsonNote 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 Server CapabilityStatementversion: null7.0.0)
serverA CRD Client provides a FHIR server endpoint, returning patient information to the CRD server, ensuring it has the needed information to perform decision support.
Implementations SHALL meet the general security requirements documented in the [[http://hl7.org/fhir/us/davinci-hrex/STU1/security.html|HRex implementation guide]].
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincludeupdateAllows annotating the appointment in response to a card. (Support is mandatory if the system supports Appointments)
updateAllows annotating the communication request in response to a card. (Support is mandatory if the system supports CommunicationRequests)
updateAllows annotating the device request in response to a card. (Support is mandatory if the system supports DeviceRequests.)
search-typeAllows retrieval of the encounter for a nutrition order (including referenced location) if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | organization | reference | Allows performing an _include on Location when retrieving an Encounter |
updateAllows annotating the medication request in response to a card. (Support is mandatory if the system supports MedicationRequests)
updateAllows annotating the nutrition order in response to a card. (Support is mandatory if the system supports NutritionOrders.)
updateAllows annotating the service requests in response to a card. (Support is mandatory if the system supports ServiceRequests.)
updateAllows annotating the vision prescription in response to a card. (Support is mandatory if the system supports VisionPrescriptions)
search-typeAllows retrieval of the patient's coverage information if it is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.) Note that only coverages relevant to the payer(s) associated with the requesting CRD Server are allowed to be returned.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | status | token | Allows filtering to only active coverages |
readAllows retrieval of the device requested in a DeviceRequest if it is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
readAllows retrieval of the location associated with an order or appointment if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
readAllows retrieval of ordering and/or performing organization's information if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
readAllows retrieval of the patient demographics if patient is not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
readAllows retrieval of ordering and/or performing provider's information if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
search-typeAllows retrieval of ordering and/or performing provider's (including associated Practitioners and Organizations) if not retrieved as part of pre-fetch. (Support is mandatory if not supported as part of pre-fetch.)
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | practitioner | reference | Allows performing an _include on Practitioner when retrieving a PractitionerRole |
createNeeded to allow support for cards returning deferrable cards and/or requests to complete Questionnaires.