davinci_crd_test_kit 0.12.1 → 0.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. checksums.yaml +4 -4
  2. data/lib/davinci_crd_test_kit/client_tests/appointment_book_receive_request_test.rb +1 -1
  3. data/lib/davinci_crd_test_kit/client_tests/order_dispatch_receive_request_test.rb +1 -1
  4. data/lib/davinci_crd_test_kit/crd_client_suite.rb +8 -0
  5. data/lib/davinci_crd_test_kit/crd_server_suite.rb +8 -0
  6. data/lib/davinci_crd_test_kit/requirements/cds-hooks_2.0_requirements.xlsx +0 -0
  7. data/lib/davinci_crd_test_kit/requirements/{davinci-crd-test-kit_requirements.csv → davinci_crd_test_kit_requirements.csv} +589 -312
  8. data/lib/davinci_crd_test_kit/requirements/generated/crd_client_requirements_coverage.csv +208 -0
  9. data/lib/davinci_crd_test_kit/requirements/generated/crd_server_requirements_coverage.csv +174 -0
  10. data/lib/davinci_crd_test_kit/requirements/hl7.fhir.us.davinci-crd_2.0.1_requirements.xlsx +0 -0
  11. data/lib/davinci_crd_test_kit/version.rb +2 -2
  12. data/lib/davinci_crd_test_kit.rb +0 -1
  13. metadata +11 -12
  14. data/lib/davinci_crd_test_kit/requirements/davinci-crd-test-kit_out_of_scope_requirements.csv +0 -1
  15. data/lib/davinci_crd_test_kit/requirements/generated/davinci-crd-test-kit_requirements_coverage.csv +0 -366
  16. data/lib/inferno_requirements_tools/ext/inferno_core/runnable.rb +0 -22
  17. data/lib/inferno_requirements_tools/tasks/requirements_coverage.rb +0 -284
  18. data/lib/requirements_config.yaml +0 -18
