Da Vinci - Coverage Requirements Discovery
2.1.0 - STU 2.1 United States of America flag

Da Vinci - Coverage Requirements Discovery, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-crd/ and changes regularly. See the Directory of published versions

CapabilityStatement: CRD Client USCDI 3

Official URL: http://hl7.org/fhir/us/davinci-crd/CapabilityStatement/crd-client6.1 Version: 2.1.0
Standards status: Trial-use Maturity Level: 3 Computable Name: CRDClient6_1
Other Identifiers: OID:2.16.840.1.113883.4.642.40.18.13.2

This statement defines the expected capabilities of systems wishing to conform to the ''CRD Client'' role for USCDI 3 (US-Core 6.1.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-client6.1

CRD Client USCDI 3

  • Implementation Guide Version: 2.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: 2022-11-25
  • Published by: HL7 International / Financial Management

Note 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: null6.1.0)

FHIR RESTful Capabilities

Mode: server

A CRD Client provides a FHIR server endpoint, returning patient information to the CRD server, ensuring it has the needed information to perform decision support.

Security

Implementations SHALL meet the general security requirements documented in the [[http://hl7.org/fhir/us/davinci-hrex/STU1/security.html|HRex implementation guide]].

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AppointmentSupported Profiles
  CRDAppointmentWithOrder
  CRDAppointmentNoOrder
y
CommunicationRequestSupported Profiles
  CRD Communication Request
y
DeviceRequestSupported Profiles
  CRD Device Request
y
EncounterSupported Profiles
  CRD Encounter
yorganizationEncounter:location
MedicationRequestSupported Profiles
  CRD Medication Request
y
NutritionOrderSupported Profiles
  CRD Nutrition Order
y
ServiceRequestSupported Profiles
  CRD Service Request
y
VisionPrescriptionSupported Profiles
  CRD Vision Prescription
y
CoverageSupported Profiles
  CRD Coverage
ystatus
DeviceSupported Profiles
  CRD Device
y
LocationSupported Profiles
  CRD Location
y
OrganizationSupported Profiles
  CRD Organization
y
PatientSupported Profiles
  CRD Patient
y
PractitionerSupported Profiles
  US Core Practitioner Profile
y
PractitionerRoleSupported Profiles
  HRex PractitionerRole Profile
ypractitionerPractitionerRole:organization, PractitionerRole:practitioner
TaskSupported Profiles
  CRD Questionnaire Task
y

Resource Conformance: SHOULD Appointment

Core FHIR Resource
Appointment
Reference Policy
Interaction summary
  • SHOULD support
    update

    Allows annotating the appointment in response to a card. (Support is mandatory if the system supports Appointments)

Resource Conformance: SHOULD CommunicationRequest

Core FHIR Resource
CommunicationRequest
Reference Policy
Interaction summary
  • SHOULD support
    update

    Allows annotating the communication request in response to a card. (Support is mandatory if the system supports CommunicationRequests)

Supported Profiles

CRD Communication Request

Resource Conformance: SHOULD DeviceRequest

Core FHIR Resource
DeviceRequest
Reference Policy
Interaction summary
  • SHOULD support
    update

    Allows annotating the device request in response to a card. (Support is mandatory if the system supports DeviceRequests.)

Supported Profiles

CRD Device Request

Resource Conformance: SHALL Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • SHOULD support
    search-type

    Allows 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.)

Supported Profiles

CRD Encounter

Search Parameters
ConformanceParameterTypeDocumentation
SHALLorganizationreference

Allows performing an _include on Location when retrieving an Encounter

 

Resource Conformance: SHOULD MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • SHOULD support
    update

    Allows annotating the medication request in response to a card. (Support is mandatory if the system supports MedicationRequests)

Supported Profiles

CRD Medication Request

Resource Conformance: SHOULD NutritionOrder

Core FHIR Resource
NutritionOrder
Reference Policy
Interaction summary
  • SHOULD support
    update

    Allows annotating the nutrition order in response to a card. (Support is mandatory if the system supports NutritionOrders.)

Supported Profiles

CRD Nutrition Order

Resource Conformance: SHOULD ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • SHOULD support
    update

    Allows annotating the service requests in response to a card. (Support is mandatory if the system supports ServiceRequests.)

Supported Profiles

CRD Service Request

Resource Conformance: SHOULD VisionPrescription

Core FHIR Resource
VisionPrescription
Reference Policy
Interaction summary
  • SHOULD support
    update

    Allows annotating the vision prescription in response to a card. (Support is mandatory if the system supports VisionPrescriptions)

Supported Profiles

CRD Vision Prescription

Resource Conformance: SHALL Coverage

Core FHIR Resource
Coverage
Reference Policy
Interaction summary
  • SHOULD support
    search-type

    Allows 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.

Supported Profiles

CRD Coverage

Search Parameters
ConformanceParameterTypeDocumentation
SHALLstatustoken

Allows filtering to only active coverages

 

Resource Conformance: SHOULD Device

Core FHIR Resource
Device
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows 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.)

Supported Profiles

CRD Device

Resource Conformance: SHOULD Location

Core FHIR Resource
Location
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows 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.)

Supported Profiles

CRD Location

Resource Conformance: SHOULD Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows 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.)

Supported Profiles

CRD Organization

Resource Conformance: SHOULD Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows 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.)

Supported Profiles

CRD Patient

Resource Conformance: SHOULD Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • SHOULD support
    read

    Allows 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.)

Resource Conformance: SHALL PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • SHOULD support
    search-type

    Allows 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.)

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpractitionerreference

Allows performing an _include on Practitioner when retrieving a PractitionerRole

 

Resource Conformance: SHOULD Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • SHOULD support
    create

    Needed to allow support for cards returning deferrable cards and/or requests to complete Questionnaires.

Supported Profiles

CRD Questionnaire Task