This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.2.0-ballot: STU 2.2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.1.0. For a full list of available versions, see the Directory of published versions
Page standards status: Informative |
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
There are no Global profiles defined
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
CRD Client USCDI 1 |
This statement defines the expected capabilities of systems wishing to conform to the ''CRD Client'' role for USCDI 1 (US Core 3.1.1). 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 doesn't 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. 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. |
CRD Client USCDI 3 |
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 doesn't 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. 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. |
CRD Client USCDI 4 |
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 the 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 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. |
CRD Server USCDI 1, 3, 4 |
This statement defines the expected capabilities of systems wishing to conform to the ''CRD Server'' role for USCDI 1 (US-Core 3.1.1), USCDI 3 (US-Core 6.1.0), and USCDI 4 (US-Core 7.0.0). This role is responsible for responding to CDS Hooks calls and responding with appropriate decision support. Much of its interactions will be with payer back-end systems over non-FHIR protocols. This CapabilityStatement does not describe these 'server <-> payer' interactions. Instead, it focuses on the ability of the CRD service to interact with the CRD client's FHIR endpoint to retrieve additional data. All such interactions are optional, as their necessity is dependent on what types of information is needed to support payer rules, the types of coverage the payer offers, and the degree of sophistication of the decision support offered by the CRD server. All resources and search parameters supported by US Core are fair game, though the 3.1.1, 6.1.0, and 7.0.0 clients might vary in which resources they support. |
These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.
CRD CDS Hooks Specific Context for appointment-book (Logical Definition) |
CRD-specific constraints on the appointment-book CDS Hook context |
CRD CDS Hooks Specific Context for order-dispatch (Logical Definition) |
CRD-specific constraints on the order-dispatch CDS Hook context |
CRD CDS Hooks Specific Context for order-select (Logical Definition) |
CRD-specific constraints on the order-select CDS Hook context |
CRD CDS Hooks Specific Context for order-sign (Logical Definition) |
CRD-specific constraints on the order-sign CDS Hook context |
CRD CDSHooks Additional Orders Response (Logical Definition) |
Defines CRD-specific constraints for the Additional Orders response type |
CRD CDSHooks Adjust Coverage Response (Logical Definition) |
Defines CRD-specific constraints for the Adjust Coverage response type |
CRD CDSHooks Alternate Request Response (Logical Definition) |
Defines CRD-specific constraints for the Alternate Request response type |
CRD CDSHooks Base for Response (Logical Definition) |
Defines common rules for all CRD-specific constraints on the CDS Hooks Response body |
CRD CDSHooks Coverage Information Response (Logical Definition) |
Defines CRD-specific constraints for the Coverage Information response type |
CRD CDSHooks External Reference Response (Logical Definition) |
Defines CRD-specific constraints for the External Reference response type |
CRD CDSHooks Form Completion Response (Logical Definition) |
Defines CRD-specific constraints for the Form Completion response type |
CRD CDSHooks Instructions Response (Logical Definition) |
Defines CRD-specific constraints for the Instructions response type |
CRD CDSHooks Request (Logical Definition) |
Defines CRD-specific constraints on the CDS Hooks Request logical model |
CRD CDSHooks Response (Logical Definition) |
Defines CRD-specific constraints on the CDS Hooks Response body |
CRD CDSHooks SMART App Response (Logical Definition) |
Defines CRD-specific constraints for the SMART App Launch response type |
CRD Metric Data |
A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD implementation |
These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles but do not declare conformance to the abstract profiles themselves.
CRD Base Appointment |
This profile specifies extensions and constraints on the Appointment resource to support coverage requirements discovery. |
CRD Base Bundle |
This profile defines the common requirements for all CRD Bundles used as input to CDS Hooks calls. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
CRD Appointment with Order |
An appointment where the details of what the appointment is being booked for are provided in the associated ServiceRequest |
CRD Appointment without Order |
An appointment where the details of what the appointment is being booked for are provided inline and there is no associated ServiceRequest |
CRD Bundle of Appointments |
This profile defines the Bundle used for the appointment-book hook, expressing mustSupport for the CRD Appointment profile. |
CRD Bundle of Dispatch Tasks |
This profile defines the Bundle used for the order-dispatch hook to convey the Tasks with the dispatching information. |
CRD Bundle of Request Resources |
This profile defines the Bundle used to convey the relevant orders for the order-select, order-sign, and order-dispatch hooks. |
CRD Communication Request |
This profile specifies constraints on the CommunicationRequest resource to support coverage requirements discovery. |
CRD Coverage |
This profile specifies constraints on the Coverage resource to support coverage requirements discovery. |
CRD Device |
This profile specifies additional constraints on the US Core Device Profile to support coverage requirements discovery. |
CRD Device Request |
This profile specifies extensions and constraints on the DeviceRequest resource to support coverage requirements discovery. |
CRD Dispatch Task |
This profile specifies constraints on the Task resource to capture details of dispatching a request to a particular performer. |
CRD Encounter |
This profile specifies additional extensions and constraints on the US Core Encounter profile to support coverage requirements discovery. |
CRD Location |
This profile specifies constraints on the US Core Location profile to support coverage requirements discovery. |
CRD Medication |
This profile specifies additional constraints on the US Core Medication Profile to support coverage requirements discovery. |
CRD Medication Request |
This profile specifies additional constraints on the US Core MedicationRequest profile to support coverage requirements discovery. |
CRD Nutrition Order |
This profile specifies extensions and constraints on the NutritionOrder resource to support coverage requirements discovery. |
CRD Organization |
This profile specifies additional constraints on the US Core Organization profile to support coverage requirements discovery. |
CRD Patient |
This profile specifies additional constraints on the US Core Patient profile to support coverage requirements discovery. |
CRD Questionnaire Task |
This profile specifies constraints on the Task resource to support requests for form (Questionnaire) completion. |
CRD Service Request |
This profile specifies constraints on the ServiceRequest resource to support coverage requirements discovery. |
CRD Vision Prescription |
This profile defines an initial profile on the VisionPrescription resource to support coverage requirements discovery. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
Billing Options |
Identifies billing codes that could potentially be used for this clinical code |
Coverage Information |
Captures assertions from a payer about the coverage rules for a service - in particular, whether it is covered and/or requires prior authorization. |
Models that define extensions on CDS Hooks JSON structures
CDS Hooks Service Request Configuration Extension |
Allows passing configuration parameters when invoking a card |
CDS Hooks Service Response Associated Resource Extension |
Indicates a request resource that is one of those that drove the creation of the card |
CDS Hooks Service Response If-None-Exist Extension |
Indicates a value to assert as an if-none-exist header on a create or update action |
CDS Hooks Services Configuration Extension |
An extension for the CDS Hooks 'services' object that indicates configuration options supported by the CDS server |
These define sets of codes used by systems conforming to this implementation guide.
CDS Hook Types Value Set |
Codes identifying a type of CDS Hook |
CDS Hooks Card Suggestion Action Types Value Set |
Codes allowed for defining the type of action in a CDS Hooks suggestion |
CMS Location Codes Value Set |
Numeric codes defined by CMS to identify types of locations |
CMS Mappable Location Codes Value Set |
Extends the base HL7-defined value set codes with supplementary codes needed to provide full coverage to the CMS location code set |
CRD Billing Codes Value Set |
Codes appropriate for inclusion in a claim or prior authorization |
CRD Card Types Value Set |
List of card types defined by the CRD spec |
CRD Configuration Code Data Types Value Set |
Allowed data types for configuration settings in the CDS Hooks configuration extension |
CRD Coverage Assertion Reasons Value Set |
Reasons for a coverage assertion in the coverage-information extension |
CRD Coverage Classes Value Set |
Restriction of coverage classes for CRD purposes |
CRD Coverage Detail Categories Value Set |
Codes that define the type of coverage information detail being provided |
CRD Coverage Detail Codes Value Set |
Codes for name-value-pair details on a coverage assertion |
CRD Coverage Information Additional Documentation Value Set |
Codes defining whether additional documentation needs to be captured |
CRD Coverage Information Covered Value Set |
Codes defining whether the ordered/requested service is covered under patient's plan |
CRD Coverage Information Documentation Reason Value Set |
List of reasons for additional documentation |
CRD Coverage Information Prior Authorization Value Set |
Codes defining whether prior auth will be needed for coverage to be provided |
CRD Device Request Codes Value Set |
Codes for ordering devices. NOTE: This value set contains many inappropriate codes because the underlying code systems do not provide a straight-forward mechanism to select only device-related codes and, given the evolving nature of the underlying code systems, strict enumeration is not a viable approach to defining the value set. |
CRD Information Needed Value Set |
Codes defining whether information about the performer, location, and/or performance date is needed to determine coverage information |
CRD Location Address Types Value Set |
Address codes allowed for CRD locations - those that are physical addresses |
CRD Metric Data Source Value Set |
A list of codes indicating the perspective from which metric data was captured |
CRD Metric Token Use Value Set |
A list of codes indicating whether an access token was used as part of CDS Hooks processing |
CRD Order Detail Codes Value Set |
Detail codes for products and services that are the focus of a CRD call |
CRD Service Request Codes Value Set |
Example value set defines a set of CPT, SNOMED CT, HCPCS Level II and LOINC codes mirroring bindings found in the US Core Procedure and Observation Lab profiles |
These define new code systems used by systems conforming to this implementation guide.
CRD Metric Codes |
Codes used within 'code' elements in the CRD Metric logical model. |
CRD Temporary Codes |
Codes temporarily defined as part of the CRD implementation guide. These will eventually migrate into an officially maintained terminology (likely either SNOMED CT or HL7's UTG code systems). |
Coverage Information Codes |
Codes used by 'code' elements within the Coverage-Information extension. |
These define transformations to convert between codes by systems conforming with this implementation guide.
HL7 Location code to CMS location code |
A mapping between the location code mandated by HL7 with the equivalent concepts in the CMS code system (where equivalents exist) |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
Appointment ServiceRequest example |
Example appointment tied to a ServiceRequest based on CRD profile |
Appointment example |
Example stand-alone appointment populated based on CRD profile |
CommunicationRequest example |
Example communication request populated based on CRD profile |
Coverage example |
Example identified coverage populated based on CRD profile |
Device example |
Example device populated based on CRD profile |
DeviceRequest example |
Example DeviceRequest populated based on CRD profile |
Dispatch Task example |
Example dispatch Task populated based on CRD profile |
Encounter example |
Example encounter populated based on CRD profile |
Example EHR response |
The response to a CRD service query for information not returned in prefetch |
Example EHR search |
Sample of a CRD service searching an EHR that does not support prefetch |
Location example |
Example location populated based on CRD profile |
MedicationRequest annotated example |
Example medication request with an annotation showing coverage expectations |
MedicationRequest example |
Example medication request populated based on CRD profile |
NutritionOrder example |
Example nutrition order populated based on CRD profile |
Organization example |
Example organization populated based on CRD profile |
Patient example |
Example patient populated based on CRD profile |
Practitioner full example |
An example showing a fully populated US Core Practitioner instance (used in CRD examples) |
Questionnaire Task example |
Example questionnaire-completion Task populated based on CRD profile |
ServiceRequest example |
Example service request populated based on CRD profile |
VisionPrescription example |
Example vision prescription based on CRD profile |
Examples of CDS Hooks JSON instances
Example CRD Response with simple Coverage Information |
An example CRD response to a CommunicationRequest with a simple Coverage Information system action |
Example CRD Response with: Links, Information, Coverage Information, and Order Replacement example |
An example of a CRD response of all 'mustSupport' response types, plus 'change order' response type |
Example CRD Response with: Order Replacement, Order supplement, Form Completion, Coverage Update, SMART launch |
An example CRD response with various optional response types |
Example CRD Service Request with CommunicationRequest |
An example of a CRD request for order-sign with CommunicationRequest |
Example CRD Service Request with MedicationRequests |
An example of a CRD request for order-sign with MedicationRequests |
Example CRD Service Request with appointment-book |
An example of a CRD request for appointment-book |
Example CRD Service Requestion with ServiceRequests |
An example of a CRD request for order-sign with ServiceRequests |
Example CRD Services Response |
An example of a CRD services response |