data/lib/davinci_crd_test_kit/requirements/generated/crd_client_requirements_coverage.csv ADDED
@@ -0,0 +1,208 @@
1
+ Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,Da Vinci CRD Client Test Suite Short ID(s),Da Vinci CRD Client Test Suite Full ID(s)
2
+ hl7.fhir.us.davinci-crd_2.0.1,1,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#foundational-requirements,"Future versions of this specification will evolve based on implementer feedback. Therefore, CRD servers and CRD clients MAY mutually agree to support additional hooks, additional card patterns, additional resources, additional extensions, etc. not found in this specification.",MAY,"Client,Server",,,,"",""
3
+ hl7.fhir.us.davinci-crd_2.0.1,2,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#mustsupport,"For CRD clients, If the client maintains the data element and surfaces it to users, then it SHALL be exposed in their FHIR interface when the data exists and privacy constraints permit",SHALL,Client,,,,"",""
4
+ hl7.fhir.us.davinci-crd_2.0.1,20,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#performance,"If a CRD service exceeds the allocated time window for a hook (i.e., for those circumstances that fall outside the 90% expectation), CRD clients SHOULD establish a time-out process that ensures users are not blocked from proceeding with their business flow.",SHOULD,Client,,,,"",""
5
+ hl7.fhir.us.davinci-crd_2.0.1,21,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#performance,"Where a CRD client opts to not block users from proceeding for responses that come back in a period of time shorter than the target time window in this guide (i.e., 5s or 10s), the client must ensure that users are made aware of the information when it is available.",SHALL,Client,,,,"",""
6
+ hl7.fhir.us.davinci-crd_2.0.1,22,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#performance,"For responses that come back in a time period that exceeds this duration, [ 5s or 10s] CRD clients MAY ignore the resulting cards and/or system actions.",MAY,Client,,,,"",""
7
+ hl7.fhir.us.davinci-crd_2.0.1,25,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#terminology,"Where the selected code is not already a billing code and CRD clients are able to automatically determine what the corresponding billing code is, they SHOULD send a Coding with the billing code alongside the clinical code to reduce the risk of the receiving payer making a different translation.",SHOULD,Client,,,,"",""
8
+ hl7.fhir.us.davinci-crd_2.0.1,28,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#enabling-a-crd-server,Provider and EHR vendor organizations MAY leverage the [payer registry](http://hl7.org/fhir/us/davinci-pdex-plan-net) developed by PDex (which will eventually fold into the national directory under [FAST](https://confluence.hl7.org/display/FAST/National+Healthcare+Directory)) as a means of determining which endpoints exist for which payers as candidates for configuration.,MAY,Client,,,,"",""
9
+ hl7.fhir.us.davinci-crd_2.0.1,29,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#enabling-a-crd-server,"Once plans are in the national directory, CRD clients SHOULD include that plan identifier as a way to uniquely identify that plan.",SHOULD,Client,,,,"",""
10
+ hl7.fhir.us.davinci-crd_2.0.1,30,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#enabling-a-crd-server,All CRD clients will need to be configured to support communicating to a particular CRD server. This configuration process includes the following: … Confirming that the CRD server can legitimately act on behalf of one or more payers,SHALL,Client,,,,"",""
11
+ hl7.fhir.us.davinci-crd_2.0.1,31,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#enabling-a-crd-server,All CRD clients will need to be configured to support communicating to a particular CRD server. This configuration process includes the following: … Confirming that the CRD server can be trusted to receive and handle PHI,SHALL,Client,,,,"",""
12
+ hl7.fhir.us.davinci-crd_2.0.1,32,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#enabling-a-crd-server,All CRD clients will need to be configured to support communicating to a particular CRD server. This configuration process includes the following: ...Determining which hook(s) to enable for that CRD server,SHALL,Client,,,,"",""
13
+ hl7.fhir.us.davinci-crd_2.0.1,33,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#enabling-a-crd-server,All CRD clients will need to be configured to support communicating to a particular CRD server. This configuration process includes the following: … Determining what scopes to provide the CRD server for access tokens issued to the service,SHALL,Client,,,,"",""
14
+ hl7.fhir.us.davinci-crd_2.0.1,37,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#crd-access-tokens,The CRD client SHOULD limit the scopes provided in their access token to those identified by the CRD service as necessary to perform their decision support.,SHOULD,Client,,,,"",""
15
+ hl7.fhir.us.davinci-crd_2.0.1,38,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#crd-access-tokens,Such access tokens [identified by the CRD service as necessary to perform their decision support]] SHOULD have an expiration time of no longer than 30 seconds which should be sufficient for even 'parallel' decision support with something like 'Order Select' where a user is continuing to work while the decision support call is processing.,SHOULD,Client,,,,"",""
16
+ hl7.fhir.us.davinci-crd_2.0.1,39,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-data-retrieval,"For this release of the IG, conformant CRD clients SHOULD support the CDS Hooks [prefetch]( https://cds-hooks.hl7.org/2.0/#prefetch-template) capability",SHOULD,Client,,,,"",""
17
+ hl7.fhir.us.davinci-crd_2.0.1,40,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-data-retrieval,"For this release of the IG, conformant CRD clients ... where needed, SHOULD implement interfaces to [_include](http://hl7.org/fhir/R4/search.html#include) resources not available in the system's database.",SHOULD,Client,,,,"",""
18
+ hl7.fhir.us.davinci-crd_2.0.1,43,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-data-retrieval,"The base requirement for these queries, whether based on Encounter or one of the request resources, is to bring back the following associated resources:
19
+
20
+ -Patient
21
+ -Relevant Coverage
22
+ -Authoring Practitioner
23
+ -Authoring Organization
24
+ -Requested performing Practitioner (if specified)
25
+ -Requested performing Organization (if specified)
26
+ -Requested Location (if specified)
27
+ -Associated Medication (if any)
28
+ -Associated Device (if any)",SHALL,Client,,,,"2.1.10, 2.2.10, 2.3.10, 2.4.10, 2.5.10, 2.6.10, 3.2","crd_client-crd_client_hooks-crd_client_appointment_book-crd_hook_request_valid_prefetch, crd_client-crd_client_hooks-crd_client_encounter_start-crd_hook_request_valid_prefetch, crd_client-crd_client_hooks-crd_client_encounter_discharge-crd_hook_request_valid_prefetch, crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_prefetch, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_prefetch, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_prefetch, crd_client-crd_client_fhir_api-Group02"
29
+ hl7.fhir.us.davinci-crd_2.0.1,44,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"In addition to the [base prefetch capabilities](https://cds-hooks.hl7.org/2.0/#prefetch-template) defined in the CDS Hooks specification, systems that support prefetch SHOULD support the [additional prefetch capabilities](https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-prefetch-capabilities) defined in this specification.",SHOULD,Client,,,,"",""
30
+ hl7.fhir.us.davinci-crd_2.0.1,45,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"'standard' prefetch queries ... SHOULD be supported for [Appointment]: ...
31
+
32
+ ```Appointment?_id={{context.appointments.Appointment.id}}
33
+ &_include=Appointment:patient
34
+ &_include=Appointment:practitioner:PractitionerRole
35
+ &_include:iterate=PractitionerRole:organization
36
+ &_include:iterate=PractitionerRole:practitioner
37
+ &_include=Appointment:location```",SHOULD,Client,,,,"",""
38
+ hl7.fhir.us.davinci-crd_2.0.1,46,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,standard' prefetch queries... SHOULD be supported for each type of resource: ... Coverage?patient={{context.patient}},SHOULD,Client,,,,"",""
39
+ hl7.fhir.us.davinci-crd_2.0.1,47,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"'standard' prefetch queries SHOULD be supported for [Device Request]: ...
40
+
41
+ ```DeviceRequest?_id={{context.draftOrders.DeviceRequest.id}}
42
+ &_include=DeviceRequest:patient
43
+ &_include=DeviceRequest:performer
44
+ &_include=DeviceRequest:requester
45
+ &_include=DeviceRequest:device
46
+ &_include:iterate=PractitionerRole:organization
47
+ &_include:iterate=PractitionerRole:practitioner```",SHOULD,Client,,,,"",""
48
+ hl7.fhir.us.davinci-crd_2.0.1,48,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"'standard' prefetch queries ... SHOULD be supported for [Encounter]: ...
49
+
50
+ ```Encounter?_id={{context.encounterId}}
51
+ &_include=Encounter:patient
52
+ &_include=Encounter:service-provider
53
+ &_include=Encounter:practitioner
54
+ &_include=Encounter:location```",SHOULD,Client,,,,"",""
55
+ hl7.fhir.us.davinci-crd_2.0.1,49,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"'standard' prefetch queries SHOULD be supported for [MedicationRequest]: ...
56
+
57
+ ```MedicationRequest?_id={{context.draftOrders.MedicationRequest.id}}
58
+ &_include=MedicationRequest:patient
59
+ &_include=MedicationRequest:intended-dispenser
60
+ &_include=MedicationRequest:requester:PractitionerRole
61
+ &_include=MedicationRequest:medication
62
+ &_include:iterate=PractitionerRole:organization
63
+ &_include:iterate=PractitionerRole:practitioner```",SHOULD,Client,,,,"",""
64
+ hl7.fhir.us.davinci-crd_2.0.1,50,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"'standard' prefetch queries that SHOULD be supported for [NutritionOrder]: ...
65
+
66
+ ```NutritionOrder?_id={{context.draftOrders.NutritionOrder.id}}
67
+ &_include=NutritionOrder:patient
68
+ &_include=NutritionOrder:provider
69
+ &_include=NutritionOrder:requester
70
+ &_include:iterate=PractitionerRole:organization
71
+ &_include:iterate=PractitionerRole:practitioner
72
+ &_include=NutritionOrder:encounter
73
+ &_include:iterate=Encounter:location```",SHOULD,Client,,,,"",""
74
+ hl7.fhir.us.davinci-crd_2.0.1,51,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"'standard' prefetch queries SHOULD be supported for [ServiceRequest]: ...
75
+
76
+ ```ServiceRequest?_id={{context.draftOrders.ServiceRequest.id}}
77
+ &_include=ServiceRequest:patient
78
+ &_include=ServiceRequest:performer
79
+ &_include=ServiceRequest:requester
80
+ &_include:iterate=PractitionerRole:organization
81
+ &_include:iterate=PractitionerRole:practitioner```",SHOULD,Client,,,,"",""
82
+ hl7.fhir.us.davinci-crd_2.0.1,52,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD clients MAY support only the resources needed to implement the relevant CDS Hooks and order types.,MAY,Client,,,,"",""
83
+ hl7.fhir.us.davinci-crd_2.0.1,53,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD client implementations SHOULD NOT expect standardized prefetch key names.,SHOULD NOT,Client,,,,"",""
84
+ hl7.fhir.us.davinci-crd_2.0.1,54,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD clients supporting prefetch SHALL inspect the CDS Hooks discovery endpoint to determine exact prefetch key names and queries.,SHALL,Client,,,,"",""
85
+ hl7.fhir.us.davinci-crd_2.0.1,55,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD clients SHOULD limit the coverages provided to just those relevant to the CRD service.,SHOULD,Client,,,,"",""
86
+ hl7.fhir.us.davinci-crd_2.0.1,58,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#query-notes,Conformant CRD clients SHOULD be able to perform [respond to] all the queries defined here [[FHIR Resource Access](https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#fhir-resource-access)],SHOULD,Client,,,,"",""
87
+ hl7.fhir.us.davinci-crd_2.0.1,59,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#query-notes,"Conformant CRD clients ... where needed, SHOULD implement interfaces to [_include](http://hl7.org/fhir/R4/search.html#include) resources not available in the client's database.",SHOULD,Client,,,,"",""
88
+ hl7.fhir.us.davinci-crd_2.0.1,61,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#query-notes,"When full prefetch as defined here is not supported, CRD clients SHOULD, at minimum, support the batch query syntax shown [above]( https://build.fhir.org/ig/HL7/davinci-crd/foundation.html#fhir-resource-access)",SHOULD,Client,,,,"",""
89
+ hl7.fhir.us.davinci-crd_2.0.1,64,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD Clients conforming with this specification [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] SHALL support the SMART on FHIR interface,",SHALL,Client,,,,3.1,crd_client-crd_client_fhir_api-Group01
90
+ hl7.fhir.us.davinci-crd_2.0.1,65,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD clients conforming with this [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] specification … SHALL allow launching of SMART apps from within their application",SHALL,Client,,,,3.1,crd_client-crd_client_fhir_api-Group01
91
+ hl7.fhir.us.davinci-crd_2.0.1,66,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD clients conforming with this [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] specification ... SHALL be capable of providing the SMART app access to information it exposes to CRD servers using the CDS Hooks interface.",SHALL,Client,,,,3.1,crd_client-crd_client_fhir_api-Group01
92
+ hl7.fhir.us.davinci-crd_2.0.1,67,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"The app/CRD client MAY choose to use configuration options to control what types of cards are of interest [when using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios]",MAY,Client,,,,"",""
93
+ hl7.fhir.us.davinci-crd_2.0.1,68,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"In the specific case of order-based hooks, ""what if"" SHOULD use the Order Sign hook",SHOULD,Client,,,,"",""
94
+ hl7.fhir.us.davinci-crd_2.0.1,69,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"In the specific case of order-based hooks, ""what if"" ... SHALL use the configuration option that prevents the return of an unsolicited determination",SHALL,Client,,,,"",""
95
+ hl7.fhir.us.davinci-crd_2.0.1,70,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"In the specific case of order-based hooks, ""what if"" ... MAY use configuration options to prevent the return of other irrelevant types of cards (e.g., duplicate therapy).",MAY,Client,,,,"",""
96
+ hl7.fhir.us.davinci-crd_2.0.1,71,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"When CRD clients pass resources to a CRD server as part of context, the resources SHALL have an ID",SHALL,Client,,,,"2.1.09, 2.4.09, 2.6.09","crd_client-crd_client_hooks-crd_client_appointment_book-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
97
+ hl7.fhir.us.davinci-crd_2.0.1,72,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"When CRD clients pass resources to a CRD server as part of context, the resources ... SHALL be usable as a target for references in resources manipulated by CDS Hook actions and/or by SMART apps.",SHALL,Client,,,,"",""
98
+ hl7.fhir.us.davinci-crd_2.0.1,73,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,CRD client must handle adjustments to any references made to … [resource ids] (or provide necessary redirects) ensuring that any references made to the in-memory resource will remain valid.,SHALL,Client,,,,"",""
99
+ hl7.fhir.us.davinci-crd_2.0.1,74,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"CRD clients will need to support the creation or updating of resources that include references to resources that might, at the time, only exist in memory and not yet be available as persistent entities.",SHALL,Client,,,,"3.2.1.01, 3.2.2.01, 3.2.5.01, 3.2.6.01, 3.2.11.01, 3.2.12.01, 3.2.14.01, 3.2.15.01, 3.2.16.01, 3.2.17.01","crd_client-crd_client_fhir_api-Group02-Group01-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group02-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group05-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group06-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group11-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group12-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group14-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group15-crd_client_fhir_api_create_test, crd_client-crd_client_fhir_api-Group02-Group16-crd_client_fhir_api_create_test, crd_client-crd_client_fhir_api-Group02-Group17-crd_client_fhir_api_update_test"
100
+ hl7.fhir.us.davinci-crd_2.0.1,75,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"Therefore, in addition to any logging performed for security purposes, ... CRD Clients ... SHALL retain logs of all CRD-related hook invocations and their responses for access in the event of a dispute.",SHALL,Client,,,,"",""
101
+ hl7.fhir.us.davinci-crd_2.0.1,78,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,Organizations SHALL have processes to ensure logs can be accessed by appropriate authorized users to help resolve discrepancies or issues in a timely manner.,SHALL,"Client,Server",,,,"",""
102
+ hl7.fhir.us.davinci-crd_2.0.1,79,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"Because the information in these logs will often contain PHI, access to the logs themselves will need to be restricted ... for security purposes.",SHALL,"Client,Server",,,,"",""
103
+ hl7.fhir.us.davinci-crd_2.0.1,80,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"Because the information in these logs will often contain PHI, access to the logs themselves will need to be ... logged for security purposes.",SHALL,"Client,Server",,,,"",""
104
+ hl7.fhir.us.davinci-crd_2.0.1,81,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,CRD Clients SHOULD ensure that multiple cards with the same “advice” are handled in a way that will not create a burden on the user.,SHOULD,Client,,,,"",""
105
+ hl7.fhir.us.davinci-crd_2.0.1,82,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,Conformance systems SHOULD omit non-significant whitespace for performance reasons.,SHOULD,Client,,,,"",""
106
+ hl7.fhir.us.davinci-crd_2.0.1,83,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: … FHIR Core: [Security & Privacy Module](http://hl7.org/fhir/R4/secpriv-module.html),SHALL,"Client,Server",,,,"",""
107
+ hl7.fhir.us.davinci-crd_2.0.1,84,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: FHIR Core: ... [Security Principles](http://hl7.org/fhir/R4/security.html),SHALL,"Client,Server",,,,"",""
108
+ hl7.fhir.us.davinci-crd_2.0.1,85,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: FHIR Core: ... [Implementer’s Checklist](http://hl7.org/fhir/R4/safety.html),SHALL,"Client,Server",,,,"",""
109
+ hl7.fhir.us.davinci-crd_2.0.1,86,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: … HRex: [Privacy & Security](http://hl7.org/fhir/us/davinci-hrex/STU1/security.html),SHALL,"Client,Server",,,,"",""
110
+ hl7.fhir.us.davinci-crd_2.0.1,87,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: … CDS Hooks: [Security & Safety](https://cds-hooks.hl7.org/2.0/#security-and-safety),SHALL,"Client,Server",,,,"",""
111
+ hl7.fhir.us.davinci-crd_2.0.1,88,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: … SMART on FHIR: [SMART App Launch](http://www.hl7.org/fhir/smart-app-launch),SHALL,"Client,Server",,,,"",""
112
+ hl7.fhir.us.davinci-crd_2.0.1,89,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"As per the CDS Hook specification, communications between CRD Clients and CRD Servers SHALL use TLS.",SHALL,"Client,Server",,,,3.1,crd_client-crd_client_fhir_api-Group01
113
+ hl7.fhir.us.davinci-crd_2.0.1,90,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Mutual TLS is not required by this specification but is permitted.,MAY,"Client,Server",,,,"",""
114
+ hl7.fhir.us.davinci-crd_2.0.1,91,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,CRD Servers and CRD Clients SHOULD enforce a minimum version and other TLS configuration requirements based on [HRex rules for PHI exchange](https://hl7.org/fhir/us/davinci-hrex/STU1/security.html#exchange-of-phi-for-treatment-payment-operations-tpo-as-defined),SHOULD,"Client,Server",,,,"",""
115
+ hl7.fhir.us.davinci-crd_2.0.1,92,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,CRD Clients SHALL support running applications that adhere to the SMART on FHIR [confidential app](http://www.hl7.org/fhir/smart-app-launch#support-for-public-and-confidential-apps) profile.,SHALL,Client,,,,3.1,crd_client-crd_client_fhir_api-Group01
116
+ hl7.fhir.us.davinci-crd_2.0.1,95,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"CRD Clients are the final arbiters of what data can or cannot be shared with CRD Servers and SHOULD filter or withhold any resources or data elements necessary to support their obligations as health data custodians, including ... patient consent-based restrictions.",SHOULD,Client,,,,"",""
117
+ hl7.fhir.us.davinci-crd_2.0.1,96,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"CRD Clients are the final arbiters of what data can or cannot be shared with CRD Servers and SHOULD filter or withhold any resources or data elements necessary to support their obligations as health data custodians, including legal...restrictions.",SHOULD,Client,,,,"",""
118
+ hl7.fhir.us.davinci-crd_2.0.1,97,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"CRD Clients are the final arbiters of what data can or cannot be shared with CRD Servers and SHOULD filter or withhold any resources or data elements necessary to support their obligations as health data custodians, including ... policy restrictions.",SHOULD,Client,,,,"",""
119
+ hl7.fhir.us.davinci-crd_2.0.1,98,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,CRD Clients SHALL ensure that the resource identifiers exposed over the CRD interface are distinct from and have no determinable relationship with any business identifiers associated with those records.,SHALL,Client,,,,"",""
120
+ hl7.fhir.us.davinci-crd_2.0.1,99,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Access to patient information to meet decision support requirements is still subject to regulations such as HIPAA “minimum necessary” and CRD clients SHOULD audit access to check for reasonableness and appropriateness.,SHOULD,Client,,,,"",""
121
+ hl7.fhir.us.davinci-crd_2.0.1,100,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,All information sharing that occurs through making CRD calls is subject to the privacy and security considerations documented [here](http://hl7.org/fhir/us/davinci-hrex/STU1/security.html),SHALL,"Client,Server",,,,"",""
122
+ hl7.fhir.us.davinci-crd_2.0.1,101,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#cds-hook-deviations-and-enhancements,Implementers MAY choose to provide support for this new [[order-dispatch hook](https://cds-hooks.org/hooks/order-dispatch)]] hook.,MAY,Client,,,,"",""
123
+ hl7.fhir.us.davinci-crd_2.0.1,102,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-hook-scope,"This IG adopts the newer wording, meaning that the order-sign hook can be triggered … on newly created orders.",MAY,Client,,,,"",""
124
+ hl7.fhir.us.davinci-crd_2.0.1,103,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-hook-scope,"This IG adopts the newer wording, meaning that the order-sign hook can be triggered … when orders are updated (changing status, changing time-frame, etc.).",MAY,Client,,,,"",""
125
+ hl7.fhir.us.davinci-crd_2.0.1,104,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-hook-resources,CRD has use-cases for additional resource types to be passed to … [the `order-select`] hook. Specifically: … [CommunicationRequest](http://hl7.org/fhir/R4/communicationrequest.html),MAY,Client,,,,"",""
126
+ hl7.fhir.us.davinci-crd_2.0.1,105,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-hook-resources,CRD has use-cases for additional resource types to be passed to … [the `order-sign`] hook. Specifically: … [CommunicationRequest](http://hl7.org/fhir/R4/communicationrequest.html),MAY,Client,,,,"",""
127
+ hl7.fhir.us.davinci-crd_2.0.1,106,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-hook-resources,CRD has use-cases for additional resource types to be passed to [the `order-select`] hook. Specifically: … [Task](http://hl7.org/fhir/R4/task.html),SHOULD,Client,,,,"",""
128
+ hl7.fhir.us.davinci-crd_2.0.1,107,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-hook-resources,CRD has use-cases for additional resource types to be passed to [the `order-sign`] hook. Specifically: … [Task](http://hl7.org/fhir/R4/task.html),SHOULD,Client,,,,"",""
129
+ hl7.fhir.us.davinci-crd_2.0.1,109,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#new-hook-configuration-mechanism,The hook’s [HTTP Request](https://cds-hooks.hl7.org/2.0/#http-request_1) object will include an extension to pass specific configuration settings as part of the hook invocation,MAY,Client,,,,"",""
130
+ hl7.fhir.us.davinci-crd_2.0.1,125,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#hook-configuration-extension,Where CRD Clients support the optional configuration options... CRD Clients SHOULD expose configuration options through a configuration screen to allow users and/or system administrators to control the types of information returned.,SHOULD,Client,,,,"",""
131
+ hl7.fhir.us.davinci-crd_2.0.1,126,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#hook-configuration-extension,Where CRD Clients support the optional configuration options ... CRD Clients SHALL convey configuration options when invoking the hook using the davinci-crd.configuration extension. It will be a single object whose properties will be drawn from the code values from configuration options and whose values will be of the type defined for that option.,SHALL,Client,,,,"",""
132
+ hl7.fhir.us.davinci-crd_2.0.1,127,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#hook-configuration-extension,"Where CRD Clients support the optional configuration options ... CRD Clients SHOULD provide an ability to leverage the dynamic configuration capabilities of payer services based on provider role, individual provider, and/or hook invocation location as best meets the needs of their users.",SHOULD,Client,,,,"",""
133
+ hl7.fhir.us.davinci-crd_2.0.1,130,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#hook-configuration-extension,Because support for some configuration is required for all CRD servers ... CRD Clients MAY send configuration information that CRD Servers do not support.,MAY,Client,,,,"",""
134
+ hl7.fhir.us.davinci-crd_2.0.1,132,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-prefetch-capabilities,"Specifically, where a hook defines a context element that consists of a resource or collection of resources (e.g. [order-select.draftOrders](https://cds-hooks.hl7.org/hooks/order-select/2020May/order-select.html#context) or [order-sign.draftOrders](https://cds-hooks.hl7.org/hooks/order-sign/2020May/order-sign#context)), systems SHALL recognize context tokens of the form `context.<context property>.<FHIR resource name>.id` in prefetch queries.",SHALL,Client,,,,"",""
135
+ hl7.fhir.us.davinci-crd_2.0.1,133,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-prefetch-capabilities,[context tokens of the form `context.<context property>.<FHIR resource name>.id` in prefetch queries] SHALL evaluate to a comma-separated list of the identifiers of all resources of the specified type within that context key.,SHALL,Client,,,,"",""
136
+ hl7.fhir.us.davinci-crd_2.0.1,137,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#linkage-between-created-resources,the inclusion of the `id` element in ‘created’ resources and references in created and updated resources within multi-action suggestions SHALL be handled as per [FHIR’s transaction processing rules](http://hl7.org/fhir/R4/http.html#trules).,SHALL,Client,,,,"",""
137
+ hl7.fhir.us.davinci-crd_2.0.1,138,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#linkage-between-created-resources,"if a FHIR Reference points to the resource type and `id` of a resource of another ‘create’ Action in the same Suggestion, then the reference to that resource SHALL be updated by the server to point to the `id` assigned by the client when performing the ‘create’.",SHALL,Client,,,,"",""
138
+ hl7.fhir.us.davinci-crd_2.0.1,139,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#linkage-between-created-resources,CRD Clients SHALL perform ‘creates’ in an order that ensures that referenced resources are created prior to referencing resources.,SHALL,Client,,,,"",""
139
+ hl7.fhir.us.davinci-crd_2.0.1,142,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#controlling-hook-invocation,Provider systems SHALL only invoke hooks on payer services where the patient record indicates active coverage with the payer associated with the service,SHALL,Client,,,,"",""
140
+ hl7.fhir.us.davinci-crd_2.0.1,143,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#controlling-hook-invocation,Providers MAY limit hook invocation to only those payers that are believed to potentially have relevant information related to the current action,MAY,Client,,,,"",""
141
+ hl7.fhir.us.davinci-crd_2.0.1,144,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#controlling-hook-invocation,CRD clients SHALL select from those coverages which is most likely to be primary and only solicit coverage information for that one payer.,SHALL,Client,,,,"",""
142
+ hl7.fhir.us.davinci-crd_2.0.1,145,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#controlling-hook-invocation,"If they invoke CRD on other payers, CRD clients SHALL ensure that card types that return coverage information are disabled for those ‘likely secondary’ payers.",SHALL,Client,,,,"",""
143
+ hl7.fhir.us.davinci-crd_2.0.1,146,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#controlling-hook-invocation,"Where the patient has multiple active coverages that the CRD client deems appropriate to call the respective CRD servers for, the CRD client SHALL invoke all CRD server calls in parallel and display results simultaneously to ensure timely response to user action.",SHALL,Client,,,,"",""
144
+ hl7.fhir.us.davinci-crd_2.0.1,147,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,the `order-select` hook SHOULD fire whenever a user of a CRD Client creates a new order or referral.,SHOULD,Client,,,,"",""
145
+ hl7.fhir.us.davinci-crd_2.0.1,148,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide SHALL be able to determine the correct payer CRD Service to use for each request. [appointment-book, encounter-start, encounter-discharge, order-dispatch, order-select, and order-sign]",SHALL,Client,,,,"",""
146
+ hl7.fhir.us.davinci-crd_2.0.1,149,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide SHALL support at least one of the hooks [appointment-book, encounter-start, encounter-discharge, order-dispatch, order-select, and order-sign]",SHALL,Client,,,,2,crd_client-crd_client_hooks
147
+ hl7.fhir.us.davinci-crd_2.0.1,150,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide SHALL support ... (for order-centric hooks), at least one of the order resource types [CommunicationRequest, DeviceRequest, MedicationRequest, ServiceRequest, NutritionOrder, VisionPrescription]",SHALL,Client,,,,"3.2.2, 3.2.5, 3.2.11, 3.2.12, 3.2.14, 3.2.17","crd_client-crd_client_fhir_api-Group02-Group02, crd_client-crd_client_fhir_api-Group02-Group05, crd_client-crd_client_fhir_api-Group02-Group11, crd_client-crd_client_fhir_api-Group02-Group12, crd_client-crd_client_fhir_api-Group02-Group14, crd_client-crd_client_fhir_api-Group02-Group17"
148
+ hl7.fhir.us.davinci-crd_2.0.1,151,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide ... SHOULD support all [CommunicationRequest, DeviceRequest, MedicationRequest, ServiceRequest, NutritionOrder, VisionPrescription] that apply to the context of their system.",SHOULD,Client,,,,"",""
149
+ hl7.fhir.us.davinci-crd_2.0.1,154,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,CRD Clients … MAY choose to support additional hooks available in the registry on the [CDS Hooks continuous integration build](https://cds-hooks.org/) or custom hooks defined elsewhere.,MAY,Client,,,,"",""
150
+ hl7.fhir.us.davinci-crd_2.0.1,156,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,[Clients who choose to support additional hooks] SHOULD adhere to the conformance expectations defined in this specification for any hooks listed here.,SHOULD,Client,,,,"",""
151
+ hl7.fhir.us.davinci-crd_2.0.1,166,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#hook-categories,(CRD clients SHOULD use the configuration options to instruct CRD servers to not even try to return cards if they do not intend to display/process them.),SHOULD,Client,,,,"",""
152
+ hl7.fhir.us.davinci-crd_2.0.1,171,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[Clients SHALL support] version 1.0 of the [[appointment-book](https://cds-hooks.hl7.org/hooks/appointment-book/STU1/appointment-book/)] hook.,SHALL,Client,,,,2.1.02,crd_client-crd_client_hooks-crd_client_appointment_book-crd_appointment_book_request
153
+ hl7.fhir.us.davinci-crd_2.0.1,172,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,"This [appointment-book] hook would be triggered when the user of a CRD Client books a future appointment for a patient with themselves, with someone else within their organization, or with another organization. (Note that whether the CRD Client will create an appointment - triggering the `appointment-book` hook - or a ServiceRequest - triggering an `order-select` or `order-sign` hook - can vary depending on the service being booked and the organizations involved.)",SHALL,Client,,,,2.1,crd_client-crd_client_hooks-crd_client_appointment_book
154
+ hl7.fhir.us.davinci-crd_2.0.1,177,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook] The profiles expected to be used for the resources resolved to by the userId … are … [profile-practitioner](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-practitioner.html) [or] [us-core-practitionerrole](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html),SHOULD,Client,,,,"",""
155
+ hl7.fhir.us.davinci-crd_2.0.1,178,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook] The profiles expected to be used for the resources resolved to by the … patientId … are … [profile-patient](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-patient.html),SHOULD,Client,,,,"",""
156
+ hl7.fhir.us.davinci-crd_2.0.1,179,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook] The profiles expected to be used for the resources resolved to by the … encounterId … are … [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html),SHOULD,Client,,,,"",""
157
+ hl7.fhir.us.davinci-crd_2.0.1,180,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,<html>[for the appointment-book hook] The profiles expected to be used for the resources resolved to by the … `appointments` … are …<b> </b>[profile-appointment](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-appointment.html)</html>,SHOULD,Client,,,,"",""
158
+ hl7.fhir.us.davinci-crd_2.0.1,183,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,"CRD clients... SHALL, at minimum, support ... processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-ext-coverage-information.html) system action for all invocations of this [[appointment-book](https://cds-hooks.hl7.org/hooks/appointment-book/STU1/appointment-book/)] hook.",SHALL,Client,,,,2.1.02,crd_client-crd_client_hooks-crd_client_appointment_book-crd_appointment_book_request
159
+ hl7.fhir.us.davinci-crd_2.0.1,186,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[Clients SHALL support] version 1.0 of the [[encounter-start](https://cds-hooks.hl7.org/hooks/encounter-start/2023SepSTU1Ballot/encounter-start/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/encounter-start/STU1/encounter-start/))],SHALL,Client,,,,2.2.02,crd_client-crd_client_hooks-crd_client_encounter_start-crd_encounter_start_request
160
+ hl7.fhir.us.davinci-crd_2.0.1,187,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,"This [[encounter-start](https://cds-hooks.hl7.org/hooks/encounter-start/STU1/encounter-start/)] hook would be triggered when a patient is admitted, a patient arrives for an out-patient visit, and/or when a provider first engages with a patient during an encounter.",SHALL,Client,,,,2.2,crd_client-crd_client_hooks-crd_client_encounter_start
161
+ hl7.fhir.us.davinci-crd_2.0.1,192,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook] The profiles expected to be used for the resources resolved to by the userId … are … [profile-practitioner](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-practitioner.html) [or] [us-core-practitionerrole](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html),SHOULD,Client,,,,"",""
162
+ hl7.fhir.us.davinci-crd_2.0.1,193,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook] The profiles expected to be used for the resources resolved to by the … patientId … are … [profile-patient](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-patient.html),SHOULD,Client,,,,"",""
163
+ hl7.fhir.us.davinci-crd_2.0.1,194,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook] The profiles expected to be used for the resources resolved to by the … encounterId … are … [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html),SHOULD,Client,,,,"",""
164
+ hl7.fhir.us.davinci-crd_2.0.1,197,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[Clients SHALL support] version 1.0 of the [[encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/2023SepSTU1Ballot/encounter-discharge/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/))],SHALL,Client,,,,2.3.02,crd_client-crd_client_hooks-crd_client_encounter_discharge-crd_encounter_discharge_request
165
+ hl7.fhir.us.davinci-crd_2.0.1,199,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,"[In response to an [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook call, [clients should] Verify that documentation requirements for the services performed have been met to ensure the services provided can be reimbursed",SHOULD,Client,,,,"",""
166
+ hl7.fhir.us.davinci-crd_2.0.1,200,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,"[In response to an [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook call, [clients should] Ensure that required follow-up planning is complete and appropriate transfer of care has been arranged, particularly for accountable care models",SHOULD,Client,,,,"",""
167
+ hl7.fhir.us.davinci-crd_2.0.1,201,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook] The profiles expected to be used for the resources resolved to by the userId … are … [profile-practitioner](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-practitioner.html) [or] [us-core-practitionerrole](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html),MAY,Client,,,,"",""
168
+ hl7.fhir.us.davinci-crd_2.0.1,202,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook] The profiles expected to be used for the resources resolved to by the … patientId … are … [profile-patient](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-patient.html),MAY,Client,,,,"",""
169
+ hl7.fhir.us.davinci-crd_2.0.1,203,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook] The profiles expected to be used for the resources resolved to by the … encounterId … are … [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html),MAY,Client,,,,"",""
170
+ hl7.fhir.us.davinci-crd_2.0.1,205,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch,[Clients SHALL support] version 1.0 of the [[order-dispatch](https://cds-hooks.hl7.org/hooks/order-dispatch/2023SepSTU1Ballot/order-dispatch/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/order-dispatch/STU1/order-dispatch/))],SHALL,Client,,,,2.5.02,crd_client-crd_client_hooks-crd_client_order_dispatch-crd_order_dispatch_request
171
+ hl7.fhir.us.davinci-crd_2.0.1,207,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch,"CRD clients and servers SHALL, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-ext-coverage-information.html) system action for all invocations of this [[order-dispatch](order-dispatch](https://cds-hooks.hl7.org/hooks/order-dispatch/STU1/order-dispatch/)] hook",SHALL,"Client,Server",,,,2.5.02,crd_client-crd_client_hooks-crd_client_order_dispatch-crd_order_dispatch_request
172
+ hl7.fhir.us.davinci-crd_2.0.1,209,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select,[Clients SHALL support] version 1.0 of the [[order-select](https://cds-hooks.hl7.org/hooks/order-select/2023SepSTU1Ballot/order-select/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/order-select/STU1/order-select/))],SHALL,Client,,,,2.4.02,crd_client-crd_client_hooks-crd_client_order_select-crd_order_select_request
173
+ hl7.fhir.us.davinci-crd_2.0.1,218,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign,[Clients SHALL support] version 1.0 of the [[order-sign](https://cds-hooks.org/hooks/order-sign/2020May/order-sign)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/order-sign/STU1/order-sign/))],SHALL,Client,,,,2.6.02,crd_client-crd_client_hooks-crd_client_order_sign-crd_order_sign_request
174
+ hl7.fhir.us.davinci-crd_2.0.1,225,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign,"CRD clients ... SHALL, at minimum, support returning … processing the Coverage Information system action for all invocations of this [[order-sign hook](https://cds-hooks.hl7.org/hooks/order-sign/STU1/order-sign/)] hook.",SHALL,Client,,,,2.6.02,crd_client-crd_client_hooks-crd_client_order_sign-crd_order_sign_request
175
+ hl7.fhir.us.davinci-crd_2.0.1,242,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#cards-profiles,It is the responsibility of the CRD Client to determine how best to present the results of the newly created or revised records.,SHOULD,Client,,,,"",""
176
+ hl7.fhir.us.davinci-crd_2.0.1,243,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"conformant CRD Clients SHALL support the [External Reference](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#external-reference), … response",SHALL,Client,,,,"2.1.02, 2.2.02, 2.3.02, 2.4.02, 2.5.02, 2.6.02","crd_client-crd_client_hooks-crd_client_appointment_book-crd_appointment_book_request, crd_client-crd_client_hooks-crd_client_encounter_start-crd_encounter_start_request, crd_client-crd_client_hooks-crd_client_encounter_discharge-crd_encounter_discharge_request, crd_client-crd_client_hooks-crd_client_order_select-crd_order_select_request, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_order_dispatch_request, crd_client-crd_client_hooks-crd_client_order_sign-crd_order_sign_request"
177
+ hl7.fhir.us.davinci-crd_2.0.1,244,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"conformant CRD Clients SHALL support the ... [Instructions](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#instructions), … response",SHALL,Client,,,,"2.1.02, 2.2.02, 2.3.02, 2.4.02, 2.5.02, 2.6.02","crd_client-crd_client_hooks-crd_client_appointment_book-crd_appointment_book_request, crd_client-crd_client_hooks-crd_client_encounter_start-crd_encounter_start_request, crd_client-crd_client_hooks-crd_client_encounter_discharge-crd_encounter_discharge_request, crd_client-crd_client_hooks-crd_client_order_select-crd_order_select_request, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_order_dispatch_request, crd_client-crd_client_hooks-crd_client_order_sign-crd_order_sign_request"
178
+ hl7.fhir.us.davinci-crd_2.0.1,245,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,conformant CRD Clients SHALL support the... [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information) response,SHALL,Client,,,,"2.1.02, 2.2.02, 2.3.02, 2.4.02, 2.5.02, 2.6.02","crd_client-crd_client_hooks-crd_client_appointment_book-crd_appointment_book_request, crd_client-crd_client_hooks-crd_client_encounter_start-crd_encounter_start_request, crd_client-crd_client_hooks-crd_client_encounter_discharge-crd_encounter_discharge_request, crd_client-crd_client_hooks-crd_client_order_select-crd_order_select_request, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_order_dispatch_request, crd_client-crd_client_hooks-crd_client_order_sign-crd_order_sign_request"
179
+ hl7.fhir.us.davinci-crd_2.0.1,246,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,conformant CRD Clients... SHOULD support the remaining types [of [Responses](https://cds-hooks.hl7.org/2.0/#cds-service-response)].,SHOULD,Client,,,,"",""
180
+ hl7.fhir.us.davinci-crd_2.0.1,251,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,[A]cceptance of decision support cards outside the coverage and documentation requirements space is optional (for both server and client).,MAY,Client,,,,"",""
181
+ hl7.fhir.us.davinci-crd_2.0.1,254,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"In this case, [where the CRD Client provide resources, such as MedicationRequest, in the CDS Hook request context object] the CDS Client must maintain a stable identifier for these temporary resources to allow CRD responses to refer to them in CDS Hook Actions.",SHALL,Client,,,,"2.2.09, 2.3.09","crd_client-crd_client_hooks-crd_client_encounter_start-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_encounter_discharge-crd_hook_request_valid_context"
182
+ hl7.fhir.us.davinci-crd_2.0.1,255,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"When a Coverage Information card type indicating that additional clinical documentation is needed and the CRD client supports DTR, CRD Clients SHALL ensure that clinical users have an opportunity to launch the DTR app as part of the current workflow.",SHALL,Client,,,,"",""
183
+ hl7.fhir.us.davinci-crd_2.0.1,256,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"Where a Coverage Information indicates that additional administrative documentation is needed, CRD Clients SHOULD allow clinical users to have an opportunity to launch the DTR app",SHOULD,Client,,,,"",""
184
+ hl7.fhir.us.davinci-crd_2.0.1,257,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"Where a Coverage Information indicates that additional administrative documentation is needed, CRD Clients ... SHOULD make it clear that the information to be captured is non-clinical.",SHOULD,Client,,,,"",""
185
+ hl7.fhir.us.davinci-crd_2.0.1,263,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,"If a CRD client submits a claim related to an order for which it has received a coverage-information extension for the coverage type associated with the claim, that claim SHALL include the `coverage-assertion-id` and, if applicable, the `satisfied-pa-id` in the X12 837 K3 segment.",SHALL,Client,,,,"",""
186
+ hl7.fhir.us.davinci-crd_2.0.1,266,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,Systems MAY fire calls related to orders even if there is already a coverage assertion recorded on the order.,MAY,Client,,,,"",""
187
+ hl7.fhir.us.davinci-crd_2.0.1,278,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,"CRD clients... SHALL support the new CDS Hooks system action functionality to cause annotations to automatically be stored on the relevant request, appointment, etc. without any user intervention.",SHALL,Client,,,,"",""
188
+ hl7.fhir.us.davinci-crd_2.0.1,280,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,"In this case, [Where CRD clients and services support the new CDS Hooks system action functionality to cause annotations to automatically be stored on the relevant request, appointment, etc.] the discrete information propagated into the order extension SHALL be available to the user for viewing",SHALL,Client,,,,"",""
189
+ hl7.fhir.us.davinci-crd_2.0.1,281,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,CRD clients MAY be configured to not execute system actions under some circumstances - e.g. if the order has been cancelled/abandoned.,MAY,Client,,,,"",""
190
+ hl7.fhir.us.davinci-crd_2.0.1,284,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-device](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-device.html) profile",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
191
+ hl7.fhir.us.davinci-crd_2.0.1,285,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [device] orders (and any associated resources) SHALL comply with the [profile-devicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html) profile",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
192
+ hl7.fhir.us.davinci-crd_2.0.1,286,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [encounter] orders (and any associated resources) SHALL comply with the [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html) profile",SHALL,Client,,,,"2.1.09, 2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_appointment_book-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
193
+ hl7.fhir.us.davinci-crd_2.0.1,287,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [medication] orders (and any associated resources) SHALL comply with the [profile-medicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html) profile [and referenced Medications SHALL comply with the [us-core-medication](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html) profile.]",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
194
+ hl7.fhir.us.davinci-crd_2.0.1,288,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [nutrition] orders (and any associated resources) SHALL comply with the [profile-nutritionorder](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-nutritionorder.html) profile",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
195
+ hl7.fhir.us.davinci-crd_2.0.1,289,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [service] orders (and any associated resources) SHALL comply with the [profile-servicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html) profile",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
196
+ hl7.fhir.us.davinci-crd_2.0.1,290,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [vision] orders (and any associated resources) SHALL comply with the [profile-visionprescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html) profile",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
197
+ hl7.fhir.us.davinci-crd_2.0.1,291,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [communication] orders (and any associated resources) SHALL comply with the [profile-communicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-communicationrequest.html) profile",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
198
+ hl7.fhir.us.davinci-crd_2.0.1,292,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-devicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html) profile [and referenced devices SHALL comply with the [profile-device](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-device.html) profile]",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
199
+ hl7.fhir.us.davinci-crd_2.0.1,293,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-medicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html) profile [and referenced medications SHALL comply with the [us-core-medication](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html) profile]",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
200
+ hl7.fhir.us.davinci-crd_2.0.1,294,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [service] orders (and any associated resources) SHALL comply with the [profile-servicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html) profile",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
201
+ hl7.fhir.us.davinci-crd_2.0.1,295,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [vision] orders (and any associated resources) SHALL comply with the [profile-visionprescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html) profile",SHALL,Client,,,,"2.4.09, 2.5.09, 2.6.09","crd_client-crd_client_hooks-crd_client_order_select-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_dispatch-crd_hook_request_valid_context, crd_client-crd_client_hooks-crd_client_order_sign-crd_hook_request_valid_context"
202
+ hl7.fhir.us.davinci-crd_2.0.1,297,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion,CRD clients supporting this [Request form completion] card type SHALL support either approach [Card or systemAction],SHALL,Client,,,,"",""
203
+ hl7.fhir.us.davinci-crd_2.0.1,301,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion,[for the Request form completion response type] CRD Clients SHOULD retain a copy of all completed forms for future reference.,SHOULD,Client,,,,"",""
204
+ hl7.fhir.us.davinci-crd_2.0.1,303,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#create-or-update-coverage-information,CRD clients supporting this [Create or update coverage information] card type SHALL support either approach [Card or systemAction],SHALL,Client,,,,"",""
205
+ hl7.fhir.us.davinci-crd_2.0.1,304,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#create-or-update-coverage-information,"[for the Create or update coverage information response type] If receiving a system action, a CRD client MAY opt to place the new or updated record in a holding area for human review rather than directly modifying their source of truth.",MAY,Client,,,,"",""
206
+ hl7.fhir.us.davinci-crd_2.0.1,307,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#launch-smart-application,This [Launch SMART application] response type can cause the launching of ... [SMART] apps to occur in the context in which they are relevant to patient care and/or to payment-related decision-making,MAY,Client,,,,"",""
207
+ hl7.fhir.us.davinci-crd_2.0.1,308,https://hl7.org/fhir/us/davinci-crd/STU2/implementation.html#suppressing-guidance,"Clients that [suppress certain types of payer guidance as being the ‘default’ presumption. E.g. “Covered, no prior authorization required”] … SHALL mitigate this potential for misinterpretation.",SHALL,Client,,,,"",""
208
+ hl7.fhir.us.davinci-crd_2.0.1,311,https://hl7.org/fhir/us/davinci-crd/STU2/implementation.html#impact-on-payer-processes,"In situations where CRD Clients are aware of the likely billing codes at the time of ordering, they MAY send these codes as additional CodeableConcept.coding repetitions to assist in server processing.",MAY,Client,,,,"",""