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 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-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
json
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.
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.
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
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
Appointment | Supported profiles: CRD Appointment | y | |||||||
CommunicationRequest | Supported profiles: CRD Communication Request | y | |||||||
Coverage | Supported profiles: CRD Coverage | y | patient, status | ||||||
Device | Supported profiles: CRD Device | y | |||||||
DeviceRequest | Supported profiles: CRD Device Request | y | |||||||
Encounter | Supported profiles: CRD Encounter | y | y | _id, organization | Encounter:location | ||||
Patient | Supported profiles: CRD Patient | y | |||||||
Practitioner | Supported profiles: CRD Practitioner | y | |||||||
PractitionerRole | Supported profiles: US Core PractitionerRole Profile | y | _id, organization, practitioner | PractitionerRole:organization , PractitionerRole:practitioner | |||||
Location | Supported profiles: CRD Location | y | |||||||
MedicationRequest | Supported profiles: CRD Medication Request | y | |||||||
NutritionOrder | Supported profiles: CRD Nutrition Order | y | |||||||
Organization | Supported profiles: CRD Organization | y | |||||||
ServiceRequest | Supported profiles: CRD Service Request | y | |||||||
ClaimResponse | Supported profiles: HRex Prior authorization | y | |||||||
Task | Supported profiles: CRD Questionnaire Task | y | |||||||
VisionPrescription | Supported profiles: CRD Vision Prescription | y |
http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-coverage
http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-device
http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-encounter
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Allows searching for a Encounter by id |
SHALL | organization | reference | Allows performing an _include on Location when retrieving an Encounter |
http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-patient
http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Allows searching for a PractitionerRole by id |
SHALL | organization | reference | Allows performing an _include on Organization when retrieving a PractitionerRole |
SHALL | practitioner | reference | Allows performing an _include on Practitioner when retrieving a PractitionerRole |
http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location