davinci_crd_test_kit 0.14.0 → 0.14.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.
- checksums.yaml +4 -4
- data/config/presets/{inferno_crd_server_suite.json.erb → client_against_inferno_crd_server_suite.json.erb} +0 -33
- data/config/presets/{ri_crd_request_generator.json.erb → client_against_ri_crd_request_generator.json.erb} +1 -14
- data/config/presets/client_v221_against_inferno_crd_server_suite.json.erb +84 -0
- data/config/presets/client_v221_against_ri_br_provider.json.erb +31 -0
- data/config/presets/{ri_crd_request_generator.json_v221.json.erb → client_v221_against_ri_crd_request_generator.json.erb} +1 -1
- data/config/presets/{inferno_crd_client_suite.json.erb → server_against_inferno_crd_client_suite.json.erb} +0 -43
- data/config/presets/{ri_crd_server.json.erb → server_against_ri_crd_server.json.erb} +1 -44
- data/config/presets/{inferno_crd_client_suite_v221.json.erb → server_v221_against_inferno_crd_client_suite.json.erb} +48 -45
- data/config/presets/{inferno_crd_client_suite_prefetch_subset_v221.json.erb → server_v221_against_inferno_crd_client_suite_prefetch_subset.json.erb} +0 -46
- data/config/presets/server_v221_against_inferno_g31_suite.json.erb +49 -0
- data/lib/davinci_crd_test_kit/client/cross_hook_helper.rb +26 -0
- data/lib/davinci_crd_test_kit/client/endpoints/custom_service_response.rb +7 -7
- data/lib/davinci_crd_test_kit/client/endpoints/gather_response_generation_data.rb +4 -1
- data/lib/davinci_crd_test_kit/client/endpoints/hook_request_endpoint.rb +70 -39
- data/lib/davinci_crd_test_kit/client/endpoints/mock_service_response.rb +26 -7
- data/lib/davinci_crd_test_kit/client/endpoints/mocked_card_responses/external_reference.json +1 -1
- data/lib/davinci_crd_test_kit/client/endpoints/mocked_card_responses/launch_smart_app.json +0 -7
- data/lib/davinci_crd_test_kit/client/endpoints/scenario_service_response.rb +54 -0
- data/lib/davinci_crd_test_kit/client/tagged_request_load_helper.rb +8 -27
- data/lib/davinci_crd_test_kit/client/v2.0.1/auth/retrieve_jwks_test.rb +35 -23
- data/lib/davinci_crd_test_kit/client/v2.0.1/auth/token_payload_test.rb +34 -21
- data/lib/davinci_crd_test_kit/client/v2.0.1/cds-services-v201.json +20 -20
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_appointment_book_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_encounter_discharge_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_encounter_start_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_hooks_group.rb +5 -5
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_dispatch_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_select_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_sign_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_coverage_information.rb +3 -36
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_external_reference.rb +3 -36
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_instructions.rb +3 -36
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_fetched_data_test.rb +4 -13
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_prefetch_equals_queried_test.rb +3 -13
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_response/client_display_cards_attest.rb +3 -13
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_response/inferno_response_validation.rb +3 -13
- data/lib/davinci_crd_test_kit/client/v2.2.1/api/client_coverage_info_update_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/attestation_instructions.rb +10 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_authorized_scope_attestation_test.rb +45 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_coverage_based_invocation_attestation_test.rb +44 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_data_element_expectations_attestation_test.rb +44 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_hook_invocation_logging_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_must_support_exposure_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_must_support_use_attestation_test.rb +41 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_order_sign_support_attestation_test.rb +42 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_prefetch_key_omission_attestation_test.rb +42 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_resource_identifiers_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_response_case_distinction_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_security_and_privacy_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_workflow_integration_attestation_test.rb +44 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/decode_auth_token_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/retrieve_jwks_test.rb +29 -18
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/token_payload_test.rb +35 -22
- data/lib/davinci_crd_test_kit/client/v2.2.1/cds-services-prefetch-subset-v221.json +47 -47
- data/lib/davinci_crd_test_kit/client/v2.2.1/cds-services-v221.json +50 -50
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_appointment_book_group.rb +24 -15
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_attestations_group.rb +49 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_cross_hook_group.rb +22 -6
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_cross_hook_interaction_group.rb +98 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_encounter_discharge_group.rb +19 -11
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_encounter_start_group.rb +19 -11
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_fhir_api_group.rb +14 -12
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_hooks_group.rb +25 -5
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_long_running_hook_group.rb +3 -2
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_dispatch_group.rb +23 -15
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_select_group.rb +19 -11
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_sign_group.rb +23 -15
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_registration_group.rb +6 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_scenarios_group.rb +26 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_self_pay_hook_group.rb +36 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_unknown_content_hook_group.rb +34 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/crd_client_suite.rb +24 -3
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_card_must_support_coverage_information_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_fhirpath_collection_as_comma_delimited_string_test.rb +4 -11
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_hook_instances_unique_test.rb +1 -9
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_location_address_propagation_test.rb +6 -2
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_prefetch_complete_and_subset_test.rb +3 -12
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/appointment_book_receive_request_test.rb +8 -89
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/base_hook_invocation_receive_request_test.rb +163 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/cross_hooks_receive_request_test.rb +97 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/encounter_discharge_receive_request_test.rb +8 -90
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/encounter_start_receive_request_test.rb +8 -90
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_dispatch_receive_request_test.rb +8 -98
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_select_receive_request_test.rb +8 -98
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_sign_receive_request_test.rb +8 -98
- data/lib/davinci_crd_test_kit/client/v2.2.1/long_running/client_long_running_receive_request_test.rb +10 -2
- data/lib/davinci_crd_test_kit/client/v2.2.1/long_running/client_skip_long_running_attestation_test.rb +11 -6
- data/lib/davinci_crd_test_kit/client/v2.2.1/registration/client_service_registration_attestation_test.rb +2 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/self_pay/client_self_pay_no_request_test.rb +30 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/self_pay/client_self_pay_workflow_test.rb +55 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/unknown_content/client_unknown_content_attestation_test.rb +99 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/unknown_content/client_unknown_content_receive_request_test.rb +62 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_conformance_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_coverage_verification_test.rb +10 -2
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_data_fetch_verification_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_granted_scopes_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_prefetch_complete_test.rb +7 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_prefetch_profiles_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_requested_version_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_secured_transport_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/client_display_cards_attest.rb +54 -21
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/hook_response_support_coverage_information_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/inferno_response_validation.rb +6 -3
- data/lib/davinci_crd_test_kit/cross_suite/cards_identification.rb +18 -0
- data/lib/davinci_crd_test_kit/cross_suite/logical_models_override_helper.rb +30 -13
- data/lib/davinci_crd_test_kit/cross_suite/prefetch_completeness_checker.rb +25 -11
- data/lib/davinci_crd_test_kit/cross_suite/prefetch_profile_validation.rb +2 -0
- data/lib/davinci_crd_test_kit/cross_suite/requests_logical_model_validation.rb +28 -28
- data/lib/davinci_crd_test_kit/cross_suite/response_logical_model_validation.rb +211 -43
- data/lib/davinci_crd_test_kit/cross_suite/tags.rb +7 -0
- data/lib/davinci_crd_test_kit/requirements/cds-hooks_3.0.0-ballot_requirements.xlsx +0 -0
- data/lib/davinci_crd_test_kit/requirements/davinci_crd_test_kit_requirements.csv +6 -2
- data/lib/davinci_crd_test_kit/requirements/generated/crd_client_requirements_coverage.csv +107 -107
- data/lib/davinci_crd_test_kit/requirements/generated/crd_client_v221_requirements_coverage.csv +101 -97
- data/lib/davinci_crd_test_kit/requirements/generated/crd_server_requirements_coverage.csv +18 -18
- data/lib/davinci_crd_test_kit/requirements/generated/crd_server_v221_requirements_coverage.csv +43 -39
- data/lib/davinci_crd_test_kit/requirements/hl7.fhir.us.davinci-crd_2.2.1_requirements.xlsx +0 -0
- data/lib/davinci_crd_test_kit/server/jobs/invoke_hook.rb +3 -3
- data/lib/davinci_crd_test_kit/server/jobs/invoke_hook_no_special_requests.rb +17 -0
- data/lib/davinci_crd_test_kit/server/jobs/invoke_hook_with_bad_auth.rb +14 -0
- data/lib/davinci_crd_test_kit/server/server_abstract_invoke_hook_test.rb +24 -6
- data/lib/davinci_crd_test_kit/server/server_hook_helper.rb +2 -2
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_server_suite.rb +1 -1
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_hooks_group.rb +5 -5
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_server_suite.rb +3 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/discovery/discovery_standard_prefetch_expressions_test.rb +165 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/interaction/server_invoke_hook_single_request_test.rb +22 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_appointment_book_group.rb +10 -102
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_demonstrate_hook_response_group.rb +3 -2
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_discovery_group.rb +2 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_encounter_discharge_group.rb +10 -97
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_encounter_start_group.rb +10 -97
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_hooks_group.rb +5 -5
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_dispatch_group.rb +10 -103
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_select_group.rb +12 -116
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_sign_group.rb +12 -121
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_response_group.rb +23 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/coverage_info_reason_test.rb +108 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/coverage_not_found_group.rb +116 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/no_active_coverage_group.rb +115 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/no_member_found_group.rb +117 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/technical_issues_group.rb +121 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/technical_issues_invoke_test.rb +22 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_context_validation_test.rb +1 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_optional_fields_validation_test.rb +1 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_required_fields_validation_test.rb +1 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/additional_orders_validation_test.rb +78 -35
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_information_card_absence_test.rb +76 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_information_system_action_validation_test.rb +70 -124
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/create_or_update_coverage_info_response_validation_test.rb +83 -39
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/external_reference_card_validation_test.rb +59 -17
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/form_completion_response_validation_test.rb +80 -45
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/hook_request_resource_resolution.rb +37 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/instructions_card_received_test.rb +57 -6
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/launch_smart_app_card_validation_test.rb +56 -17
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/propose_alternate_request_card_validation_test.rb +52 -25
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/service_response_validation_test.rb +17 -51
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_cds_hooks_elements_test.rb +1 -1
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_configuration_test.rb +1 -1
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_context_test.rb +1 -1
- data/lib/davinci_crd_test_kit/version.rb +2 -2
- metadata +54 -16
- data/config/presets/inferno_crd_server_suite_v221.json.erb +0 -94
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/card_optional_fields_validation_test.rb +0 -57
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_information_system_action_received_test.rb +0 -65
data/lib/davinci_crd_test_kit/requirements/generated/crd_client_v221_requirements_coverage.csv
CHANGED
|
@@ -1,32 +1,32 @@
|
|
|
1
1
|
Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,Da Vinci CRD Client v2.2.1 Test Suite Short ID(s),Da Vinci CRD Client v2.2.1 Test Suite Full ID(s)
|
|
2
|
-
hl7.fhir.us.davinci-crd_2.2.1,billopt-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-ext-billing-options.html#ci-c-billopt-1,"CRD clients **SHALL** use the billing-options extension to convey likely billing codes if they are known, but are not required to know billing codes (e.g. if ordering and performing systems will differ).",SHALL,CRD Client,true,,,"1.2.1.3.01, 1.2.2.3.01, 1.2.3.3.01, 1.2.4.3.01, 1.2.5.3.01, 1.2.6.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
2
|
+
hl7.fhir.us.davinci-crd_2.2.1,billopt-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-ext-billing-options.html#ci-c-billopt-1,"CRD clients **SHALL** use the billing-options extension to convey likely billing codes if they are known, but are not required to know billing codes (e.g. if ordering and performing systems will differ).",SHALL,CRD Client,true,,,"1.2.1.3.01, 1.2.2.3.01, 1.2.3.3.01, 1.2.4.3.01, 1.2.5.3.01, 1.2.6.3.01, 1.4.1.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_conformance"
|
|
3
3
|
hl7.fhir.us.davinci-crd_2.2.1,conf-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-1,CRD clients **SHALL** support at least one of the three specified versions of US Core.,SHALL,CRD Client,false,,,2,crd_client_v221-crd_v221_client_fhir_api
|
|
4
|
-
hl7.fhir.us.davinci-crd_2.2.1,conf-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-3,"If the CRD client maintains a mustSupport 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,CRD Client,true,,,
|
|
5
|
-
hl7.fhir.us.davinci-crd_2.2.1,conf-6,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-6,CRD clients **SHALL** make the mustSupport data available to the appropriate user (clinical or administrative) or leverage the data within their workflow as necessary to follow the intention of the provided decision support.,SHALL,CRD Client,false,,,
|
|
6
|
-
hl7.fhir.us.davinci-crd_2.2.1,conf-10,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-10,CRD clients **SHALL NOT** depend on or set expectations for CRD servers to communicate data elements not marked as mandatory or mustSupport in the CRD specification.,SHALL NOT,CRD Client,false,,,"",""
|
|
4
|
+
hl7.fhir.us.davinci-crd_2.2.1,conf-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-3,"If the CRD client maintains a mustSupport 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,CRD Client,true,,,3.05,crd_client_v221-crd_v221_client_attestations-crd_v221_must_support_exposure_attestation
|
|
5
|
+
hl7.fhir.us.davinci-crd_2.2.1,conf-6,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-6,CRD clients **SHALL** make the mustSupport data available to the appropriate user (clinical or administrative) or leverage the data within their workflow as necessary to follow the intention of the provided decision support.,SHALL,CRD Client,false,,,3.12,crd_client_v221-crd_v221_client_attestations-crd_v221_must_support_use_attestation
|
|
6
|
+
hl7.fhir.us.davinci-crd_2.2.1,conf-10,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-10,CRD clients **SHALL NOT** depend on or set expectations for CRD servers to communicate data elements not marked as mandatory or mustSupport in the CRD specification.,SHALL NOT,CRD Client,false,,,"1.2.1.2.02, 1.2.2.2.02, 1.2.3.2.02, 1.2.4.2.02, 1.2.5.2.02, 1.2.6.2.02, 1.4.1.2.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group02-crd_v221_inferno_response_validation"
|
|
7
7
|
hl7.fhir.us.davinci-crd_2.2.1,conf-11,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-11,"implementations **MAY**, by mutual agreement, pre-adopt the use of those additional CI-build profiles and/or mustSupport data elements and not be considered in violation of #1 or #3 above.",MAY,"CRD Client,CRD Server",true,,,"",""
|
|
8
|
-
hl7.fhir.us.davinci-crd_2.2.1,conf-12,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-12,"Where cardinality and other constraints present in profiles allow data elements to be omitted, CRD compliant systems **SHALL NOT** treat the omission of those elements as an error.",SHALL NOT,"CRD Client,CRD Server",true,,,
|
|
9
|
-
hl7.fhir.us.davinci-crd_2.2.1,conf-13,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-13,CRD clients and services and **SHALL** use standard CRD data elements (i.e. elements found within CRD-defined or inherited profiles and marked as mandatory or mustSupport) to communicate needed data where the elements are intended to convey such information.,SHALL,"CRD Client,CRD Server",false,,,
|
|
10
|
-
hl7.fhir.us.davinci-crd_2.2.1,dev-3-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-3,The requestedVersion extension **SHALL** be present if the service indicates it supports multiple versions for that hook,SHALL,CRD Client,true,,,"1.2.1.3.02, 1.2.2.3.02, 1.2.3.3.02, 1.2.4.3.02, 1.2.5.3.02, 1.2.6.3.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
8
|
+
hl7.fhir.us.davinci-crd_2.2.1,conf-12,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-12,"Where cardinality and other constraints present in profiles allow data elements to be omitted, CRD compliant systems **SHALL NOT** treat the omission of those elements as an error.",SHALL NOT,"CRD Client,CRD Server",true,,,3.03,crd_client_v221-crd_v221_client_attestations-crd_v221_data_element_expectations_attestation
|
|
9
|
+
hl7.fhir.us.davinci-crd_2.2.1,conf-13,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformance.html#ci-c-conf-13,CRD clients and services and **SHALL** use standard CRD data elements (i.e. elements found within CRD-defined or inherited profiles and marked as mandatory or mustSupport) to communicate needed data where the elements are intended to convey such information.,SHALL,"CRD Client,CRD Server",false,,,3.03,crd_client_v221-crd_v221_client_attestations-crd_v221_data_element_expectations_attestation
|
|
10
|
+
hl7.fhir.us.davinci-crd_2.2.1,dev-3-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-3,The requestedVersion extension **SHALL** be present if the service indicates it supports multiple versions for that hook,SHALL,CRD Client,true,,,"1.2.1.3.02, 1.2.2.3.02, 1.2.3.3.02, 1.2.4.3.02, 1.2.5.3.02, 1.2.6.3.02, 1.4.1.3.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_requested_version"
|
|
11
11
|
hl7.fhir.us.davinci-crd_2.2.1,dev-3-B,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-3,The requestedVersion extension ... **MAY** be present always.,MAY,CRD Client,true,,,"",""
|
|
12
12
|
hl7.fhir.us.davinci-crd_2.2.1,dev-11,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-11,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,CRD Client,false,,,"",""
|
|
13
|
-
hl7.fhir.us.davinci-crd_2.2.1,dev-12,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-12,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,CRD Client,false,,,"1.2.1.3.02, 1.2.2.3.02, 1.2.3.3.02, 1.2.4.3.02, 1.2.5.3.02, 1.2.6.3.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
13
|
+
hl7.fhir.us.davinci-crd_2.2.1,dev-12,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-12,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,CRD Client,false,,,"1.2.1.3.02, 1.2.2.3.02, 1.2.3.3.02, 1.2.4.3.02, 1.2.5.3.02, 1.2.6.3.02, 1.4.1.3.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_requested_version"
|
|
14
14
|
hl7.fhir.us.davinci-crd_2.2.1,dev-13,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-13,"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,CRD Client,false,,,"",""
|
|
15
15
|
hl7.fhir.us.davinci-crd_2.2.1,dev-16,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-16,CRD Clients **MAY** send configuration information that CRD Servers do not support.,MAY,CRD Client,false,,,"",""
|
|
16
16
|
hl7.fhir.us.davinci-crd_2.2.1,dev-21,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-21,"For the purposes of this implementation guide, 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,CRD Client,false,,,"",""
|
|
17
17
|
hl7.fhir.us.davinci-crd_2.2.1,dev-22,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-22,"Specifically, this means that 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 CRD client to point to the `id` assigned by the client when performing the 'create'.",SHALL,CRD Client,false,,,"",""
|
|
18
18
|
hl7.fhir.us.davinci-crd_2.2.1,dev-23,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-23,CRD Clients **SHALL** perform 'creates' in an order that ensures that referenced resources are created prior to referencing resources.,SHALL,CRD Client,false,,,"",""
|
|
19
|
-
hl7.fhir.us.davinci-crd_2.2.1,dev-26,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-26,CRD clients **SHALL** only invoke hooks on payer services where the patient record indicates active coverage with the payer associated with the service and where there is no recorded indication the patient intends to bypass insurance coverage (i.e. the service or product is not flagged as 'patient-pay').,SHALL,CRD Client,false,,,
|
|
19
|
+
hl7.fhir.us.davinci-crd_2.2.1,dev-26,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-26,CRD clients **SHALL** only invoke hooks on payer services where the patient record indicates active coverage with the payer associated with the service and where there is no recorded indication the patient intends to bypass insurance coverage (i.e. the service or product is not flagged as 'patient-pay').,SHALL,CRD Client,false,,,1.3.3.02,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_scenarios-crd_v221_client_self_pay_hook-crd_v221_client_self_pay_no_request
|
|
20
20
|
hl7.fhir.us.davinci-crd_2.2.1,dev-27,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-27,"CRD clients **MAY** limit hook invocation to only those payers that are believed to potentially have relevant information related to the current action - for example, clinical guidance, contraindication detection, etc.",MAY,CRD Client,false,,,"",""
|
|
21
|
-
hl7.fhir.us.davinci-crd_2.2.1,dev-28,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-28,"To avoid confusion for providers, where a patient has multiple active coverages that could be relevant to the current order/appointment/etc., CRD clients **SHALL** select from those coverages which is most likely to be primary and only solicit coverage information for that one payer.",SHALL,CRD Client,true,,,
|
|
22
|
-
hl7.fhir.us.davinci-crd_2.2.1,dev-29-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-29,This primary coverage **SHALL** be the only one included in the prefetch content as part of the CRD request,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.1.3.05, 1.2.2.3.04, 1.2.2.3.05, 1.2.3.3.04, 1.2.3.3.05, 1.2.4.3.04, 1.2.4.3.05, 1.2.5.3.04, 1.2.5.3.05, 1.2.6.3.04, 1.2.6.3.05","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
21
|
+
hl7.fhir.us.davinci-crd_2.2.1,dev-28,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-28,"To avoid confusion for providers, where a patient has multiple active coverages that could be relevant to the current order/appointment/etc., CRD clients **SHALL** select from those coverages which is most likely to be primary and only solicit coverage information for that one payer.",SHALL,CRD Client,true,,,3.07,crd_client_v221-crd_v221_client_attestations-crd_v221_coverage_based_invocation_attestation
|
|
22
|
+
hl7.fhir.us.davinci-crd_2.2.1,dev-29-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-29,This primary coverage **SHALL** be the only one included in the prefetch content as part of the CRD request,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.1.3.05, 1.2.2.3.04, 1.2.2.3.05, 1.2.3.3.04, 1.2.3.3.05, 1.2.4.3.04, 1.2.4.3.05, 1.2.5.3.04, 1.2.5.3.05, 1.2.6.3.04, 1.2.6.3.05, 1.4.1.3.04, 1.4.1.3.05","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_coverage_verification"
|
|
23
23
|
hl7.fhir.us.davinci-crd_2.2.1,dev-29-B,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-29,[O]ther [non-primary] coverages **MAY** be exposed over the CRD client's FHIR API.,MAY,CRD Client,false,,,"",""
|
|
24
|
-
hl7.fhir.us.davinci-crd_2.2.1,dev-30,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-30,"If they invoke CRD on other payers, CRD clients **SHALL** ensure that response types that return coverage information are disabled for those 'likely secondary' payers.",SHALL,CRD Client,true,,,
|
|
24
|
+
hl7.fhir.us.davinci-crd_2.2.1,dev-30,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-30,"If they invoke CRD on other payers, CRD clients **SHALL** ensure that response types that return coverage information are disabled for those 'likely secondary' payers.",SHALL,CRD Client,true,,,3.07,crd_client_v221-crd_v221_client_attestations-crd_v221_coverage_based_invocation_attestation
|
|
25
25
|
hl7.fhir.us.davinci-crd_2.2.1,dev-31,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-31,"In situations where a CRD client determines that there are different primary coverages for different items in the same order action, they **MAY** choose to send separate CRD calls (each with its own access token) for the collection of services pertinent to that Coverage.",MAY,CRD Client,true,,,"",""
|
|
26
|
-
hl7.fhir.us.davinci-crd_2.2.1,dev-32,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-32,"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,CRD Client,true,,,
|
|
26
|
+
hl7.fhir.us.davinci-crd_2.2.1,dev-32,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#ci-c-dev-32,"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,CRD Client,true,,,3.07,crd_client_v221-crd_v221_client_attestations-crd_v221_coverage_based_invocation_attestation
|
|
27
27
|
hl7.fhir.us.davinci-crd_2.2.1,found-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-1,"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,"CRD Client,CRD Server",false,,,"",""
|
|
28
28
|
hl7.fhir.us.davinci-crd_2.2.1,found-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-3,"If a CRD client does not receive a response within the 5 or 10-second window, it **MAY** either abandon the call or process the response asynchronously.",MAY,CRD Client,true,,,"",""
|
|
29
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-6,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-6,CRD clients **SHALL** provide a mechanism for providers to bypass a CRD process that is taking longer than the aforementioned time limit to ensure users are not blocked from proceeding with their business flow.,SHALL,CRD Client,false,,,1.
|
|
29
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-6,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-6,CRD clients **SHALL** provide a mechanism for providers to bypass a CRD process that is taking longer than the aforementioned time limit to ensure users are not blocked from proceeding with their business flow.,SHALL,CRD Client,false,,,1.3.1.02,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_scenarios-crd_v221_client_long_running_hook-crd_v221_client_skip_long_running_attestation_test
|
|
30
30
|
hl7.fhir.us.davinci-crd_2.2.1,found-7,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-7,"Where a CRD client opts to not block users from proceeding for responses that come back in a period of time longer than the target time window in this guide (i.e., 5s or 10s), the client **SHOULD** ensure that users are made aware of the information when it is available.",SHOULD,CRD Client,false,,,"",""
|
|
31
31
|
hl7.fhir.us.davinci-crd_2.2.1,found-8,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-8,"For responses that come back in a time period that exceeds the time maximm duration specifd in this guide, CRD clients **MAY** ignore the resulting cards and/or system actions.",MAY,CRD Client,true,,,"",""
|
|
32
32
|
hl7.fhir.us.davinci-crd_2.2.1,found-12,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-12,"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,CRD Client,true,,,"",""
|
|
@@ -34,95 +34,99 @@ hl7.fhir.us.davinci-crd_2.2.1,found-16,https://hl7.org/fhir/us/davinci-crd/2.2.1
|
|
|
34
34
|
hl7.fhir.us.davinci-crd_2.2.1,found-17,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-17,"If a CRD client encounters an error when invoking a hook, they **SHOULD** re-run the discovery process before failing.",SHOULD,CRD Client,true,,,"",""
|
|
35
35
|
hl7.fhir.us.davinci-crd_2.2.1,found-18,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-18,CRD clients and servers **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,"CRD Client,CRD Server",false,,,"",""
|
|
36
36
|
hl7.fhir.us.davinci-crd_2.2.1,found-19,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-19,"Once plans are in the national directory, CRD clients **SHOULD** include that plan identifier to uniquely identify a plan.",SHOULD,CRD Client,true,,,"",""
|
|
37
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-20,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-20,"When a CRD client invokes a CRD server via CDS Hooks, it **SHALL** provide an access token that allows the CRD server to retrieve additional patient information.",SHALL,CRD Client,false,,,"1.2.1.3.06, 1.2.2.3.06, 1.2.3.3.06, 1.2.4.3.06, 1.2.5.3.06, 1.2.6.3.06","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_data_fetch_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_data_fetch_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
38
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-21,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-21,The CRD client **SHALL** limit the scopes provided in their access token as narrowly as feasible to reflect the data requirements identified by the CRD server as necessary to perform their decision support.,SHALL,CRD Client,false,,,"1.2.1.3.07, 1.2.2.3.07, 1.2.3.3.07, 1.2.4.3.07, 1.2.5.3.07, 1.2.6.3.07","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_granted_scopes, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_granted_scopes, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
37
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-20,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-20,"When a CRD client invokes a CRD server via CDS Hooks, it **SHALL** provide an access token that allows the CRD server to retrieve additional patient information.",SHALL,CRD Client,false,,,"1.2.1.3.06, 1.2.2.3.06, 1.2.3.3.06, 1.2.4.3.06, 1.2.5.3.06, 1.2.6.3.06, 1.4.1.3.06","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_data_fetch_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_data_fetch_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_data_fetch_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_data_fetch_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_data_fetch_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_data_fetch_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_data_fetch_verification"
|
|
38
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-21,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-21,The CRD client **SHALL** limit the scopes provided in their access token as narrowly as feasible to reflect the data requirements identified by the CRD server as necessary to perform their decision support.,SHALL,CRD Client,false,,,"1.2.1.3.07, 1.2.2.3.07, 1.2.3.3.07, 1.2.4.3.07, 1.2.5.3.07, 1.2.6.3.07, 1.4.1.3.07","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_granted_scopes, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_granted_scopes, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_granted_scopes, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_granted_scopes, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_granted_scopes, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_granted_scopes, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_granted_scopes"
|
|
39
39
|
hl7.fhir.us.davinci-crd_2.2.1,found-22,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-22,Such access tokens **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 continues to work while the decision support call is processing.,SHOULD,CRD Client,false,,,"",""
|
|
40
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-23,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-23,CRD Clients **SHALL** be able to parse and execute prefetches that use the simple FHIRPath approach and not fail if that syntax is present.,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
41
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-24,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-24,"For this release of the IG, conformant CRD clients and servers **SHALL** support the CDS Hooks prefetch capability.",SHALL,"CRD Client,CRD Server",false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
42
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-25-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-25,Clients **SHALL** be able to supply the information listed in the bullets above via prefetch for the request resources they support when data exists using the search parameters and FHIRPath expressions covered in the [standard prefetch](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformancedetails.html#standard-prefetch) section below. This includes the ability to fetch subsets of the specified queries.,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.3.
|
|
43
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-25-B,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-25,Clients **SHALL** be able to supply ... subsets of the specified [prefetch] queries.,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.3.
|
|
40
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-23,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-23,CRD Clients **SHALL** be able to parse and execute prefetches that use the simple FHIRPath approach and not fail if that syntax is present.,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
41
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-24,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-24,"For this release of the IG, conformant CRD clients and servers **SHALL** support the CDS Hooks prefetch capability.",SHALL,"CRD Client,CRD Server",false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
42
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-25-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-25,Clients **SHALL** be able to supply the information listed in the bullets above via prefetch for the request resources they support when data exists using the search parameters and FHIRPath expressions covered in the [standard prefetch](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformancedetails.html#standard-prefetch) section below. This includes the ability to fetch subsets of the specified queries.,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04, 1.4.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_additional_capabilities-crd_v221_client_prefetch_complete_and_subset"
|
|
43
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-25-B,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-25,Clients **SHALL** be able to supply ... subsets of the specified [prefetch] queries.,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04, 1.4.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_additional_capabilities-crd_v221_client_prefetch_complete_and_subset"
|
|
44
44
|
hl7.fhir.us.davinci-crd_2.2.1,found-30,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-30,CRD client implementations **SHOULD NOT** depend on standardized prefetch key names or a specific ordering of search filters.,SHOULD NOT,CRD Client,false,,,"",""
|
|
45
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-31,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-31,CRD clients **SHALL** inspect the CDS Hooks discovery endpoint to determine exact prefetch key names and queries.,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
46
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-33,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-33,CRD clients and servers **SHALL** ignore unexpected elements when processing instances.,SHALL,"CRD Client,CRD Server",false,,,"",""
|
|
45
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-31,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-31,CRD clients **SHALL** inspect the CDS Hooks discovery endpoint to determine exact prefetch key names and queries.,SHALL,CRD Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
46
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-33,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-33,CRD clients and servers **SHALL** ignore unexpected elements when processing instances.,SHALL,"CRD Client,CRD Server",false,,,"1.3.2.02, 3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_scenarios-crd_v221_client_unknown_content_hook-crd_v221_client_unknown_content_attestation_test, crd_client_v221-crd_v221_client_attestations-crd_v221_data_element_expectations_attestation"
|
|
47
47
|
hl7.fhir.us.davinci-crd_2.2.1,found-35-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-35,"In the specific case of order-based hooks, ""what if"" **SHOULD** use the Order Sign hook",SHOULD,CRD Client,false,,,"",""
|
|
48
48
|
hl7.fhir.us.davinci-crd_2.2.1,found-35-B,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-35,"In the specific case of order-based hooks, ""what if"" ... **SHALL** pass the [unsolicited-determ](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/ValueSet-cardType.html#expansion) configuration option with a value of 'false' to prevent the return of an unsolicited determination",SHALL,CRD Client,false,,,"",""
|
|
49
49
|
hl7.fhir.us.davinci-crd_2.2.1,found-35-C,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-35,"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,CRD Client,false,,,"",""
|
|
50
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-36-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-36,"When CRD clients pass resources to a CRD server as part of context, the resources **SHALL** have an 'id'",SHALL,CRD Client,false,,,"1.2.1.3.01, 1.2.2.3.01, 1.2.3.3.01, 1.2.4.3.01, 1.2.5.3.01, 1.2.6.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
50
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-36-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-36,"When CRD clients pass resources to a CRD server as part of context, the resources **SHALL** have an 'id'",SHALL,CRD Client,false,,,"1.2.1.3.01, 1.2.2.3.01, 1.2.3.3.01, 1.2.4.3.01, 1.2.5.3.01, 1.2.6.3.01, 1.4.1.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_conformance"
|
|
51
51
|
hl7.fhir.us.davinci-crd_2.2.1,found-36-B,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-36,"When CRD clients pass resources to a CRD server as part of context, the ... 'id' [of each resource] **SHALL** be usable as a target for references [(in resource ids and Reference elements)] in resources manipulated by CDS Hooks actions and/or by SMART apps.",SHALL,CRD Client,false,,,"2.1.2.01, 2.2.2.01, 2.3.2.01","crd_client_v221-crd_v221_client_fhir_api-us_core_v311_fhir_api-crd_v221_us_core_311_client_update_verification-crd_v221_client_coverage_info_update, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-crd_v221_us_core_610_client_update_verification-crd_v221_client_coverage_info_update, crd_client_v221-crd_v221_client_fhir_api-us_core_v700_fhir_api-crd_v221_us_core_700_client_update_verification-crd_v221_client_coverage_info_update"
|
|
52
|
-
hl7.fhir.us.davinci-crd_2.2.1,found-37,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-37,"Therefore, in addition to any logging performed for security purposes, both CRD clients and CRD servers **SHALL** retain logs of all CRD-related hook invocations and their responses for access in the event of a dispute.",SHALL,"CRD Client,CRD Server",false,,,
|
|
52
|
+
hl7.fhir.us.davinci-crd_2.2.1,found-37,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-37,"Therefore, in addition to any logging performed for security purposes, both CRD clients and CRD servers **SHALL** retain logs of all CRD-related hook invocations and their responses for access in the event of a dispute.",SHALL,"CRD Client,CRD Server",false,,,3.09,crd_client_v221-crd_v221_client_attestations-crd_v221_hook_invocation_logging_attestation
|
|
53
53
|
hl7.fhir.us.davinci-crd_2.2.1,found-39,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-39,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,CRD Client,false,,,"",""
|
|
54
54
|
hl7.fhir.us.davinci-crd_2.2.1,found-40,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#ci-c-found-40,Conformant systems **SHOULD** omit non-significant whitespace in transmitted instances for performance reasons.,SHOULD,"CRD Client,CRD Server",false,,,"",""
|
|
55
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-1,CRD Clients conforming to this implementation guide **SHALL** be able to determine the correct payer CRD server to use for each request.,SHALL,CRD Client,false,,,"1.2.1.3.05, 1.2.2.3.05, 1.2.3.3.05, 1.2.4.3.05, 1.2.5.3.05, 1.2.6.3.05","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
56
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-2-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-2,CRD Clients conforming to this implementation guide **SHALL** support at least one of the hooks,SHALL,CRD Client,false,,,"1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.2.5, 1.2.6","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
57
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-2-B,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-2,"CRD Clients conforming to this implementation guide **SHALL** support ... (for order-centric hooks), at least one of the order resource types listed below",SHALL,CRD Client,false,,,"1.2.
|
|
55
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-1,CRD Clients conforming to this implementation guide **SHALL** be able to determine the correct payer CRD server to use for each request.,SHALL,CRD Client,false,,,"1.2.1.3.05, 1.2.2.3.05, 1.2.3.3.05, 1.2.4.3.05, 1.2.5.3.05, 1.2.6.3.05, 1.4.1.3.05","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_coverage_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_coverage_verification"
|
|
56
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-2-A,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-2,CRD Clients conforming to this implementation guide **SHALL** support at least one of the hooks,SHALL,CRD Client,false,,,"1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.2.5, 1.2.6","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge"
|
|
57
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-2-B,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-2,"CRD Clients conforming to this implementation guide **SHALL** support ... (for order-centric hooks), at least one of the order resource types listed below",SHALL,CRD Client,false,,,"1.2.3, 1.2.4, 1.2.5","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch"
|
|
58
58
|
hl7.fhir.us.davinci-crd_2.2.1,hook-2-C,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-2,CRD Clients conforming to this implementation guide … **SHOULD** support all [order resource types listed below] that apply to the context of their system [for order centric hooks].,SHOULD,CRD Client,false,,,"",""
|
|
59
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-3,"For systems that support ordering products or services covered by one of the CRD-supported request types, such clients **SHALL** support the order-sign hook for the order types they support.",SHALL,CRD Client,true,,,
|
|
59
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-3,"For systems that support ordering products or services covered by one of the CRD-supported request types, such clients **SHALL** support the order-sign hook for the order types they support.",SHALL,CRD Client,true,,,3.10,crd_client_v221-crd_v221_client_attestations-crd_v221_order_sign_support_attestation
|
|
60
60
|
hl7.fhir.us.davinci-crd_2.2.1,hook-5,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-5,CRD Clients and CRD Servers **MAY** choose to support additional hooks available in the registry on the [CDS Hooks continuous integration build](https://build.fhir.org/ig/HL7/cds-hooks-library) or custom hooks defined elsewhere.,MAY,"CRD Client,CRD Server",false,,,"",""
|
|
61
61
|
hl7.fhir.us.davinci-crd_2.2.1,hook-6,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-6,"When supporting hooks not covered by this guide, systems **SHOULD** adhere to the general conformance expectations defined in this specification for those additional hooks.",SHOULD,"CRD Client,CRD Server",true,,,"",""
|
|
62
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-7,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-7,CRD clients **SHALL** allow hook invocation to occur transparently as part of user workflow.,SHALL,CRD Client,false,,,
|
|
63
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-8,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-8,"CRD clients **SHALL NOT** require transcription of order, appointment, or other data into a separate interface distinct from regular provider workflow unless performing ""what if"" situations.",SHALL NOT,CRD Client,true,,,
|
|
62
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-7,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-7,CRD clients **SHALL** allow hook invocation to occur transparently as part of user workflow.,SHALL,CRD Client,false,,,3.06,crd_client_v221-crd_v221_client_attestations-crd_v221_workflow_integration_attestation
|
|
63
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-8,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-8,"CRD clients **SHALL NOT** require transcription of order, appointment, or other data into a separate interface distinct from regular provider workflow unless performing ""what if"" situations.",SHALL NOT,CRD Client,true,,,3.06,crd_client_v221-crd_v221_client_attestations-crd_v221_workflow_integration_attestation
|
|
64
64
|
hl7.fhir.us.davinci-crd_2.2.1,hook-11,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-11,The CRD Client **MAY** display to the user that the Coverage Requirements Discovery Service is unavailable.,MAY,CRD Client,false,,,"",""
|
|
65
65
|
hl7.fhir.us.davinci-crd_2.2.1,hook-12,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-12,"If additional information (e.g. number to call) is available, it **MAY** also be included in the message to the user.",MAY,CRD Client,true,,,"",""
|
|
66
66
|
hl7.fhir.us.davinci-crd_2.2.1,hook-15,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-15,A CRD client **MAY** opt to re-invoke a CRD hook either due to manual user intervention or automatically in the background if there is a reason to believe that a substantive change in the patient's record and/or coverage might produce a different CRD response.,MAY,CRD Client,true,,,"",""
|
|
67
67
|
hl7.fhir.us.davinci-crd_2.2.1,hook-17,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-17,"These hooks **MAY** return cards or system actions, but are not expected to, and CRD clients are free to ignore any cards or actions returned.",MAY,CRD Client,false,,,"",""
|
|
68
68
|
hl7.fhir.us.davinci-crd_2.2.1,hook-18,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-18,CRD clients **SHOULD** use the [configuration options](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/deviations.html#new-hook-configuration-mechanism) to instruct CRD servers to not even try to return responses if the client does not intend to display/process them.,SHOULD,CRD Client,true,,,"",""
|
|
69
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-20,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-20,"The body of hook invocations **SHALL** conform to the [CRD CDSHooks Request logical model. Additionally, profiles are provided in a table for the hook sections below.",SHALL,CRD Client,false,,,"1.2.1.3.01, 1.2.2.3.01, 1.2.3.3.01, 1.2.4.3.01, 1.2.5.3.01, 1.2.6.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
70
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-21,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-21,CRD clients **SHALL** ensure that data included in the hook invocation complies with the listed profiles.,SHALL,CRD Client,false,,,"1.2.1.3.01, 1.2.1.3.03, 1.2.2.3.01, 1.2.2.3.03, 1.2.3.3.01, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.01, 1.2.5.3.03, 1.2.6.3.01, 1.2.6.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
69
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-20,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-20,"The body of hook invocations **SHALL** conform to the [CRD CDSHooks Request logical model. Additionally, profiles are provided in a table for the hook sections below.",SHALL,CRD Client,false,,,"1.2.1.3.01, 1.2.2.3.01, 1.2.3.3.01, 1.2.4.3.01, 1.2.5.3.01, 1.2.6.3.01, 1.4.1.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_conformance"
|
|
70
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-21,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-21,CRD clients **SHALL** ensure that data included in the hook invocation complies with the listed profiles.,SHALL,CRD Client,false,,,"1.2.1.3.01, 1.2.1.3.03, 1.2.2.3.01, 1.2.2.3.03, 1.2.3.3.01, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.01, 1.2.5.3.03, 1.2.6.3.01, 1.2.6.3.03, 1.4.1.3.01, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
71
71
|
hl7.fhir.us.davinci-crd_2.2.1,hook-24,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-24,The 'context' field in invocations of the appointment-book hook **SHALL** conform to the logical model specified [here](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-CRDAppointmentBookContext.html),SHALL,CRD Client,true,,,1.2.1.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance
|
|
72
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-26,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-26,"CRD clients and servers **SHALL**, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-ext-coverage-information.html) system action for all invocations of the appointment-book hook.",SHALL,"CRD Client,CRD Server",false,,,1.2.1.
|
|
73
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-27,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-27,The 'context' field in invocations of the encounter-start hook **SHALL** conform to the logical model specified [here](http://hl7.org/fhir/tools/1.1.2/StructureDefinition-CDSHookEncounterStartContext.html),SHALL,CRD Client,true,,,1.2.
|
|
72
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-26,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-26,"CRD clients and servers **SHALL**, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-ext-coverage-information.html) system action for all invocations of the appointment-book hook.",SHALL,"CRD Client,CRD Server",false,,,1.2.1.2.03,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group02-crd_v221_client_hook_response_support_coverage_information
|
|
73
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-27,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-27,The 'context' field in invocations of the encounter-start hook **SHALL** conform to the logical model specified [here](http://hl7.org/fhir/tools/1.1.2/StructureDefinition-CDSHookEncounterStartContext.html),SHALL,CRD Client,true,,,1.2.6.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance
|
|
74
74
|
hl7.fhir.us.davinci-crd_2.2.1,hook-29,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-29,The 'context' field in invocations of the encounter-discharge hook **SHALL** conform to the logical model specified [here](http://hl7.org/fhir/tools/1.1.2/StructureDefinition-CDSHookEncounterDischargeContext.html),SHALL,CRD Client,true,,,1.2.2.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance
|
|
75
75
|
hl7.fhir.us.davinci-crd_2.2.1,hook-31,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-31,The 'context' field in invocations of the order-dispatch hook **SHALL** conform to the logical model specified [here](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-CRDOrderDispatchContext.html),SHALL,CRD Client,true,,,1.2.5.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance
|
|
76
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-33,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-33,"CRD clients and servers **SHALL**, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-ext-coverage-information.html) system action for all invocations of the order-dispatch hook.",SHALL,"CRD Client,CRD Server",false,,,1.2.5.
|
|
77
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-35,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-35,The 'context' field in invocations of the order-select hook **SHALL** conform to the logical model specified [here](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-CRDOrderSelectContext.html),SHALL,CRD Client,true,,,1.2.
|
|
76
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-33,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-33,"CRD clients and servers **SHALL**, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-ext-coverage-information.html) system action for all invocations of the order-dispatch hook.",SHALL,"CRD Client,CRD Server",false,,,1.2.5.2.03,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group02-crd_v221_client_hook_response_support_coverage_information
|
|
77
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-35,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-35,The 'context' field in invocations of the order-select hook **SHALL** conform to the logical model specified [here](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-CRDOrderSelectContext.html),SHALL,CRD Client,true,,,1.2.3.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance
|
|
78
78
|
hl7.fhir.us.davinci-crd_2.2.1,hook-36,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-36,"Where CRD Clients have an appropriate workflow and data capture mechanism, the order-select hook **MAY** be used in scenarios that do not involve creating a true order.",MAY,CRD Client,true,,,"",""
|
|
79
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-37,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-37,The 'context' field in invocations of the order-sign hook **SHALL** conform to the logical model specified [here](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-CRDOrderSignContext.html),SHALL,CRD Client,true,,,1.2.
|
|
80
|
-
hl7.fhir.us.davinci-crd_2.2.1,hook-39,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-39,"CRD clients and servers **SHALL**, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-ext-coverage-information.html) system action for all invocations of the order-
|
|
81
|
-
hl7.fhir.us.davinci-crd_2.2.1,impl-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/implementation.html#ci-c-impl-1,Clients that suppress 'default presumption' coverage-information of messages **SHALL** mitigate the potential for misinterpretation in the event CRD is unavailable.,SHALL,CRD Client,false,,,
|
|
79
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-37,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-37,The 'context' field in invocations of the order-sign hook **SHALL** conform to the logical model specified [here](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-CRDOrderSignContext.html),SHALL,CRD Client,true,,,1.2.4.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance
|
|
80
|
+
hl7.fhir.us.davinci-crd_2.2.1,hook-39,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-39,"CRD clients and servers **SHALL**, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-ext-coverage-information.html) system action for all invocations of the order-sign hook.",SHALL,"CRD Client,CRD Server",false,,,1.2.4.2.03,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group02-crd_v221_client_hook_response_support_coverage_information
|
|
81
|
+
hl7.fhir.us.davinci-crd_2.2.1,impl-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/implementation.html#ci-c-impl-1,Clients that suppress 'default presumption' coverage-information of messages **SHALL** mitigate the potential for misinterpretation in the event CRD is unavailable.,SHALL,CRD Client,false,,,3.02,crd_client_v221-crd_v221_client_attestations-crd_v221_response_case_distinction_attestation
|
|
82
82
|
hl7.fhir.us.davinci-crd_2.2.1,impl-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/implementation.html#ci-c-impl-3,"Even if implemented using multiple components, there is still a requirement that the exchanges between the provider HIT (including any ePA coordinators) and the payer HIT (including any ePA coordinators) **SHALL** replicate all of the defined exchanges between provider and payer.",SHALL,"CRD Client,CRD Server",false,,,suite,crd_client_v221
|
|
83
83
|
hl7.fhir.us.davinci-crd_2.2.1,impl-4,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/implementation.html#ci-c-impl-4,"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,CRD Client,true,,,"",""
|
|
84
84
|
hl7.fhir.us.davinci-crd_2.2.1,metric-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/metrics.html#ci-c-metric-1,"Each of these IGs recommends a set of metrics that **SHOULD** or **MAY** be collected by their respective implementations to facilitate the evaluation of adoption, functionality, processes, and improved outcomes.",SHOULD,"CRD Client,CRD Server",false,,,"",""
|
|
85
85
|
hl7.fhir.us.davinci-crd_2.2.1,ops-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/operational.html#ci-c-ops-1,"CRD clients and servers **SHOULD** support encounter-start and order-select, both to allow payer caching and to allow payers to return useful responses when possible (e.g. coverage expired, service not covered) with the limited information available in those hooks.",SHOULD,"CRD Client,CRD Server",false,,,"",""
|
|
86
86
|
hl7.fhir.us.davinci-crd_2.2.1,prof-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-appointment-no-order.html#ci-c-prof-1,CRD Clients **SHALL** use either this Appointment without Order profile and/or the [with-order](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-appointment-with-order.html) to provide `appointments` context objects to CRD Servers when invoking the [appointment-book](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#appointment-book) hook as well as to [resolve other references](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#additional-data-retrieval) to Appointment resources.,SHALL,CRD Client,false,,,1.2.1.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance
|
|
87
87
|
hl7.fhir.us.davinci-crd_2.2.1,prof-2,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-appointment-with-order.html#ci-c-prof-2,CRD Clients **SHALL** use either this Appointment with Order and/or the [no-order](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-appointment-no-order.html) to provide `appointments` context objects to CRD Servers when invoking the [appointment-book](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#appointment-book) hook as well as to [resolve other references](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#additional-data-retrieval) to Appointment resources.,SHALL,CRD Client,false,,,1.2.1.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance
|
|
88
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-communicationrequest.html#ci-c-prof-3,CRD Clients SHALL use the CRD CommunicationRequest profile to resolve references to CommunicationRequest resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.
|
|
89
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-4,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-coverage.html#ci-c-prof-4,CRD Clients **SHALL** use the CRD Coverage profile to [resolve references](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#additional-data-retrieval) to insurance Coverage resources passed to CRD Servers.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
90
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-5,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-device.html#ci-c-prof-5,CRD Clients **SHALL** use the CRD Device profile to [resolve references](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#additional-data-retrieval) to Device resources passed to CRD Servers.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
91
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-6,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-devicerequest.html#ci-c-prof-6,CRD Clients SHALL use the CRD DeviceRequest profile to resolve references to DeviceRequest resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.
|
|
92
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-7,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-encounter.html#ci-c-prof-7,"CRD Clients SHALL use the CRD Encounter profile to resolve references to Encounter resources passed to CRD Servers, including encounterId context references.",SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
93
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-8,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-location.html#ci-c-prof-8,CRD Clients **SHALL** use the CRD Location profile to [resolve references](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#additional-data-retrieval) to insurance Location resources passed to CRD Servers.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
94
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-9,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-medicationrequest.html#ci-c-prof-9,CRD Clients SHALL use the CRD MedicationRequest profile to resolve references to MedicationRequest resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.
|
|
95
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-10,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-nutritionorder.html#ci-c-prof-10,CRD Clients SHALL use CRD NutritionOrder profile to resolve references to NutritionOrder resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.
|
|
96
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-11,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-servicerequest.html#ci-c-prof-11,CRD Clients SHALL use the CRD ServiceRequest profile to resolve references to ServiceRequest resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.
|
|
97
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-12,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-visionprescription.html#ci-c-prof-12,CRD Clients SHALL use the CRD VisionPrescription profile to resolve references to VisionPrescription resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.
|
|
98
|
-
hl7.fhir.us.davinci-crd_2.2.1,prof-13,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-location.html#ci-c-prof-13,"If a Location is a fine-grained location such as a bed or room, the address **SHALL** be propagated from the higher-level location it is part of.",SHALL,CRD Client,true,,,1.3.
|
|
88
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-communicationrequest.html#ci-c-prof-3,CRD Clients SHALL use the CRD CommunicationRequest profile to resolve references to CommunicationRequest resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.01, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
89
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-4,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-coverage.html#ci-c-prof-4,CRD Clients **SHALL** use the CRD Coverage profile to [resolve references](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#additional-data-retrieval) to insurance Coverage resources passed to CRD Servers.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
90
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-5,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-device.html#ci-c-prof-5,CRD Clients **SHALL** use the CRD Device profile to [resolve references](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#additional-data-retrieval) to Device resources passed to CRD Servers.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
91
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-6,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-devicerequest.html#ci-c-prof-6,CRD Clients SHALL use the CRD DeviceRequest profile to resolve references to DeviceRequest resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.01, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
92
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-7,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-encounter.html#ci-c-prof-7,"CRD Clients SHALL use the CRD Encounter profile to resolve references to Encounter resources passed to CRD Servers, including encounterId context references.",SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
93
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-8,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-location.html#ci-c-prof-8,CRD Clients **SHALL** use the CRD Location profile to [resolve references](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#additional-data-retrieval) to insurance Location resources passed to CRD Servers.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
94
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-9,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-medicationrequest.html#ci-c-prof-9,CRD Clients SHALL use the CRD MedicationRequest profile to resolve references to MedicationRequest resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.01, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
95
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-10,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-nutritionorder.html#ci-c-prof-10,CRD Clients SHALL use CRD NutritionOrder profile to resolve references to NutritionOrder resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.01, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
96
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-11,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-servicerequest.html#ci-c-prof-11,CRD Clients SHALL use the CRD ServiceRequest profile to resolve references to ServiceRequest resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.01, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
97
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-12,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-visionprescription.html#ci-c-prof-12,CRD Clients SHALL use the CRD VisionPrescription profile to resolve references to VisionPrescription resources passed to CRD Servers (e.g. selections context references) and to populate draftOrders context objects.,SHALL,CRD Client,false,,,"1.2.1.3.03, 1.2.2.3.03, 1.2.3.3.01, 1.2.3.3.03, 1.2.4.3.01, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 1.4.1.3.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_profiles, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_profiles"
|
|
98
|
+
hl7.fhir.us.davinci-crd_2.2.1,prof-13,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-location.html#ci-c-prof-13,"If a Location is a fine-grained location such as a bed or room, the address **SHALL** be propagated from the higher-level location it is part of.",SHALL,CRD Client,true,,,1.4.3.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_additional_capabilities-crd_v221_client_location_address_propagation
|
|
99
99
|
hl7.fhir.us.davinci-crd_2.2.1,prof-14,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/StructureDefinition-profile-medicationrequest.html#ci-c-prof-14,"While the codes for the medication are expected to be drawn from RxNorm, EHRs **MAY** send additional coding repetions to communicate other code systems (e.g. HCPCS J codes).",MAY,CRD Client,false,,,"",""
|
|
100
|
-
hl7.fhir.us.davinci-crd_2.2.1,resp-14,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-14,Conformant CRD clients and services **SHALL** support the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformancedetails.html#coverage-information-response-type) response type.,SHALL,"CRD Client,CRD Server",false,,,1.
|
|
100
|
+
hl7.fhir.us.davinci-crd_2.2.1,resp-14,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-14,Conformant CRD clients and services **SHALL** support the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformancedetails.html#coverage-information-response-type) response type.,SHALL,"CRD Client,CRD Server",false,,,1.4.2.01,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_must_support-crd_v221_client_card_must_support_coverage_information
|
|
101
101
|
hl7.fhir.us.davinci-crd_2.2.1,resp-15,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-15,Conformant CRD clients and services **SHOULD** support the additional (non-coverage information) types defined by this guide.,SHOULD,"CRD Client,CRD Server",false,,,"",""
|
|
102
102
|
hl7.fhir.us.davinci-crd_2.2.1,resp-31,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-31,"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` in the form of a FHIR ServiceRequest or other Request resource with an embedded coverage-information extension as an attachment to the X12 837 submission and, if applicable, the satisfied-pa-id in the X12 837 REF-Prior Authorization segment.",SHALL,CRD Client,true,,,"",""
|
|
103
103
|
hl7.fhir.us.davinci-crd_2.2.1,resp-34,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-34,Systems **MAY** make CRD calls to servers related to orders even if there is already a coverage assertion recorded on the order.,MAY,CRD Client,false,,,"",""
|
|
104
104
|
hl7.fhir.us.davinci-crd_2.2.1,resp-40,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-40,"When a *coverage-information* response type indicates that additional clinical or patient documentation is needed and the CRD client supports DTR, CRD clients **SHALL** ensure that clinical users have an opportunity to launch their DTR solution as part of the current workflow.",SHALL,CRD Client,true,,,"",""
|
|
105
105
|
hl7.fhir.us.davinci-crd_2.2.1,resp-41,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-41,CRD clients **SHOULD** allow clinical users to have an opportunity to launch their DTR solution but **SHOULD** make it clear that the information to be captured is non-clinical.,SHOULD,CRD Client,false,,,"",""
|
|
106
106
|
hl7.fhir.us.davinci-crd_2.2.1,resp-46,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-46,"If a system action containing a coverage-information extension is returned, the CRD client **SHALL** retain that coverage-information extension and expose it as part of the Request resource in all subsequent communications with that payer, including communications made using DTR and PAS.",SHALL,CRD Client,true,,,"2.1.2.01, 2.2.2.01, 2.3.2.01","crd_client_v221-crd_v221_client_fhir_api-us_core_v311_fhir_api-crd_v221_us_core_311_client_update_verification-crd_v221_client_coverage_info_update, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-crd_v221_us_core_610_client_update_verification-crd_v221_client_coverage_info_update, crd_client_v221-crd_v221_client_fhir_api-us_core_v700_fhir_api-crd_v221_us_core_700_client_update_verification-crd_v221_client_coverage_info_update"
|
|
107
|
-
hl7.fhir.us.davinci-crd_2.2.1,resp-48,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-48,"CRD clients and servers **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,"CRD Client,CRD Server",false,,,
|
|
108
|
-
hl7.fhir.us.davinci-crd_2.2.1,resp-49,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-49,"In this case, the discrete information propagated into the order extension **SHALL** be available to the user for viewing. However, this might be managed with icons, flyovers, or alternate mechanisms than traditional CDS Hooks card rendering.",SHALL,CRD Client,false,,,"",""
|
|
107
|
+
hl7.fhir.us.davinci-crd_2.2.1,resp-48,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-48,"CRD clients and servers **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,"CRD Client,CRD Server",false,,,3.06,crd_client_v221-crd_v221_client_attestations-crd_v221_workflow_integration_attestation
|
|
108
|
+
hl7.fhir.us.davinci-crd_2.2.1,resp-49,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-49,"In this case, the discrete information propagated into the order extension **SHALL** be available to the user for viewing. However, this might be managed with icons, flyovers, or alternate mechanisms than traditional CDS Hooks card rendering.",SHALL,CRD Client,false,,,"1.2.1.2.01, 1.2.2.2.01, 1.2.3.2.01, 1.2.4.2.01, 1.2.5.2.01, 1.2.6.2.01, 1.4.1.2.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group02-crd_v221_card_display_attest_test, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group02-crd_v221_card_display_attest_test, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group02-crd_v221_card_display_attest_test, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group02-crd_v221_card_display_attest_test, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group02-crd_v221_card_display_attest_test, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group02-crd_v221_card_display_attest_test, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group02-crd_v221_card_display_attest_test"
|
|
109
109
|
hl7.fhir.us.davinci-crd_2.2.1,resp-50,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-50,"CRD clients **MAY** be configured to not execute system actions under some circumstances, for example if the order has been cancelled or abandoned.",MAY,CRD Client,false,,,"",""
|
|
110
110
|
hl7.fhir.us.davinci-crd_2.2.1,resp-61,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-61,CRD clients supporting the Request Form Completion response type **SHALL** support both the card and systemAction approach.,SHALL,CRD Client,true,,,"",""
|
|
111
111
|
hl7.fhir.us.davinci-crd_2.2.1,resp-64,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-64,CRD clients **SHOULD** retain a copy of all completed forms for future reference.,SHOULD,CRD Client,false,,,"",""
|
|
112
112
|
hl7.fhir.us.davinci-crd_2.2.1,resp-67,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-67,CRD clients supporting the Update Coverage Records response type **SHALL** support both the card and system action approach.,SHALL,CRD Client,false,,,"",""
|
|
113
113
|
hl7.fhir.us.davinci-crd_2.2.1,resp-68,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#ci-c-resp-68,"If receiving a system action, a CRD client **MAY** opt to place the updated record in a holding area for human review rather than directly modifying their source of truth.",MAY,CRD Client,true,,,"",""
|
|
114
|
-
hl7.fhir.us.davinci-crd_2.2.1,sec-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/security.html#ci-c-sec-1,Implementers SHALL adhere to
|
|
115
|
-
hl7.fhir
|
|
114
|
+
hl7.fhir.us.davinci-crd_2.2.1,sec-1,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/security.html#ci-c-sec-1,"Implementers SHALL adhere to any security and privacy rules defined by:
|
|
115
|
+
- FHIR Core: [Security & Privacy Module](http://hl7.org/fhir/R4/secpriv-module.html), [Security Principles](http://hl7.org/fhir/R4/security.html) and [Implementer's Checklist](http://hl7.org/fhir/R4/safety.html)
|
|
116
|
+
- HRex: [Privacy & Security](http://hl7.org/fhir/us/davinci-hrex/1.2.0/security.html)
|
|
117
|
+
- CDS Hooks: [Security & Safety](http://cds-hooks.hl7.org/2026Jan/index.html#security-and-safety)
|
|
118
|
+
- SMART on FHIR: [SMART App Launch](http://www.hl7.org/fhir/smart-app-launch)",SHALL,"CRD Client,CRD Server",false,,,3.01,crd_client_v221-crd_v221_client_attestations-crd_v221_security_and_privacy_attestation
|
|
119
|
+
hl7.fhir.us.davinci-crd_2.2.1,sec-2,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/security.html#ci-c-sec-2,"As per the CDS Hooks specification, communications between CRD clients and CRD servers **SHALL** use TLS.",SHALL,"CRD Client,CRD Server",false,,,"1.2.1.3.08, 1.2.2.3.08, 1.2.3.3.08, 1.2.4.3.08, 1.2.5.3.08, 1.2.6.3.08, 1.4.1.3.08","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_secured_transport"
|
|
116
120
|
hl7.fhir.us.davinci-crd_2.2.1,sec-3,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/security.html#ci-c-sec-3,CRD servers and CRD clients **SHOULD** enforce a minimum version and other TLS configuration requirements based on [HRex rules](http://hl7.org/fhir/us/davinci-hrex/1.2.0/security.html#exchange-security) for PHI exchange.,SHOULD,"CRD Client,CRD Server",false,,,"",""
|
|
117
121
|
hl7.fhir.us.davinci-crd_2.2.1,sec-4,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/security.html#ci-c-sec-4,CRD clients that support the Launch SMART Application Response Type **SHALL** support running applications that adhere to the SMART on FHIR [confidential app](https://hl7.org/fhir/smart-app-launch/STU2.2/app-launch.html#support-for-public-and-confidential-apps) profile.,SHALL,CRD Client,true,,,"",""
|
|
118
|
-
hl7.fhir.us.davinci-crd_2.2.1,sec-7,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/security.html#ci-c-sec-7,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,CRD Client,false,,,
|
|
122
|
+
hl7.fhir.us.davinci-crd_2.2.1,sec-7,https://hl7.org/fhir/us/davinci-crd/2.2.1/en/security.html#ci-c-sec-7,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,CRD Client,false,,,3.04,crd_client_v221-crd_v221_client_attestations-crd_v221_resource_identifiers_attestation
|
|
119
123
|
cds-hooks_3.0.0-ballot,1,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,All data exchanged through production RESTful APIs MUST be sent and received as JSON (JavaScript Object Notation) structures.,SHALL,"Client,Service",,,,suite,crd_client_v221
|
|
120
|
-
cds-hooks_3.0.0-ballot,2,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,All data exchanged through production RESTful APIs MUST be ... transmitted over HTTPS,SHALL,"Client,Service",,,,"1.2.1.3.08, 1.2.2.3.08, 1.2.3.3.08, 1.2.4.3.08, 1.2.5.3.08, 1.2.6.3.08","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
124
|
+
cds-hooks_3.0.0-ballot,2,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,All data exchanged through production RESTful APIs MUST be ... transmitted over HTTPS,SHALL,"Client,Service",,,,"1.2.1.3.08, 1.2.2.3.08, 1.2.3.3.08, 1.2.4.3.08, 1.2.5.3.08, 1.2.6.3.08, 1.4.1.3.08","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_secured_transport"
|
|
121
125
|
cds-hooks_3.0.0-ballot,221,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,JSON comments and trailing commas SHOULD NOT be transmitted as they are not part of the JSON specification.,SHOULD NOT,"Client,Service",,,,"",""
|
|
122
|
-
cds-hooks_3.0.0-ballot,3,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,"JSON elements SHALL NOT be null … [or] empty, unless otherwise specified (e.g. to indicate no guidance with an empty array of cards in the CDS Hooks response).",SHALL NOT,"Client,Service",,,,"1.2.1.
|
|
123
|
-
cds-hooks_3.0.0-ballot,222,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,"If a JSON attribute is defined as OPTIONAL, and does not have a value, implementers MUST omit it.",SHALL,"Client,Service",,,,"1.2.1.
|
|
124
|
-
cds-hooks_3.0.0-ballot,223,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,"Unless otherwise specified, JSON attribute values SHALL NOT be null or empty, so null, """", [], or {} are prohibited",SHALL NOT,"Client,Service",,,,"1.2.1.
|
|
125
|
-
cds-hooks_3.0.0-ballot,224,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,"If a JSON attribute is defined with as OPTIONAL, and does not have a value, implementers SHALL omit it.",SHALL,"Client,Service",,,,"1.2.1.
|
|
126
|
+
cds-hooks_3.0.0-ballot,3,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,"JSON elements SHALL NOT be null … [or] empty, unless otherwise specified (e.g. to indicate no guidance with an empty array of cards in the CDS Hooks response).",SHALL NOT,"Client,Service",,,,"1.2.1.2.02, 1.2.1.3.01, 1.2.2.2.02, 1.2.2.3.01, 1.2.3.2.02, 1.2.3.3.01, 1.2.4.2.02, 1.2.4.3.01, 1.2.5.2.02, 1.2.5.3.01, 1.2.6.2.02, 1.2.6.3.01, 1.4.1.2.02, 1.4.1.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_conformance"
|
|
127
|
+
cds-hooks_3.0.0-ballot,222,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,"If a JSON attribute is defined as OPTIONAL, and does not have a value, implementers MUST omit it.",SHALL,"Client,Service",,,,"1.2.1.2.02, 1.2.1.3.01, 1.2.2.2.02, 1.2.2.3.01, 1.2.3.2.02, 1.2.3.3.01, 1.2.4.2.02, 1.2.4.3.01, 1.2.5.2.02, 1.2.5.3.01, 1.2.6.2.02, 1.2.6.3.01, 1.4.1.2.02, 1.4.1.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_conformance"
|
|
128
|
+
cds-hooks_3.0.0-ballot,223,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,"Unless otherwise specified, JSON attribute values SHALL NOT be null or empty, so null, """", [], or {} are prohibited",SHALL NOT,"Client,Service",,,,"1.2.1.2.02, 1.2.1.3.01, 1.2.2.2.02, 1.2.2.3.01, 1.2.3.2.02, 1.2.3.3.01, 1.2.4.2.02, 1.2.4.3.01, 1.2.5.2.02, 1.2.5.3.01, 1.2.6.2.02, 1.2.6.3.01, 1.4.1.2.02, 1.4.1.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_conformance"
|
|
129
|
+
cds-hooks_3.0.0-ballot,224,https://cds-hooks.hl7.org/2026Jan/en/index.html#use-of-json,"If a JSON attribute is defined with as OPTIONAL, and does not have a value, implementers SHALL omit it.",SHALL,"Client,Service",,,,"1.2.1.2.02, 1.2.1.3.01, 1.2.2.2.02, 1.2.2.3.01, 1.2.3.2.02, 1.2.3.3.01, 1.2.4.2.02, 1.2.4.3.01, 1.2.5.2.02, 1.2.5.3.01, 1.2.6.2.02, 1.2.6.3.01, 1.4.1.2.02, 1.4.1.3.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_conformance, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group02-crd_v221_inferno_response_validation, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_conformance"
|
|
126
130
|
cds-hooks_3.0.0-ballot,225,https://cds-hooks.hl7.org/2026Jan/en/index.html#capability-documentation,[C]lients SHALL indicate whether they support the actionSelectionBehavior feature,SHALL,Client,,,,"",""
|
|
127
131
|
cds-hooks_3.0.0-ballot,226,https://cds-hooks.hl7.org/2026Jan/en/index.html#capability-documentation,[C[lients … SHOULD document any other feature support necessary to ensure safe operation of CDS Services.,SHOULD,Client,,,,"",""
|
|
128
132
|
cds-hooks_3.0.0-ballot,15,https://cds-hooks.hl7.org/2026Jan/en/index.html#http-request-1,A CDS Client SHALL call a CDS Service by POSTing a JSON document to the service,SHALL,Client,,,,suite,crd_client_v221
|
|
@@ -137,9 +141,9 @@ cds-hooks_3.0.0-ballot,23,https://cds-hooks.hl7.org/2026Jan/en/index.html#http-r
|
|
|
137
141
|
- optionality: OPTIONAL
|
|
138
142
|
- type: object
|
|
139
143
|
- description: The FHIR data that was prefetched by the CDS Client",MAY,Client,,,,"",""
|
|
140
|
-
cds-hooks_3.0.0-ballot,25,https://cds-hooks.hl7.org/2026Jan/en/index.html#hookinstance,the hookInstance is globally unique,SHALL,Client,,,,1.3.
|
|
144
|
+
cds-hooks_3.0.0-ballot,25,https://cds-hooks.hl7.org/2026Jan/en/index.html#hookinstance,the hookInstance is globally unique,SHALL,Client,,,,1.4.3.03,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_additional_capabilities-crd_v221_client_hook_instances_unique
|
|
141
145
|
cds-hooks_3.0.0-ballot,26,https://cds-hooks.hl7.org/2026Jan/en/index.html#hookinstance,the hookInstance ... should contain enough entropy to be un-guessable.,SHOULD,Client,,,,"",""
|
|
142
|
-
cds-hooks_3.0.0-ballot,30,https://cds-hooks.hl7.org/2.0/#providing-fhir-resources-to-a-cds-service,"The [prefetched] FHIR resources are passed as key-value pairs, with each key matching a key described in the discovery response, and each value being a FHIR resource. Note that in the case of searches, this resource may be a searchset Bundle.",SHALL,Client,true,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
146
|
+
cds-hooks_3.0.0-ballot,30,https://cds-hooks.hl7.org/2.0/#providing-fhir-resources-to-a-cds-service,"The [prefetched] FHIR resources are passed as key-value pairs, with each key matching a key described in the discovery response, and each value being a FHIR resource. Note that in the case of searches, this resource may be a searchset Bundle.",SHALL,Client,true,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
143
147
|
cds-hooks_3.0.0-ballot,32,https://cds-hooks.hl7.org/2.0/#providing-fhir-resources-to-a-cds-service,"Some CDS Clients MAY pass prefetched data, along with a bearer token for the CDS Service to use if additional resources are required.",MAY,Client,false,,,"",""
|
|
144
148
|
cds-hooks_3.0.0-ballot,35,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"To allow for prefetch templates that are dependent on the workflow context, prefetch templates may include references to context using prefetch tokens.",MAY,"Client,Service",false,,,"",""
|
|
145
149
|
cds-hooks_3.0.0-ballot,37,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"CDS Client MAY choose to honor zero, some, or all of the desired prefetch templates",MAY,Client,false,,,"",""
|
|
@@ -147,18 +151,18 @@ cds-hooks_3.0.0-ballot,38,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefet
|
|
|
147
151
|
cds-hooks_3.0.0-ballot,39,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"[To avoid a network call,] the CDS Client MAY ... [use] prefetched data already in memory",MAY,Client,false,,,"",""
|
|
148
152
|
cds-hooks_3.0.0-ballot,40,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"[To minimize the number of calls,] the CDS Client MAY compute an efficient set of prefetch templates from multiple CDS Services",MAY,Client,false,,,"",""
|
|
149
153
|
cds-hooks_3.0.0-ballot,41,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,The CDS Client MAY satisfy some of the desired prefetched templates via some internal service or even its own FHIR server.,MAY,Client,false,,,"",""
|
|
150
|
-
cds-hooks_3.0.0-ballot,42,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"[When providing prefetched data, t]he CDS Client SHALL only provide access to resources that are within the user's authorized scope.",SHALL,Client,false,,,
|
|
151
|
-
cds-hooks_3.0.0-ballot,231,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"As part of preparing the request, a CDS Client processes each prefetch template it intends to satisfy by replacing the prefetch tokens in the prefetch template to construct a relative FHIR request URL.",SHALL,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
154
|
+
cds-hooks_3.0.0-ballot,42,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"[When providing prefetched data, t]he CDS Client SHALL only provide access to resources that are within the user's authorized scope.",SHALL,Client,false,,,3.11,crd_client_v221-crd_v221_client_attestations-crd_v221_authorized_scope_attestation
|
|
155
|
+
cds-hooks_3.0.0-ballot,231,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"As part of preparing the request, a CDS Client processes each prefetch template it intends to satisfy by replacing the prefetch tokens in the prefetch template to construct a relative FHIR request URL.",SHALL,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
152
156
|
cds-hooks_3.0.0-ballot,43,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,The relative URL [constructed when a CDS client processes prefetch templates] may be appended to the base URL for the CDS Client's FHIR server and directly invoked,MAY,Client,false,,,"",""
|
|
153
157
|
cds-hooks_3.0.0-ballot,44,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,CDS Clients may use internal infrastructure to satisfy the [prefetch] request in the same way that invoking against the FHIR server would.,MAY,Client,false,,,"",""
|
|
154
|
-
cds-hooks_3.0.0-ballot,45,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,the prefetched data given to the CDS Service MUST be equivalent to the data the CDS Service would receive if it were making its own call to the CDS Client's FHIR server using the parameterized prefetch template.,SHALL,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
155
|
-
cds-hooks_3.0.0-ballot,46,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,Prefetch data for other services registered to the same hook MUST NOT be provided [to a CDS service that has not requested or is not authorized to receive it],SHALL NOT,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
156
|
-
cds-hooks_3.0.0-ballot,47,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,[CDS] services SHALL only receive the data they requested in their prefetch.,SHALL,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
157
|
-
cds-hooks_3.0.0-ballot,232,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,The resulting response [of the prefetch query] is passed along to the CDS Service using the prefetch parameter,SHALL,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
158
|
+
cds-hooks_3.0.0-ballot,45,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,the prefetched data given to the CDS Service MUST be equivalent to the data the CDS Service would receive if it were making its own call to the CDS Client's FHIR server using the parameterized prefetch template.,SHALL,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
159
|
+
cds-hooks_3.0.0-ballot,46,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,Prefetch data for other services registered to the same hook MUST NOT be provided [to a CDS service that has not requested or is not authorized to receive it],SHALL NOT,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
160
|
+
cds-hooks_3.0.0-ballot,47,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,[CDS] services SHALL only receive the data they requested in their prefetch.,SHALL,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
161
|
+
cds-hooks_3.0.0-ballot,232,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,The resulting response [of the prefetch query] is passed along to the CDS Service using the prefetch parameter,SHALL,Client,false,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
158
162
|
cds-hooks_3.0.0-ballot,48,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,CDS Client MAY paginate prefetch results,MAY,Client,false,,,"",""
|
|
159
163
|
cds-hooks_3.0.0-ballot,50,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"If the CDS Client encounters errors prefetching the requested data, OperationOutcome(s) SHOULD be used to communicate those errors to prevent the CDS Service from incurring an unneeded follow-up query.",SHOULD,Client,true,,,"",""
|
|
160
|
-
cds-hooks_3.0.0-ballot,51,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,CDS Clients MUST omit the prefetch key if relevant details cannot be provided (e.g. intermittent connectivity issues),SHALL,Client,false,,,
|
|
161
|
-
cds-hooks_3.0.0-ballot,53,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"If the CDS Client has no data to populate a template prefetch key, the prefetch template key MUST have a value of null. In case the prefetch url is a single-resource request, the search result may be null, otherwise it is a search and could be a bundle with zero entries.",SHALL,Client,true,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
164
|
+
cds-hooks_3.0.0-ballot,51,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,CDS Clients MUST omit the prefetch key if relevant details cannot be provided (e.g. intermittent connectivity issues),SHALL,Client,false,,,3.08,crd_client_v221-crd_v221_client_attestations-crd_v221_prefetch_key_omission_attestation
|
|
165
|
+
cds-hooks_3.0.0-ballot,53,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-template,"If the CDS Client has no data to populate a template prefetch key, the prefetch template key MUST have a value of null. In case the prefetch url is a single-resource request, the search result may be null, otherwise it is a search and could be a bundle with zero entries.",SHALL,Client,true,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
162
166
|
cds-hooks_3.0.0-ballot,233,https://cds-hooks.hl7.org/2026Jan/en/index.html#prefetch-tokens-containing-simpler-fhirpath,"[When evaluating prefetch tokens] CDS Clients can support a limited, targeted subset of FHIRPath aligned with [x-fhir-query](https://hl7.org/fhir/r5/fhir-xquery.html)...:
|
|
163
167
|
- the 'context' object, which corresponds to the context element passed in the CDS Hooks call
|
|
164
168
|
- variables that correspond to the names of prior prefetch templates
|
|
@@ -170,11 +174,11 @@ cds-hooks_3.0.0-ballot,235,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpl
|
|
|
170
174
|
- [addition](https://hl7.org/fhirpath/N1/index.html#addition-2) and [subtraction](https://hl7.org/fhirpath/N1/index.html#subtraction-2) of quantity unit [days](https://hl7.org/fhirpath/N1/index.html#datetime-arithmetic),",SHOULD,Client,,,,"",""
|
|
171
175
|
cds-hooks_3.0.0-ballot,237,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpler-fhirpath-support-for-querystring-syntax,[When evaluating prefetch tokens] CDS Clients SHOULD support paths to References,SHOULD,Client,,,,"",""
|
|
172
176
|
cds-hooks_3.0.0-ballot,238,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpler-fhirpath-support-for-querystring-syntax,[When evaluating prefetch tokens] CDS Clients … MAY support paths to any element within a FHIR resource in context.,MAY,Client,,,,"",""
|
|
173
|
-
cds-hooks_3.0.0-ballot,239,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpler-fhirpath-support-for-querystring-syntax,[When evaluating prefetch tokens] FHIRPath collections of simple data types are represented as comma-delimited strings,SHALL,Client,true,,,1.3.
|
|
174
|
-
cds-hooks_3.0.0-ballot,240,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpler-fhirpath-support-for-querystring-syntax,[When evaluating prefetch tokens] other prefetch parameters can be referenced in token expressions as FHIRPath variables by placing '%' in front of the prefetch parameter name.,SHALL,Client,,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
175
|
-
cds-hooks_3.0.0-ballot,242,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpler-fhirpath-support-for-querystring-syntax,[When evaluating prefetch tokens a] prefetch token ... Contain[ing] multiple path selectors delimited with pipes [SHALL be interpretted as a union of the individual parts],SHALL,Client,,,,1.3.
|
|
176
|
-
cds-hooks_3.0.0-ballot,63,https://cds-hooks.hl7.org/2026Jan/en/index.html#fhir-resource-access,"[When executing a CDS request on behalf of a user,] the data to which the CDS Service is given access by the CDS Client MUST be limited to the same restrictions and authorizations afforded the current user.",SHALL,Client,true,,,
|
|
177
|
-
cds-hooks_3.0.0-ballot,64,https://cds-hooks.hl7.org/2026Jan/en/index.html#fhir-resource-access,"[When executing a CDS request on behalf of a user,] the access token SHALL be scoped to: The CDS Service being invoked [and] the current user",SHALL,Client,true,,,
|
|
177
|
+
cds-hooks_3.0.0-ballot,239,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpler-fhirpath-support-for-querystring-syntax,[When evaluating prefetch tokens] FHIRPath collections of simple data types are represented as comma-delimited strings,SHALL,Client,true,,,1.4.3.02,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_additional_capabilities-crd_v221_client_fhir_path_collection_as_comma_delimited_string
|
|
178
|
+
cds-hooks_3.0.0-ballot,240,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpler-fhirpath-support-for-querystring-syntax,[When evaluating prefetch tokens] other prefetch parameters can be referenced in token expressions as FHIRPath variables by placing '%' in front of the prefetch parameter name.,SHALL,Client,,,,"1.2.1.3.04, 1.2.2.3.04, 1.2.3.3.04, 1.2.4.3.04, 1.2.5.3.04, 1.2.6.3.04, 1.4.1.3.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_prefetch_complete, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_prefetch_complete"
|
|
179
|
+
cds-hooks_3.0.0-ballot,242,https://cds-hooks.hl7.org/2026Jan/en/index.html#simpler-fhirpath-support-for-querystring-syntax,[When evaluating prefetch tokens a] prefetch token ... Contain[ing] multiple path selectors delimited with pipes [SHALL be interpretted as a union of the individual parts],SHALL,Client,,,,1.4.3.02,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_additional_capabilities-crd_v221_client_fhir_path_collection_as_comma_delimited_string
|
|
180
|
+
cds-hooks_3.0.0-ballot,63,https://cds-hooks.hl7.org/2026Jan/en/index.html#fhir-resource-access,"[When executing a CDS request on behalf of a user,] the data to which the CDS Service is given access by the CDS Client MUST be limited to the same restrictions and authorizations afforded the current user.",SHALL,Client,true,,,3.11,crd_client_v221-crd_v221_client_attestations-crd_v221_authorized_scope_attestation
|
|
181
|
+
cds-hooks_3.0.0-ballot,64,https://cds-hooks.hl7.org/2026Jan/en/index.html#fhir-resource-access,"[When executing a CDS request on behalf of a user,] the access token SHALL be scoped to: The CDS Service being invoked [and] the current user",SHALL,Client,true,,,3.11,crd_client_v221-crd_v221_client_attestations-crd_v221_authorized_scope_attestation
|
|
178
182
|
cds-hooks_3.0.0-ballot,71,https://cds-hooks.hl7.org/2026Jan/en/index.html#passing-the-access-token-to-the-cds-service,"[When sending a fhirAuthorization request parameter and] the access token is restricted to a specific patient, [the] patient field SHOULD be populated to identify the FHIR id of that patient [as a] string data type",SHOULD,Client,true,,,"",""
|
|
179
183
|
cds-hooks_3.0.0-ballot,72,https://cds-hooks.hl7.org/2026Jan/en/index.html#passing-the-access-token-to-the-cds-service,The `expires_in` value is established by the authorization server and SHOULD BE very short lived,SHOULD,Client,false,,,"",""
|
|
180
184
|
cds-hooks_3.0.0-ballot,73,https://cds-hooks.hl7.org/2026Jan/en/index.html#passing-the-access-token-to-the-cds-service,CDS Clients SHOULD revoke an issued access token upon the completion of the CDS Hooks request/response to limit the validity period of the token.,SHOULD,Client,true,,,"",""
|
|
@@ -216,44 +220,44 @@ cds-hooks_3.0.0-ballot,257,https://cds-hooks.hl7.org/2026Jan/en/index.html#overr
|
|
|
216
220
|
cds-hooks_3.0.0-ballot,165,https://cds-hooks.hl7.org/2026Jan/en/index.html#overridereason,"[When sending a overrideReason object,] the reason field is required if user selected an override reason from the list of reasons provided in the Card [and SHALL be a] coding object",SHALL,Client,true,,,"",""
|
|
217
221
|
cds-hooks_3.0.0-ballot,166,https://cds-hooks.hl7.org/2026Jan/en/index.html#overridereason,"[When sending a overrideReason object,] the userComment field is a string data type",SHALL,Client,true,,,"",""
|
|
218
222
|
cds-hooks_3.0.0-ballot,167,https://cds-hooks.hl7.org/2026Jan/en/index.html#overridereason,"[When sending a overrideReason object,] the userComment field is optional [and contains a] further explain[ation of] why the card was rejected with free text.",MAY,Client,true,,,"",""
|
|
219
|
-
cds-hooks_3.0.0-ballot,168,https://cds-hooks.hl7.org/2026Jan/en/index.html#security-and-safety,"All data exchanged through the RESTful APIs MUST be transmitted over channels secured using the Hypertext Transfer Protocol (HTTP) over Transport Layer Security (TLS), also known as HTTPS and defined in [RFC2818](https://tools.ietf.org/html/rfc2818)",SHALL,"Client,Service",false,,,"1.2.1.3.08, 1.2.2.3.08, 1.2.3.3.08, 1.2.4.3.08, 1.2.5.3.08, 1.2.6.3.08","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
223
|
+
cds-hooks_3.0.0-ballot,168,https://cds-hooks.hl7.org/2026Jan/en/index.html#security-and-safety,"All data exchanged through the RESTful APIs MUST be transmitted over channels secured using the Hypertext Transfer Protocol (HTTP) over Transport Layer Security (TLS), also known as HTTPS and defined in [RFC2818](https://tools.ietf.org/html/rfc2818)",SHALL,"Client,Service",false,,,"1.2.1.3.08, 1.2.2.3.08, 1.2.3.3.08, 1.2.4.3.08, 1.2.5.3.08, 1.2.6.3.08, 1.4.1.3.08","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_secured_transport"
|
|
220
224
|
cds-hooks_3.0.0-ballot,169,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-services,"Each CDS Client vendor/provider SHOULD maintain an ""allow list"" (and/or ""deny list"") of the CDS Services it has vetted",SHOULD,Client,false,,,"",""
|
|
221
225
|
cds-hooks_3.0.0-ballot,170,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-services,"Each CDS Client vendor/provider SHOULD maintain an ""allow list"" (and/or ""deny list"") of ... the Card links that have been deemed safe to display from within the CDS Client context",SHOULD,Client,false,,,"",""
|
|
222
226
|
cds-hooks_3.0.0-ballot,171,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-services,The CDS Service can be registered with the CDS Client's authorization server,MAY,Client,false,,,"",""
|
|
223
|
-
cds-hooks_3.0.0-ballot,172,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-services,Every interaction between a CDS Client and a CDS Service is initiated by the CDS Client sending a service request to a CDS Service endpoint protected using the [Transport Layer Security protocol] (https://tools.ietf.org/html/rfc5246),SHALL,Client,false,,,"1.2.1.3.08, 1.2.2.3.08, 1.2.3.3.08, 1.2.4.3.08, 1.2.5.3.08, 1.2.6.3.08","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
224
|
-
cds-hooks_3.0.0-ballot,173,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-services,CDS Client SHALL deny access to a requested resource if it is outside the user's authorized scope,SHALL,Client,false,,,
|
|
227
|
+
cds-hooks_3.0.0-ballot,172,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-services,Every interaction between a CDS Client and a CDS Service is initiated by the CDS Client sending a service request to a CDS Service endpoint protected using the [Transport Layer Security protocol] (https://tools.ietf.org/html/rfc5246),SHALL,Client,false,,,"1.2.1.3.08, 1.2.2.3.08, 1.2.3.3.08, 1.2.4.3.08, 1.2.5.3.08, 1.2.6.3.08, 1.4.1.3.08","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_secured_transport, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_secured_transport"
|
|
228
|
+
cds-hooks_3.0.0-ballot,173,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-services,CDS Client SHALL deny access to a requested resource if it is outside the user's authorized scope,SHALL,Client,false,,,3.11,crd_client_v221-crd_v221_client_attestations-crd_v221_authorized_scope_attestation
|
|
225
229
|
cds-hooks_3.0.0-ballot,174,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-services,"If a CDS Client is satisfying prefetch requests from a CDS Service or sends a non-null fhirAuthorization object to a CDS Service so that it can call the FHIR server, the CDS Service MUST be pre-registered with the authorization server protecting access to the FHIR server",SHALL,Client,true,,,1.1.02,crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_registration-crd_v221_client_service_registration_attestation
|
|
226
230
|
cds-hooks_3.0.0-ballot,178,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"Each time a CDS Client transmits a request to a CDS Service which requires authentication, the request MUST include an Authorization header presenting the JWT as a “Bearer” token:
|
|
227
|
-
Authorization: Bearer {{JWT}}",SHALL,Client,true,,,"1.2.1.
|
|
231
|
+
Authorization: Bearer {{JWT}}",SHALL,Client,true,,,"1.2.1.4.01, 1.2.2.4.01, 1.2.3.4.01, 1.2.4.4.01, 1.2.5.4.01, 1.2.6.4.01, 1.4.1.4.01","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_decode_auth_token, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_decode_auth_token, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_decode_auth_token, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_decode_auth_token, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_decode_auth_token, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_decode_auth_token, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_decode_auth_token"
|
|
228
232
|
cds-hooks_3.0.0-ballot,179,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,mutual TLS MAY be used alongside JSON web tokens to establish trust of the CDS Client by the CDS Service,MAY,"Client,Service",false,,,"",""
|
|
229
|
-
cds-hooks_3.0.0-ballot,180,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"The CDS Client MUST use its private key to digitally sign the JWT, using the [JSON Web Signatures (rfc7515)](https://tools.ietf.org/html/rfc7515) standard",SHALL,Client,false,,,"1.2.1.
|
|
230
|
-
cds-hooks_3.0.0-ballot,181,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the alg field is required [and SHALL be a] string data type [containing] the cryptographic algorithm used to sign this JWT.",SHALL,Client,true,,,"1.2.1.
|
|
231
|
-
cds-hooks_3.0.0-ballot,182,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the kid field is required [and SHALL be a] string data type [containing] the identifier of the key-pair used to sign this JWT.",SHALL,Client,true,,,"1.2.1.
|
|
232
|
-
cds-hooks_3.0.0-ballot,183,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the kid field MUST be unique within the CDS Client's JWK Set.",SHALL,Client,true,,,"1.2.1.
|
|
233
|
-
cds-hooks_3.0.0-ballot,184,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the typ field is required [and SHALL be a] string data type and SHALL be 'JWT'",SHALL,Client,true,,,"1.2.1.
|
|
234
|
-
cds-hooks_3.0.0-ballot,185,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the jku field is a url data type [containing] the URL to the JWK Set containing the public key(s)",SHALL,Client,true,,,"1.2.1.
|
|
233
|
+
cds-hooks_3.0.0-ballot,180,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"The CDS Client MUST use its private key to digitally sign the JWT, using the [JSON Web Signatures (rfc7515)](https://tools.ietf.org/html/rfc7515) standard",SHALL,Client,false,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
234
|
+
cds-hooks_3.0.0-ballot,181,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the alg field is required [and SHALL be a] string data type [containing] the cryptographic algorithm used to sign this JWT.",SHALL,Client,true,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
235
|
+
cds-hooks_3.0.0-ballot,182,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the kid field is required [and SHALL be a] string data type [containing] the identifier of the key-pair used to sign this JWT.",SHALL,Client,true,,,"1.2.1.4.03, 1.2.2.4.03, 1.2.3.4.03, 1.2.4.4.03, 1.2.5.4.03, 1.2.6.4.03, 1.4.1.4.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_header"
|
|
236
|
+
cds-hooks_3.0.0-ballot,183,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the kid field MUST be unique within the CDS Client's JWK Set.",SHALL,Client,true,,,"1.2.1.4.02, 1.2.2.4.02, 1.2.3.4.02, 1.2.4.4.02, 1.2.5.4.02, 1.2.6.4.02, 1.4.1.4.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_retrieve_jwks"
|
|
237
|
+
cds-hooks_3.0.0-ballot,184,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the typ field is required [and SHALL be a] string data type and SHALL be 'JWT'",SHALL,Client,true,,,"1.2.1.4.03, 1.2.2.4.03, 1.2.3.4.03, 1.2.4.4.03, 1.2.5.4.03, 1.2.6.4.03, 1.4.1.4.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_header"
|
|
238
|
+
cds-hooks_3.0.0-ballot,185,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the jku field is a url data type [containing] the URL to the JWK Set containing the public key(s)",SHALL,Client,true,,,"1.2.1.4.02, 1.2.2.4.02, 1.2.3.4.02, 1.2.4.4.02, 1.2.5.4.02, 1.2.6.4.02, 1.4.1.4.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_retrieve_jwks"
|
|
235
239
|
cds-hooks_3.0.0-ballot,186,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT header,] the jku field is optional",MAY,Client,true,,,"",""
|
|
236
|
-
cds-hooks_3.0.0-ballot,187,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the iss field is required [and SHALL be a] string data type [containing] the URI of the issuer of the JWT",SHALL,Client,true,,,"1.2.1.
|
|
240
|
+
cds-hooks_3.0.0-ballot,187,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the iss field is required [and SHALL be a] string data type [containing] the URI of the issuer of the JWT",SHALL,Client,true,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
237
241
|
cds-hooks_3.0.0-ballot,188,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"The JWT MAY be self-issued by the CDS Client, or MAY be issued by a third-party identity provider.",MAY,Client,true,,,"",""
|
|
238
|
-
cds-hooks_3.0.0-ballot,189,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the aud field is required [and SHALL be a] string data type or an array of strings [per [rfc7519](https://tools.ietf.org/html/rfc7519#section-4.1.3) containing] the CDS Service endpoint that is being called by the CDS Client",SHALL,Client,true,,,"1.2.1.
|
|
239
|
-
cds-hooks_3.0.0-ballot,190,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the exp field is required [and SHALL be a] number data type [containing the] expiration time integer for this authentication JWT, expressed in seconds since the ""Epoch"" (1970-01-01T00:00:00Z UTC).",SHALL,Client,true,,,"1.2.1.
|
|
240
|
-
cds-hooks_3.0.0-ballot,191,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the iat field is required [and SHALL be a] number data type [containing] the time at which this JWT was issued, expressed in seconds since the ""Epoch"" (1970-01-01T00:00:00Z UTC)",SHALL,Client,true,,,"1.2.1.
|
|
241
|
-
cds-hooks_3.0.0-ballot,192,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the jti field is required [and SHALL be a] string data type [containing] a nonce string value that uniquely identifies this authentication JWT (used to protect against replay attacks)",SHALL,Client,true,,,"1.2.1.
|
|
242
|
+
cds-hooks_3.0.0-ballot,189,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the aud field is required [and SHALL be a] string data type or an array of strings [per [rfc7519](https://tools.ietf.org/html/rfc7519#section-4.1.3) containing] the CDS Service endpoint that is being called by the CDS Client",SHALL,Client,true,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
243
|
+
cds-hooks_3.0.0-ballot,190,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the exp field is required [and SHALL be a] number data type [containing the] expiration time integer for this authentication JWT, expressed in seconds since the ""Epoch"" (1970-01-01T00:00:00Z UTC).",SHALL,Client,true,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
244
|
+
cds-hooks_3.0.0-ballot,191,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the iat field is required [and SHALL be a] number data type [containing] the time at which this JWT was issued, expressed in seconds since the ""Epoch"" (1970-01-01T00:00:00Z UTC)",SHALL,Client,true,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
245
|
+
cds-hooks_3.0.0-ballot,192,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the jti field is required [and SHALL be a] string data type [containing] a nonce string value that uniquely identifies this authentication JWT (used to protect against replay attacks)",SHALL,Client,true,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
242
246
|
cds-hooks_3.0.0-ballot,193,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the tenant field is optional [SHALL be a] string data type [containing] an opaque string identifying the healthcare organization that is invoking the CDS Hooks request",MAY,Client,true,,,"",""
|
|
243
247
|
cds-hooks_3.0.0-ballot,194,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"[When sending a JWT payload,] the tenant field is optional",MAY,Client,true,,,"",""
|
|
244
|
-
cds-hooks_3.0.0-ballot,196,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"For CDS Hooks, [the aud] value MUST be the URL of the CDS Service endpoint being invoked",SHALL,Client,false,,,"1.2.1.
|
|
245
|
-
cds-hooks_3.0.0-ballot,197,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"The CDS Client MUST make its public key, expressed as a JSON Web Key (JWK), available in a JWK Set, as defined by [rfc7517](https://tools.ietf.org/html/rfc7517)",SHALL,Client,false,,,"1.2.1.
|
|
248
|
+
cds-hooks_3.0.0-ballot,196,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"For CDS Hooks, [the aud] value MUST be the URL of the CDS Service endpoint being invoked",SHALL,Client,false,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
249
|
+
cds-hooks_3.0.0-ballot,197,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"The CDS Client MUST make its public key, expressed as a JSON Web Key (JWK), available in a JWK Set, as defined by [rfc7517](https://tools.ietf.org/html/rfc7517)",SHALL,Client,false,,,"1.2.1.4.02, 1.2.2.4.02, 1.2.3.4.02, 1.2.4.4.02, 1.2.5.4.02, 1.2.6.4.02, 1.4.1.4.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_retrieve_jwks"
|
|
246
250
|
cds-hooks_3.0.0-ballot,198,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"The CDS Client MAY make its JWK Set available via a URL identified by the jku header field, as defined by [rfc7515 4.1.2](https://tools.ietf.org/html/rfc7515#section-4.1.2)",MAY,Client,false,,,"",""
|
|
247
|
-
cds-hooks_3.0.0-ballot,199,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"If the jku header field is ommitted, the CDS Client and CDS Service SHALL communicate the JWK Set out-of-band.",SHALL,"Client,Service",true,,,"1.1.01, 1.2.1.
|
|
251
|
+
cds-hooks_3.0.0-ballot,199,https://cds-hooks.hl7.org/2026Jan/en/index.html#trusting-cds-clients,"If the jku header field is ommitted, the CDS Client and CDS Service SHALL communicate the JWK Set out-of-band.",SHALL,"Client,Service",true,,,"1.1.01, 1.2.1.4.02, 1.2.2.4.02, 1.2.3.4.02, 1.2.4.4.02, 1.2.5.4.02, 1.2.6.4.02, 1.4.1.4.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_registration-crd_v221_client_registration_verification, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_retrieve_jwks, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_retrieve_jwks"
|
|
248
252
|
cds-hooks_3.0.0-ballot,200,https://cds-hooks.hl7.org/2026Jan/en/index.html#jwt-signing-algorithm,[JSON Web Algorithms (rfc7518)](https://tools.ietf.org/html/rfc7518) defines several cryptographic algorithms for use in signing JWTs and should be referenced by CDS Hooks implementers.,SHOULD,"Client,Service",false,,,"",""
|
|
249
|
-
cds-hooks_3.0.0-ballot,202,https://cds-hooks.hl7.org/2026Jan/en/index.html#jwt-signing-algorithm,"JWTs SHALL NOT be signed [by Clients] using the none algorithm, referred to in rfc7518 as unsecured JSON Web Signatures, as the lack of a cryptographic signature does not provide any integrity protection.",SHALL NOT,Client,false,,,"1.2.1.
|
|
250
|
-
cds-hooks_3.0.0-ballot,203,https://cds-hooks.hl7.org/2026Jan/en/index.html#jwt-signing-algorithm,JWTs SHALL NOT be signed using any symmetric algorithm as these algorithms require the CDS Client and CDS Service to share a private key in order to verify the signature,SHALL NOT,"Client,Service",false,,,"1.2.1.
|
|
253
|
+
cds-hooks_3.0.0-ballot,202,https://cds-hooks.hl7.org/2026Jan/en/index.html#jwt-signing-algorithm,"JWTs SHALL NOT be signed [by Clients] using the none algorithm, referred to in rfc7518 as unsecured JSON Web Signatures, as the lack of a cryptographic signature does not provide any integrity protection.",SHALL NOT,Client,false,,,"1.2.1.4.03, 1.2.2.4.03, 1.2.3.4.03, 1.2.4.4.03, 1.2.5.4.03, 1.2.6.4.03, 1.4.1.4.03","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_header, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_header"
|
|
254
|
+
cds-hooks_3.0.0-ballot,203,https://cds-hooks.hl7.org/2026Jan/en/index.html#jwt-signing-algorithm,JWTs SHALL NOT be signed using any symmetric algorithm as these algorithms require the CDS Client and CDS Service to share a private key in order to verify the signature,SHALL NOT,"Client,Service",false,,,"1.2.1.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04, 1.4.1.4.04","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group04-crd_v221_token_payload, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group04-crd_v221_token_payload"
|
|
251
255
|
cds-hooks_3.0.0-ballot,204,https://cds-hooks.hl7.org/2026Jan/en/index.html#jwt-signing-algorithm,"When choosing an algorithm to sign their JWTs, CDS Clients SHOULD consider not only the algorithms (and key sizes) that are recommended within the security industry, but also how well those algorithms are supported in the various programming languages and libraries that may be used by CDS Services.",SHOULD,Client,false,,,"",""
|
|
252
256
|
cds-hooks_3.0.0-ballot,205,https://cds-hooks.hl7.org/2026Jan/en/index.html#jwt-signing-algorithm,"At publication time of this specification, both ES384 and RS384 are RECOMMENDED for their regard within the larger security industry, strength, and support across popular programming languages and libraries.",SHOULD,"Client,Service",false,,,"",""
|
|
253
257
|
cds-hooks_3.0.0-ballot,206,https://cds-hooks.hl7.org/2026Jan/en/index.html#jwt-signing-algorithm,"Stronger and better algorithms [than ES384 and RS384] are continually being introduced due to new threats, weaknesses, and increases in computing power [and] CDS Clients SHOULD continually re-evaluate their choice of an algorithm based upon these ever changing conditions.",SHOULD,"Client,Service",false,,,"",""
|
|
254
258
|
cds-hooks_3.0.0-ballot,208,https://cds-hooks.hl7.org/2026Jan/en/index.html#cross-origin-resource-sharing,CDS Services and browser-based CDS Clients will require CORS support. [Cross-origin resource sharing (CORS)](https://www.w3.org/TR/cors/) is a [World Wide Web Consortium (W3C)](https://www.w3.org/Consortium/) standard mechanism that uses additional HTTP headers to enable a web browser to gain permission to access resources from an Internet domain different from that which the browser is currently accessing.,SHALL,"Client,Service",true,,,suite,crd_client_v221
|
|
255
259
|
cds-hooks_3.0.0-ballot,209,https://cds-hooks.hl7.org/2026Jan/en/index.html#update-stale-guidance,"In the case that CDS Hooks cards are persisted, clients should take care to ensure that stale guidance does not negatively impact patient care.",SHOULD,Client,true,,,"",""
|
|
256
|
-
cds-hooks_3.0.0-ballot,214,https://cds-hooks.hl7.org/2026Jan/en/index.html#extensions,The value of an extension element MUST be a pre-coordinated JSON object,SHALL,"Client,Service",false,,,"1.2.1.3.02, 1.2.2.3.02, 1.2.3.3.02, 1.2.4.3.02, 1.2.5.3.02, 1.2.6.3.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-
|
|
260
|
+
cds-hooks_3.0.0-ballot,214,https://cds-hooks.hl7.org/2026Jan/en/index.html#extensions,The value of an extension element MUST be a pre-coordinated JSON object,SHALL,"Client,Service",false,,,"1.2.1.3.02, 1.2.2.3.02, 1.2.3.3.02, 1.2.4.3.02, 1.2.5.3.02, 1.2.6.3.02, 1.4.1.3.02","crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_appointment_book-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_start-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_select-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_sign-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_order_dispatch-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_hooks-crd_v221_client_encounter_discharge-Group03-crd_v221_hook_request_requested_version, crd_client_v221-crd_v221_client_hook_invocation-crd_v221_client_cross_hook-crd_v221_client_cross_hook_interaction-Group03-crd_v221_hook_request_requested_version"
|
|
257
261
|
cds-hooks_3.0.0-ballot,215,https://cds-hooks.hl7.org/2026Jan/en/index.html#extensions,"Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation",SHOULD,"Client,Service",false,,,"",""
|
|
258
262
|
hl7.fhir.us.core_6.1.0,1,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#profile-only-support,"To support a US Core Profile, a server: **SHALL** Be able to populate all profile data elements that are mandatory and/or flagged as Must Support as defined by that profile’s StructureDefinition.",SHALL,Server,false,,,"2.2.1.06, 2.2.3.12, 2.2.4.06, 2.2.5.08, 2.2.6.07, 2.2.7.14, 2.2.8.14, 2.2.9.05, 2.2.10.07, 2.2.11.10, 2.2.12.10, 2.2.13.11, 2.2.14.13, 2.2.15.08, 2.2.16.07, 2.2.17.07, 2.2.18.09, 2.2.19.09, 2.2.20.09, 2.2.21.09, 2.2.22.09, 2.2.23.09, 2.2.24.09, 2.2.25.09, 2.2.26.09, 2.2.27.09, 2.2.28.09, 2.2.29.09, 2.2.30.09, 2.2.31.09, 2.2.32.09, 2.2.33.09, 2.2.34.09, 2.2.35.09, 2.2.36.09, 2.2.37.09, 2.2.38.09, 2.2.39.09, 2.2.40.08, 2.2.41.09, 2.2.42.11, 2.2.43.05, 2.2.44.06, 2.2.45.05, 2.2.46.03, 2.2.47.08, 2.2.48.05","crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_capability_statement-us_core_instantiate, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_patient-us_core_v610_patient_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_allergy_intolerance-us_core_v610_allergy_intolerance_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_care_plan-us_core_v610_care_plan_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_care_team-us_core_v610_care_team_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_condition_encounter_diagnosis-us_core_v610_condition_encounter_diagnosis_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_condition_problems_health_concerns-us_core_v610_condition_problems_health_concerns_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_coverage-us_core_v610_coverage_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_device-us_core_v610_device_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_diagnostic_report_note-us_core_v610_diagnostic_report_note_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_diagnostic_report_lab-us_core_v610_diagnostic_report_lab_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_document_reference-us_core_v610_document_reference_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_encounter-us_core_v610_encounter_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_goal-us_core_v610_goal_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_immunization-us_core_v610_immunization_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_medication_dispense-us_core_v610_medication_dispense_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_medication_request-us_core_v610_medication_request_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_observation_lab-us_core_v610_observation_lab_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_observation_pregnancystatus-us_core_v610_observation_pregnancystatus_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_observation_pregnancyintent-us_core_v610_observation_pregnancyintent_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_observation_occupation-us_core_v610_observation_occupation_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_respiratory_rate-us_core_v610_respiratory_rate_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_simple_observation-us_core_v610_simple_observation_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_heart_rate-us_core_v610_heart_rate_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_body_temperature-us_core_v610_body_temperature_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_pediatric_weight_for_height-us_core_v610_pediatric_weight_for_height_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_pulse_oximetry-us_core_v610_pulse_oximetry_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_smokingstatus-us_core_v610_smokingstatus_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_observation_sexual_orientation-us_core_v610_observation_sexual_orientation_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_head_circumference-us_core_v610_head_circumference_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_body_height-us_core_v610_body_height_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_bmi-us_core_v610_bmi_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_observation_screening_assessment-us_core_v610_observation_screening_assessment_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_blood_pressure-us_core_v610_blood_pressure_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_observation_clinical_result-us_core_v610_observation_clinical_result_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_pediatric_bmi_for_age-us_core_v610_pediatric_bmi_for_age_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_head_circumference_percentile-us_core_v610_head_circumference_percentile_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_body_weight-us_core_v610_body_weight_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_procedure-us_core_v610_procedure_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_questionnaire_response-us_core_v610_questionnaire_response_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_service_request-us_core_v610_service_request_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_organization-us_core_v610_organization_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_practitioner-us_core_v610_practitioner_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_practitioner_role-us_core_v610_practitioner_role_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_provenance-us_core_v610_provenance_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_related_person-us_core_v610_related_person_must_support_test, crd_client_v221-crd_v221_client_fhir_api-us_core_v610_fhir_api-us_core_v610_specimen-us_core_v610_specimen_must_support_test"
|
|
259
263
|
hl7.fhir.us.core_6.1.0,2,https://hl7.org/fhir/us/core/STU6.1/general-requirements.html#profile-only-support,"To support a US Core Profile, a server: **SHOULD** declare support for a US Core Profile by including its official URL in the server’s `CapabilityStatement.rest.resource.supportedProfile` element.",SHOULD,Server,false,,,"",""
|