Da Vinci - Coverage Requirements Discovery
2.2.0-snapshot - STU 2.2 Peer Review 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.2.0-snapshot 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

2.2.0-snapshot
Official URL: http://hl7.org/fhir/us/davinci-crd/CapabilityStatement/crd-client6.1 Version:
Standards status: Trial-use Active as of 2022-11-25 Maturity Level: 4 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 the data requested by the CRD Server needed to provide that decision support. This capability statement does not define the CDS Hooks capabilities as there is no standard way to do that yet. Instead, it focuses on the 'server' capabilities needed to respond to CRD Server queries. These capabilities are based on US Core.

Raw OpenAPI-Swagger Definition file | Download

Language: en

CRD Client USCDI 3

  • Implementation Guide Version: 2.2.0-snapshot
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • 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: 6.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.2.0-snapshot/security.html|HRex implementation guide]].

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 with Order
  CRD Appointment without Order		y?
CommunicationRequestSupported Profiles
  CRD Communication Request		y?
DeviceRequestSupported Profiles
  CRD Device Request		y?
EncounterSupported Profiles
  CRD Encounter		Y
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		Y
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 Profileversion: 7.0.0)		Y
PractitionerRoleSupported Profiles
  HRex PractitionerRole Profile		Y
Core FHIR Resource
Appointment
Reference Policy
Interaction summary
  • MAY support
    update

    Allows annotating the appointment in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Appointment with Order
CRD Appointment without Order

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

    Allows annotating the communication request in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Communication Request

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

    Allows annotating the device request in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Device Request

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

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

    Allows annotating the medication request in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Medication Request

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

    Allows annotating the nutrition order in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Nutrition Order

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

    Allows annotating the service requests in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Service Request

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

    Allows annotating the vision prescription in response to a card. (CRD Clients SHALL support update requests received via supported system actions, but it is acceptable if clients opt to perform such updates via a mechanism other than their FHIR API.)

Supported Profiles

CRD Vision Prescription

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

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

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

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

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

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

Supported Profiles

US Core Practitioner Profileversion: 7.0.0)

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

Supported Profiles

HRex PractitionerRole Profile