Da Vinci - Coverage Requirements Discovery
2.0.1 - STU 2 United States of America flag

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: CRD Client

Official URL: http://hl7.org/fhir/us/davinci-crd/CapabilityStatement/crd-client Version: 2.0.1
Standards status: Trial-use Maturity Level: 2 Computable Name: CRDClient

This statement defines the expected capabilities of systems wishing to conform to the ‘‘CRD Client’’ role. 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

CRD Client

  • Implementation Guide Version: 2.0.1
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: Fri Nov 25 00:00:00 UTC 2022
  • 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.

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:
  CRD Appointment
y
CommunicationRequestSupported profiles:
  CRD Communication Request
y
CoverageSupported profiles:
  CRD Coverage
ypatient, status
DeviceSupported profiles:
  CRD Device
y
DeviceRequestSupported profiles:
  CRD Device Request
y
EncounterSupported profiles:
  CRD Encounter
yy_id, organizationEncounter:location
PatientSupported profiles:
  CRD Patient
y
PractitionerSupported profiles:
  CRD Practitioner
y
PractitionerRoleSupported profiles:
  US Core PractitionerRole Profile
y_id, organization, practitionerPractitionerRole:organization, PractitionerRole:practitioner
LocationSupported profiles:
  CRD Location
y
MedicationRequestSupported profiles:
  CRD Medication Request
y
NutritionOrderSupported profiles:
  CRD Nutrition Order
y
OrganizationSupported profiles:
  CRD Organization
y
ServiceRequestSupported profiles:
  CRD Service Request
y
ClaimResponseSupported profiles:
  HRex Prior authorization
y
TaskSupported profiles:
  CRD Questionnaire Task
y
VisionPrescriptionSupported profiles:
  CRD Vision Prescription
y

Resource Conformance: SHOULDAppointment

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

Resource Conformance: SHOULDCommunicationRequest

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

Resource Conformance: SHALLCoverage

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Allows retrieving coverages for the patient

SHALLstatustoken

Allows filtering to only active coverages

 

Resource Conformance: SHOULDDevice

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

Resource Conformance: SHOULDDeviceRequest

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

Resource Conformance: SHALLEncounter

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows searching for a Encounter by id

SHALLorganizationreference

Allows performing an _include on Location when retrieving an Encounter

 

Resource Conformance: SHOULDPatient

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

Resource Conformance: SHOULDPractitioner

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

Resource Conformance: SHALLPractitionerRole

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Allows searching for a PractitionerRole by id

SHALLorganizationreference

Allows performing an _include on Organization when retrieving a PractitionerRole

SHALLpractitionerreference

Allows performing an _include on Practitioner when retrieving a PractitionerRole

 

Resource Conformance: SHOULDLocation

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

Resource Conformance: SHOULDMedicationRequest

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

Resource Conformance: SHOULDNutritionOrder

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

Resource Conformance: SHOULDOrganization

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

Resource Conformance: SHOULDServiceRequest

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

Resource Conformance: SHOULDClaimResponse

Core FHIR Resource
ClaimResponse
Reference Policy
Interaction summary
  • SHOULD support create.

Resource Conformance: SHOULDTask

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

Resource Conformance: SHOULDVisionPrescription

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