davinci_crd_test_kit 0.12.2 → 0.14.0
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_client_suite.json.erb +20 -14
- data/config/presets/inferno_crd_client_suite_prefetch_subset_v221.json.erb +125 -0
- data/config/presets/inferno_crd_client_suite_v221.json.erb +124 -0
- data/config/presets/inferno_crd_server_suite.json.erb +59 -2
- data/config/presets/inferno_crd_server_suite_v221.json.erb +94 -0
- data/config/presets/ri_crd_request_generator.json_v221.json.erb +13 -0
- data/config/presets/ri_crd_server.json.erb +19 -19
- data/lib/davinci_crd_test_kit/client/client_base_urls.rb +80 -0
- data/lib/davinci_crd_test_kit/{client_hook_request_validation.rb → client/client_hook_request_validation.rb} +1 -1
- data/lib/davinci_crd_test_kit/client/crd_client_options.rb +30 -0
- data/lib/davinci_crd_test_kit/client/endpoints/cds_services_discovery_handler.rb +34 -0
- data/lib/davinci_crd_test_kit/client/endpoints/custom_service_response.rb +342 -0
- data/lib/davinci_crd_test_kit/client/endpoints/gather_response_generation_data.rb +410 -0
- data/lib/davinci_crd_test_kit/client/endpoints/hook_request_endpoint.rb +233 -0
- data/lib/davinci_crd_test_kit/{mock_service_response.rb → client/endpoints/mock_service_response.rb} +165 -59
- data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/companions_prerequisites.json +1 -0
- data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/create_update_coverage_information.json +3 -2
- data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/launch_smart_app.json +8 -1
- data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/propose_alternate_request.json +1 -0
- data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/request_form_completion.json +17 -16
- data/lib/davinci_crd_test_kit/client/multi_request_message_helper.rb +35 -0
- data/lib/davinci_crd_test_kit/client/tagged_request_load_helper.rb +38 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/api/client_fhir_api_create_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/api/client_fhir_api_read_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/api/client_fhir_api_search_test.rb +234 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/api/client_fhir_api_update_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/api/client_fhir_api_validation_test.rb +63 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/auth/decode_auth_token_test.rb +65 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/auth/retrieve_jwks_test.rb +109 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/auth/token_header_test.rb +70 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/auth/token_payload_test.rb +85 -0
- data/lib/davinci_crd_test_kit/{routes/cds-services.json → client/v2.0.1/cds-services-v201.json} +1 -1
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_appointment_book_group.rb +108 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_card_must_support_group.rb +31 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_encounter_discharge_group.rb +105 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_encounter_start_group.rb +105 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_fhir_api_group.rb +790 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_hooks_group.rb +74 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_dispatch_group.rb +111 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_select_group.rb +116 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_sign_group.rb +113 -0
- data/lib/davinci_crd_test_kit/{client_registration_group.rb → client/v2.0.1/client_registration_group.rb} +12 -8
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_urls.rb +13 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/crd_client_suite.rb +134 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/appointment_book_receive_request_test.rb +129 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/encounter_discharge_receive_request_test.rb +126 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/encounter_start_receive_request_test.rb +126 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/order_dispatch_receive_request_test.rb +138 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/order_select_receive_request_test.rb +134 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/invocation/order_sign_receive_request_test.rb +136 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_coverage_information.rb +93 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_external_reference.rb +62 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_instructions.rb +62 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/registration/client_registration_verification_test.rb +94 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/registration/client_service_registration_attestation_test.rb +40 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_fetched_data_test.rb +86 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_optional_fields_test.rb +63 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_prefetch_equals_queried_test.rb +96 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_required_fields_test.rb +55 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_valid_context_test.rb +70 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_valid_prefetch_test.rb +62 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_response/client_display_cards_attest.rb +83 -0
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_response/inferno_response_validation.rb +79 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/api/client_coverage_info_update_test.rb +212 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/api/client_crd_update_verification_group.rb +18 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/decode_auth_token_test.rb +69 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/retrieve_jwks_test.rb +120 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/token_header_test.rb +92 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/token_payload_test.rb +93 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/cds-services-prefetch-subset-v221.json +198 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/cds-services-v221.json +202 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_appointment_book_group.rb +102 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_cross_hook_group.rb +28 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_encounter_discharge_group.rb +96 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_encounter_start_group.rb +95 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_fhir_api_group.rb +88 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_hooks_group.rb +64 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_long_running_hook_group.rb +32 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_dispatch_group.rb +101 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_select_group.rb +102 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_sign_group.rb +107 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_registration_group.rb +27 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_urls.rb +27 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/crd_client_suite.rb +229 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_card_must_support_coverage_information_test.rb +63 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_fhirpath_collection_as_comma_delimited_string_test.rb +60 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_hook_instances_unique_test.rb +45 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_location_address_propagation_test.rb +135 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_prefetch_complete_and_subset_test.rb +103 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/appointment_book_receive_request_test.rb +156 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/encounter_discharge_receive_request_test.rb +157 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/encounter_start_receive_request_test.rb +157 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_dispatch_receive_request_test.rb +165 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_select_receive_request_test.rb +165 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_sign_receive_request_test.rb +165 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/long_running/client_long_running_receive_request_test.rb +64 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/long_running/client_skip_long_running_attestation_test.rb +49 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/registration/client_registration_verification_test.rb +161 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/registration/client_service_registration_attestation_test.rb +107 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_conformance_test.rb +47 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_coverage_verification_test.rb +152 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_data_fetch_verification_test.rb +55 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_granted_scopes_test.rb +123 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_prefetch_complete_test.rb +127 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_prefetch_profiles_test.rb +55 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_requested_version_test.rb +54 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_secured_transport_test.rb +48 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/client_display_cards_attest.rb +74 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/hook_response_support_coverage_information_test.rb +30 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/inferno_response_validation.rb +77 -0
- data/lib/davinci_crd_test_kit/cross_suite/base_urls.rb +20 -0
- data/lib/davinci_crd_test_kit/cross_suite/cards_identification.rb +312 -0
- data/lib/davinci_crd_test_kit/{cards_validation.rb → cross_suite/cards_validation.rb} +104 -47
- data/lib/davinci_crd_test_kit/cross_suite/coverage-information_stu201_metadata.yml +27 -0
- data/lib/davinci_crd_test_kit/cross_suite/coverage-information_stu221_metadata.yml +60 -0
- data/lib/davinci_crd_test_kit/cross_suite/fhirpath_on_cds_request.rb +177 -0
- data/lib/davinci_crd_test_kit/{hook_request_field_validation.rb → cross_suite/hook_request_field_validation.rb} +282 -203
- data/lib/davinci_crd_test_kit/cross_suite/logical_models_override_helper.rb +220 -0
- data/lib/davinci_crd_test_kit/cross_suite/prefetch_completeness_checker.rb +462 -0
- data/lib/davinci_crd_test_kit/cross_suite/prefetch_contents_validation.rb +81 -0
- data/lib/davinci_crd_test_kit/cross_suite/prefetch_profile_validation.rb +48 -0
- data/lib/davinci_crd_test_kit/cross_suite/profiles_and_resource_types.rb +63 -0
- data/lib/davinci_crd_test_kit/cross_suite/replace_tokens.rb +38 -0
- data/lib/davinci_crd_test_kit/cross_suite/requests_logical_model_validation.rb +202 -0
- data/lib/davinci_crd_test_kit/cross_suite/response_logical_model_validation.rb +274 -0
- data/lib/davinci_crd_test_kit/{suggestion_actions_validation.rb → cross_suite/suggestion_actions_validation.rb} +70 -50
- data/lib/davinci_crd_test_kit/cross_suite/tags.rb +42 -0
- data/lib/davinci_crd_test_kit/metadata.rb +10 -44
- data/lib/davinci_crd_test_kit/requirements/cds-hooks-library_1.0.1_requirements.xlsx +0 -0
- data/lib/davinci_crd_test_kit/requirements/cds-hooks_2.0_requirements.xlsx +0 -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 +742 -65
- data/lib/davinci_crd_test_kit/requirements/generated/crd_client_requirements_coverage.csv +279 -54
- data/lib/davinci_crd_test_kit/requirements/generated/crd_client_v221_requirements_coverage.csv +1430 -0
- data/lib/davinci_crd_test_kit/requirements/generated/crd_server_requirements_coverage.csv +36 -45
- data/lib/davinci_crd_test_kit/requirements/generated/crd_server_v221_requirements_coverage.csv +143 -0
- data/lib/davinci_crd_test_kit/requirements/hl7.fhir.us.davinci-crd_2.0.1_requirements.xlsx +0 -0
- 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/endpoints/jwk_set_endpoint_handler.rb +13 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_create_endpoint.rb +23 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_delete_endpoint.rb +30 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_metadata_endpoint.rb +112 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_read_endpoint.rb +21 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_request_handler.rb +261 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_search_endpoint.rb +561 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr/fhir_update_endpoint.rb +24 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr/stress-test-Bundle.json +54687 -0
- data/lib/davinci_crd_test_kit/server/endpoints/mock_ehr_endpoints.rb +95 -0
- data/lib/davinci_crd_test_kit/server/jobs/invoke_hook.rb +225 -0
- data/lib/davinci_crd_test_kit/{jwt_helper.rb → server/jwt_helper.rb} +1 -12
- data/lib/davinci_crd_test_kit/server/resource_extractor.rb +68 -0
- data/lib/davinci_crd_test_kit/server/server_abstract_invoke_hook_test.rb +165 -0
- data/lib/davinci_crd_test_kit/server/server_base_urls.rb +30 -0
- data/lib/davinci_crd_test_kit/{server_hook_helper.rb → server/server_hook_helper.rb} +1 -1
- data/lib/davinci_crd_test_kit/{server_hook_request_validation.rb → server/server_hook_request_validation.rb} +1 -1
- data/lib/davinci_crd_test_kit/{test_helper.rb → server/server_test_helper.rb} +7 -3
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Appointment.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/ClaimResponse.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/CommunicationRequest.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Coverage.yml +21 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Device.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/DeviceRequest.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Encounter.yml +7 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Location.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/MedicationRequest.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/NutritionOrder.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Organization.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Patient.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Practitioner.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/PractitionerRole.yml +40 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/ServiceRequest.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/Task.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_metadata/VisionPrescription.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_server_suite.rb +99 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/discovery/discovery_endpoint_test.rb +90 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/discovery/discovery_services_validation_test.rb +67 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/interaction/server_invoke_hook_test.rb +12 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/must_support/coverage_information_system_action_across_hooks_validation_test.rb +34 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/must_support/external_reference_card_across_hooks_validation_test.rb +30 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/must_support/instructions_card_received_across_hooks_test.rb +27 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_appointment_book_group.rb +191 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_demonstrate_hook_response_group.rb +93 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_discovery_group.rb +62 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_encounter_discharge_group.rb +186 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_encounter_start_group.rb +186 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_hooks_group.rb +73 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_order_dispatch_group.rb +191 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_order_select_group.rb +211 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_order_sign_group.rb +216 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_required_card_response_validation_group.rb +28 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_urls.rb +13 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_request/service_request_context_validation_test.rb +30 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_request/service_request_optional_fields_validation_test.rb +39 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_request/service_request_required_fields_validation_test.rb +40 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/additional_orders_validation_test.rb +59 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/card_optional_fields_validation_test.rb +51 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/coverage_information_system_action_received_test.rb +65 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/coverage_information_system_action_validation_test.rb +120 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/create_or_update_coverage_info_response_validation_test.rb +70 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/external_reference_card_validation_test.rb +37 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/form_completion_response_validation_test.rb +67 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/instructions_card_received_test.rb +30 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/launch_smart_app_card_validation_test.rb +39 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/propose_alternate_request_card_validation_test.rb +46 -0
- data/lib/davinci_crd_test_kit/server/v2.0.1/verify_response/service_response_validation_test.rb +83 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/Appointment_withorder.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/Appointment_withoutorder.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/CommunicationRequest.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/Coverage.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/Device.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/DeviceRequest.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/Encounter.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/Location.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/MedicationRequest.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/NutritionOrder.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/Organization.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/Patient.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/PractitionerRole.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/ServiceRequest.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_metadata/VisionPrescription.yml +5 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_server_suite.rb +115 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/discovery/discovery_configuration_test.rb +159 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/discovery/discovery_endpoint_test.rb +90 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/discovery/discovery_prefetch_support_test.rb +43 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/discovery/discovery_services_validation_test.rb +121 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/interaction/server_invoke_hook_test.rb +17 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/must_support/coverage_information_must_support_test.rb +71 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/must_support/coverage_information_system_action_across_hooks_validation_test.rb +36 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/must_support/supported_us_core_versions_test.rb +118 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_appointment_book_group.rb +213 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_demonstrate_hook_response_group.rb +93 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_discovery_group.rb +69 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_encounter_discharge_group.rb +194 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_encounter_start_group.rb +194 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_hooks_group.rb +73 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_dispatch_group.rb +214 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_select_group.rb +219 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_sign_group.rb +241 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_required_card_response_validation_group.rb +30 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_urls.rb +13 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_context_validation_test.rb +30 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_no_custom_extensions_test.rb +120 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_optional_fields_validation_test.rb +39 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_required_fields_validation_test.rb +40 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/additional_orders_validation_test.rb +66 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/all_responses_include_coverage_information_test.rb +123 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/card_optional_fields_validation_test.rb +57 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_info_configuration_test.rb +83 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_information_system_action_received_test.rb +65 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_information_system_action_validation_test.rb +184 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/create_or_update_coverage_info_response_validation_test.rb +75 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/external_reference_card_validation_test.rb +47 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/form_completion_response_validation_test.rb +91 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/hook_request_resource_resolution.rb +137 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/instructions_card_received_test.rb +32 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/launch_smart_app_card_validation_test.rb +49 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/order_dispatch_coverage_information_test.rb +38 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/propose_alternate_request_card_validation_test.rb +54 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/service_response_validation_test.rb +97 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_cds_hooks_elements_test.rb +78 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_configuration_test.rb +78 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_context_test.rb +78 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/verify_response_without_billing_options_test.rb +43 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/verify_response_without_configuration_test.rb +44 -0
- data/lib/davinci_crd_test_kit/version.rb +2 -2
- data/lib/davinci_crd_test_kit.rb +4 -2
- metadata +308 -101
- data/lib/davinci_crd_test_kit/client_fhir_api_group.rb +0 -785
- data/lib/davinci_crd_test_kit/client_hooks_group.rb +0 -75
- data/lib/davinci_crd_test_kit/client_tests/appointment_book_receive_request_test.rb +0 -93
- data/lib/davinci_crd_test_kit/client_tests/client_appointment_book_group.rb +0 -75
- data/lib/davinci_crd_test_kit/client_tests/client_display_cards_attest.rb +0 -48
- data/lib/davinci_crd_test_kit/client_tests/client_encounter_discharge_group.rb +0 -73
- data/lib/davinci_crd_test_kit/client_tests/client_encounter_start_group.rb +0 -73
- data/lib/davinci_crd_test_kit/client_tests/client_fhir_api_create_test.rb +0 -41
- data/lib/davinci_crd_test_kit/client_tests/client_fhir_api_read_test.rb +0 -39
- data/lib/davinci_crd_test_kit/client_tests/client_fhir_api_search_test.rb +0 -232
- data/lib/davinci_crd_test_kit/client_tests/client_fhir_api_update_test.rb +0 -41
- data/lib/davinci_crd_test_kit/client_tests/client_fhir_api_validation_test.rb +0 -60
- data/lib/davinci_crd_test_kit/client_tests/client_order_dispatch_group.rb +0 -79
- data/lib/davinci_crd_test_kit/client_tests/client_order_select_group.rb +0 -82
- data/lib/davinci_crd_test_kit/client_tests/client_order_sign_group.rb +0 -81
- data/lib/davinci_crd_test_kit/client_tests/client_registration_verification_test.rb +0 -88
- data/lib/davinci_crd_test_kit/client_tests/decode_auth_token_test.rb +0 -60
- data/lib/davinci_crd_test_kit/client_tests/encounter_discharge_receive_request_test.rb +0 -90
- data/lib/davinci_crd_test_kit/client_tests/encounter_start_receive_request_test.rb +0 -90
- data/lib/davinci_crd_test_kit/client_tests/hook_request_optional_fields_test.rb +0 -57
- data/lib/davinci_crd_test_kit/client_tests/hook_request_required_fields_test.rb +0 -49
- data/lib/davinci_crd_test_kit/client_tests/hook_request_valid_context_test.rb +0 -68
- data/lib/davinci_crd_test_kit/client_tests/hook_request_valid_prefetch_test.rb +0 -69
- data/lib/davinci_crd_test_kit/client_tests/order_dispatch_receive_request_test.rb +0 -102
- data/lib/davinci_crd_test_kit/client_tests/order_select_receive_request_test.rb +0 -98
- data/lib/davinci_crd_test_kit/client_tests/order_sign_receive_request_test.rb +0 -101
- data/lib/davinci_crd_test_kit/client_tests/retrieve_jwks_test.rb +0 -105
- data/lib/davinci_crd_test_kit/client_tests/submitted_response_validation.rb +0 -44
- data/lib/davinci_crd_test_kit/client_tests/token_header_test.rb +0 -65
- data/lib/davinci_crd_test_kit/client_tests/token_payload_test.rb +0 -78
- data/lib/davinci_crd_test_kit/crd_client_suite.rb +0 -185
- data/lib/davinci_crd_test_kit/crd_options.rb +0 -9
- data/lib/davinci_crd_test_kit/crd_server_suite.rb +0 -125
- data/lib/davinci_crd_test_kit/igs/davinci-crd-2.0.1.tgz +0 -0
- data/lib/davinci_crd_test_kit/routes/cds_services_discovery_handler.rb +0 -18
- data/lib/davinci_crd_test_kit/routes/hook_request_endpoint.rb +0 -77
- data/lib/davinci_crd_test_kit/routes/jwk_set_endpoint_handler.rb +0 -15
- data/lib/davinci_crd_test_kit/server_appointment_book_group.rb +0 -176
- data/lib/davinci_crd_test_kit/server_demonstrate_hook_response_group.rb +0 -77
- data/lib/davinci_crd_test_kit/server_discovery_group.rb +0 -60
- data/lib/davinci_crd_test_kit/server_encounter_discharge_group.rb +0 -170
- data/lib/davinci_crd_test_kit/server_encounter_start_group.rb +0 -170
- data/lib/davinci_crd_test_kit/server_hooks_group.rb +0 -71
- data/lib/davinci_crd_test_kit/server_order_dispatch_group.rb +0 -176
- data/lib/davinci_crd_test_kit/server_order_select_group.rb +0 -195
- data/lib/davinci_crd_test_kit/server_order_sign_group.rb +0 -201
- data/lib/davinci_crd_test_kit/server_required_card_response_validation_group.rb +0 -26
- data/lib/davinci_crd_test_kit/server_tests/additional_orders_validation_test.rb +0 -68
- data/lib/davinci_crd_test_kit/server_tests/card_optional_fields_validation_test.rb +0 -47
- data/lib/davinci_crd_test_kit/server_tests/coverage_information_system_action_across_hooks_validation_test.rb +0 -32
- data/lib/davinci_crd_test_kit/server_tests/coverage_information_system_action_received_test.rb +0 -63
- data/lib/davinci_crd_test_kit/server_tests/coverage_information_system_action_validation_test.rb +0 -118
- data/lib/davinci_crd_test_kit/server_tests/create_or_update_coverage_info_response_validation_test.rb +0 -71
- data/lib/davinci_crd_test_kit/server_tests/discovery_endpoint_test.rb +0 -88
- data/lib/davinci_crd_test_kit/server_tests/discovery_services_validation_test.rb +0 -65
- data/lib/davinci_crd_test_kit/server_tests/external_reference_card_across_hooks_validation_test.rb +0 -28
- data/lib/davinci_crd_test_kit/server_tests/external_reference_card_validation_test.rb +0 -36
- data/lib/davinci_crd_test_kit/server_tests/form_completion_response_validation_test.rb +0 -78
- data/lib/davinci_crd_test_kit/server_tests/instructions_card_received_across_hooks_test.rb +0 -25
- data/lib/davinci_crd_test_kit/server_tests/instructions_card_received_test.rb +0 -26
- data/lib/davinci_crd_test_kit/server_tests/launch_smart_app_card_validation_test.rb +0 -38
- data/lib/davinci_crd_test_kit/server_tests/propose_alternate_request_card_validation_test.rb +0 -63
- data/lib/davinci_crd_test_kit/server_tests/service_call_test.rb +0 -101
- data/lib/davinci_crd_test_kit/server_tests/service_request_context_validation_test.rb +0 -28
- data/lib/davinci_crd_test_kit/server_tests/service_request_optional_fields_validation_test.rb +0 -37
- data/lib/davinci_crd_test_kit/server_tests/service_request_required_fields_validation_test.rb +0 -38
- data/lib/davinci_crd_test_kit/server_tests/service_response_validation_test.rb +0 -81
- data/lib/davinci_crd_test_kit/tags.rb +0 -10
- data/lib/davinci_crd_test_kit/urls.rb +0 -52
- /data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/external_reference.json +0 -0
- /data/lib/davinci_crd_test_kit/{card_responses → client/endpoints/mocked_card_responses}/instructions.json +0 -0
- /data/lib/davinci_crd_test_kit/{crd_jwks.json → server/endpoints/crd_jwks.json} +0 -0
- /data/lib/davinci_crd_test_kit/{jwks.rb → server/endpoints/jwks.rb} +0 -0
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,Da Vinci CRD Client Test Suite Short ID(s),Da Vinci CRD Client Test Suite Full ID(s)
|
|
1
|
+
Req Set,ID,URL,Requirement,Conformance,Actors,Conditionality,Not Tested Reason,Not Tested Details,Da Vinci CRD Client v2.0.1 Test Suite Short ID(s),Da Vinci CRD Client v2.0.1 Test Suite Full ID(s)
|
|
2
2
|
hl7.fhir.us.davinci-crd_2.0.1,1,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#foundational-requirements,"Future versions of this specification will evolve based on implementer feedback. Therefore, CRD servers and CRD clients MAY mutually agree to support additional hooks, additional card patterns, additional resources, additional extensions, etc. not found in this specification.",MAY,"Client,Server",,,,"",""
|
|
3
3
|
hl7.fhir.us.davinci-crd_2.0.1,2,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#mustsupport,"For CRD clients, If the client maintains the data element and surfaces it to users, then it SHALL be exposed in their FHIR interface when the data exists and privacy constraints permit",SHALL,Client,,,,"",""
|
|
4
4
|
hl7.fhir.us.davinci-crd_2.0.1,20,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#performance,"If a CRD service exceeds the allocated time window for a hook (i.e., for those circumstances that fall outside the 90% expectation), CRD clients SHOULD establish a time-out process that ensures users are not blocked from proceeding with their business flow.",SHOULD,Client,,,,"",""
|
|
5
|
-
hl7.fhir.us.davinci-crd_2.0.1,21,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#performance,"Where a CRD client opts to not block users from proceeding for responses that come back in a period of time shorter than the target time window in this guide (i.e., 5s or 10s), the client must ensure that users are made aware of the information when it is available.",SHALL,Client
|
|
5
|
+
hl7.fhir.us.davinci-crd_2.0.1,21,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#performance,"Where a CRD client opts to not block users from proceeding for responses that come back in a period of time shorter than the target time window in this guide (i.e., 5s or 10s), the client must ensure that users are made aware of the information when it is available.",SHALL,Client,true,,,"",""
|
|
6
6
|
hl7.fhir.us.davinci-crd_2.0.1,22,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#performance,"For responses that come back in a time period that exceeds this duration, [ 5s or 10s] CRD clients MAY ignore the resulting cards and/or system actions.",MAY,Client,,,,"",""
|
|
7
7
|
hl7.fhir.us.davinci-crd_2.0.1,25,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#terminology,"Where the selected code is not already a billing code and CRD clients are able to automatically determine what the corresponding billing code is, they SHOULD send a Coding with the billing code alongside the clinical code to reduce the risk of the receiving payer making a different translation.",SHOULD,Client,,,,"",""
|
|
8
8
|
hl7.fhir.us.davinci-crd_2.0.1,28,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#enabling-a-crd-server,Provider and EHR vendor organizations MAY leverage the [payer registry](http://hl7.org/fhir/us/davinci-pdex-plan-net) developed by PDex (which will eventually fold into the national directory under [FAST](https://confluence.hl7.org/display/FAST/National+Healthcare+Directory)) as a means of determining which endpoints exist for which payers as candidates for configuration.,MAY,Client,,,,"",""
|
|
@@ -25,7 +25,7 @@ hl7.fhir.us.davinci-crd_2.0.1,43,https://hl7.org/fhir/us/davinci-crd/STU2/founda
|
|
|
25
25
|
-Requested performing Organization (if specified)
|
|
26
26
|
-Requested Location (if specified)
|
|
27
27
|
-Associated Medication (if any)
|
|
28
|
-
-Associated Device (if any)",SHALL,Client,,,,"2.1.
|
|
28
|
+
-Associated Device (if any)",SHALL,Client,,,,"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, 2.2","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_fhir_api-Group02"
|
|
29
29
|
hl7.fhir.us.davinci-crd_2.0.1,44,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"In addition to the [base prefetch capabilities](https://cds-hooks.hl7.org/2.0/#prefetch-template) defined in the CDS Hooks specification, systems that support prefetch SHOULD support the [additional prefetch capabilities](https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#additional-prefetch-capabilities) defined in this specification.",SHOULD,Client,,,,"",""
|
|
30
30
|
hl7.fhir.us.davinci-crd_2.0.1,45,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,"'standard' prefetch queries ... SHOULD be supported for [Appointment]: ...
|
|
31
31
|
|
|
@@ -81,22 +81,20 @@ hl7.fhir.us.davinci-crd_2.0.1,51,https://hl7.org/fhir/us/davinci-crd/STU2/founda
|
|
|
81
81
|
&_include:iterate=PractitionerRole:practitioner```",SHOULD,Client,,,,"",""
|
|
82
82
|
hl7.fhir.us.davinci-crd_2.0.1,52,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD clients MAY support only the resources needed to implement the relevant CDS Hooks and order types.,MAY,Client,,,,"",""
|
|
83
83
|
hl7.fhir.us.davinci-crd_2.0.1,53,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD client implementations SHOULD NOT expect standardized prefetch key names.,SHOULD NOT,Client,,,,"",""
|
|
84
|
-
hl7.fhir.us.davinci-crd_2.0.1,54,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD clients supporting prefetch SHALL inspect the CDS Hooks discovery endpoint to determine exact prefetch key names and queries.,SHALL,Client,,,,"",""
|
|
84
|
+
hl7.fhir.us.davinci-crd_2.0.1,54,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD clients supporting prefetch SHALL inspect the CDS Hooks discovery endpoint to determine exact prefetch key names and queries.,SHALL,Client,,,,"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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_prefetch"
|
|
85
85
|
hl7.fhir.us.davinci-crd_2.0.1,55,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#prefetch,CRD clients SHOULD limit the coverages provided to just those relevant to the CRD service.,SHOULD,Client,,,,"",""
|
|
86
86
|
hl7.fhir.us.davinci-crd_2.0.1,58,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#query-notes,Conformant CRD clients SHOULD be able to perform [respond to] all the queries defined here [[FHIR Resource Access](https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#fhir-resource-access)],SHOULD,Client,,,,"",""
|
|
87
87
|
hl7.fhir.us.davinci-crd_2.0.1,59,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#query-notes,"Conformant CRD clients ... where needed, SHOULD implement interfaces to [_include](http://hl7.org/fhir/R4/search.html#include) resources not available in the client's database.",SHOULD,Client,,,,"",""
|
|
88
88
|
hl7.fhir.us.davinci-crd_2.0.1,61,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#query-notes,"When full prefetch as defined here is not supported, CRD clients SHOULD, at minimum, support the batch query syntax shown [above]( https://build.fhir.org/ig/HL7/davinci-crd/foundation.html#fhir-resource-access)",SHOULD,Client,,,,"",""
|
|
89
|
-
hl7.fhir.us.davinci-crd_2.0.1,64,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD Clients conforming with this specification [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] SHALL support the SMART on FHIR interface,",SHALL,Client,,,,
|
|
90
|
-
hl7.fhir.us.davinci-crd_2.0.1,65,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD clients conforming with this [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] specification … SHALL allow launching of SMART apps from within their application",SHALL,Client,,,,
|
|
91
|
-
hl7.fhir.us.davinci-crd_2.0.1,66,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD clients conforming with this [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] specification ... SHALL be capable of providing the SMART app access to information it exposes to CRD servers using the CDS Hooks interface.",SHALL,Client,,,,
|
|
89
|
+
hl7.fhir.us.davinci-crd_2.0.1,64,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD Clients conforming with this specification [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] SHALL support the SMART on FHIR interface,",SHALL,Client,,,,2.1,crd_client-crd_v201_client_fhir_api-Group01
|
|
90
|
+
hl7.fhir.us.davinci-crd_2.0.1,65,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD clients conforming with this [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] specification … SHALL allow launching of SMART apps from within their application",SHALL,Client,,,,2.1,crd_client-crd_v201_client_fhir_api-Group01
|
|
91
|
+
hl7.fhir.us.davinci-crd_2.0.1,66,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"CRD clients conforming with this [using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios] specification ... SHALL be capable of providing the SMART app access to information it exposes to CRD servers using the CDS Hooks interface.",SHALL,Client,,,,2.1,crd_client-crd_v201_client_fhir_api-Group01
|
|
92
92
|
hl7.fhir.us.davinci-crd_2.0.1,67,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"The app/CRD client MAY choose to use configuration options to control what types of cards are of interest [when using SMART on FHIR apps to invoke coverage requirements discovery from CRD servers for ""what if"" scenarios]",MAY,Client,,,,"",""
|
|
93
93
|
hl7.fhir.us.davinci-crd_2.0.1,68,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"In the specific case of order-based hooks, ""what if"" SHOULD use the Order Sign hook",SHOULD,Client,,,,"",""
|
|
94
94
|
hl7.fhir.us.davinci-crd_2.0.1,69,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"In the specific case of order-based hooks, ""what if"" ... SHALL use the configuration option that prevents the return of an unsolicited determination",SHALL,Client,,,,"",""
|
|
95
95
|
hl7.fhir.us.davinci-crd_2.0.1,70,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#smart-on-fhir-hook-invocation,"In the specific case of order-based hooks, ""what if"" ... MAY use configuration options to prevent the return of other irrelevant types of cards (e.g., duplicate therapy).",MAY,Client,,,,"",""
|
|
96
|
-
hl7.fhir.us.davinci-crd_2.0.1,71,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"When CRD clients pass resources to a CRD server as part of context, the resources SHALL have an ID",SHALL,Client,,,,"2.1.
|
|
96
|
+
hl7.fhir.us.davinci-crd_2.0.1,71,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"When CRD clients pass resources to a CRD server as part of context, the resources SHALL have an ID",SHALL,Client,,,,"1.2.1.3.03, 1.2.4.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
97
97
|
hl7.fhir.us.davinci-crd_2.0.1,72,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"When CRD clients pass resources to a CRD server as part of context, the resources ... SHALL be usable as a target for references in resources manipulated by CDS Hook actions and/or by SMART apps.",SHALL,Client,,,,"",""
|
|
98
|
-
hl7.fhir.us.davinci-crd_2.0.1,73,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,CRD client must handle adjustments to any references made to … [resource ids] (or provide necessary redirects) ensuring that any references made to the in-memory resource will remain valid.,SHALL,Client,,,,"",""
|
|
99
|
-
hl7.fhir.us.davinci-crd_2.0.1,74,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"CRD clients will need to support the creation or updating of resources that include references to resources that might, at the time, only exist in memory and not yet be available as persistent entities.",SHALL,Client,,,,"3.2.1.01, 3.2.2.01, 3.2.5.01, 3.2.6.01, 3.2.11.01, 3.2.12.01, 3.2.14.01, 3.2.15.01, 3.2.16.01, 3.2.17.01","crd_client-crd_client_fhir_api-Group02-Group01-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group02-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group05-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group06-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group11-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group12-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group14-crd_client_fhir_api_update_test, crd_client-crd_client_fhir_api-Group02-Group15-crd_client_fhir_api_create_test, crd_client-crd_client_fhir_api-Group02-Group16-crd_client_fhir_api_create_test, crd_client-crd_client_fhir_api-Group02-Group17-crd_client_fhir_api_update_test"
|
|
100
98
|
hl7.fhir.us.davinci-crd_2.0.1,75,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"Therefore, in addition to any logging performed for security purposes, ... CRD Clients ... SHALL retain logs of all CRD-related hook invocations and their responses for access in the event of a dispute.",SHALL,Client,,,,"",""
|
|
101
99
|
hl7.fhir.us.davinci-crd_2.0.1,78,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,Organizations SHALL have processes to ensure logs can be accessed by appropriate authorized users to help resolve discrepancies or issues in a timely manner.,SHALL,"Client,Server",,,,"",""
|
|
102
100
|
hl7.fhir.us.davinci-crd_2.0.1,79,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#additional-considerations,"Because the information in these logs will often contain PHI, access to the logs themselves will need to be restricted ... for security purposes.",SHALL,"Client,Server",,,,"",""
|
|
@@ -109,10 +107,10 @@ hl7.fhir.us.davinci-crd_2.0.1,85,https://hl7.org/fhir/us/davinci-crd/STU2/securi
|
|
|
109
107
|
hl7.fhir.us.davinci-crd_2.0.1,86,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: … HRex: [Privacy & Security](http://hl7.org/fhir/us/davinci-hrex/STU1/security.html),SHALL,"Client,Server",,,,"",""
|
|
110
108
|
hl7.fhir.us.davinci-crd_2.0.1,87,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: … CDS Hooks: [Security & Safety](https://cds-hooks.hl7.org/2.0/#security-and-safety),SHALL,"Client,Server",,,,"",""
|
|
111
109
|
hl7.fhir.us.davinci-crd_2.0.1,88,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Implementers SHALL adhere to any security and privacy rules defined by: … SMART on FHIR: [SMART App Launch](http://www.hl7.org/fhir/smart-app-launch),SHALL,"Client,Server",,,,"",""
|
|
112
|
-
hl7.fhir.us.davinci-crd_2.0.1,89,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"As per the CDS Hook specification, communications between CRD Clients and CRD Servers SHALL use TLS.",SHALL,"Client,Server",,,,
|
|
110
|
+
hl7.fhir.us.davinci-crd_2.0.1,89,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"As per the CDS Hook specification, communications between CRD Clients and CRD Servers SHALL use TLS.",SHALL,"Client,Server",,,,2.1,crd_client-crd_v201_client_fhir_api-Group01
|
|
113
111
|
hl7.fhir.us.davinci-crd_2.0.1,90,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,Mutual TLS is not required by this specification but is permitted.,MAY,"Client,Server",,,,"",""
|
|
114
112
|
hl7.fhir.us.davinci-crd_2.0.1,91,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,CRD Servers and CRD Clients SHOULD enforce a minimum version and other TLS configuration requirements based on [HRex rules for PHI exchange](https://hl7.org/fhir/us/davinci-hrex/STU1/security.html#exchange-of-phi-for-treatment-payment-operations-tpo-as-defined),SHOULD,"Client,Server",,,,"",""
|
|
115
|
-
hl7.fhir.us.davinci-crd_2.0.1,92,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,CRD Clients SHALL support running applications that adhere to the SMART on FHIR [confidential app](http://www.hl7.org/fhir/smart-app-launch#support-for-public-and-confidential-apps) profile.,SHALL,Client,,,,
|
|
113
|
+
hl7.fhir.us.davinci-crd_2.0.1,92,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,CRD Clients SHALL support running applications that adhere to the SMART on FHIR [confidential app](http://www.hl7.org/fhir/smart-app-launch#support-for-public-and-confidential-apps) profile.,SHALL,Client,,,,2.1,crd_client-crd_v201_client_fhir_api-Group01
|
|
116
114
|
hl7.fhir.us.davinci-crd_2.0.1,95,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"CRD Clients are the final arbiters of what data can or cannot be shared with CRD Servers and SHOULD filter or withhold any resources or data elements necessary to support their obligations as health data custodians, including ... patient consent-based restrictions.",SHOULD,Client,,,,"",""
|
|
117
115
|
hl7.fhir.us.davinci-crd_2.0.1,96,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"CRD Clients are the final arbiters of what data can or cannot be shared with CRD Servers and SHOULD filter or withhold any resources or data elements necessary to support their obligations as health data custodians, including legal...restrictions.",SHOULD,Client,,,,"",""
|
|
118
116
|
hl7.fhir.us.davinci-crd_2.0.1,97,https://hl7.org/fhir/us/davinci-crd/STU2/security.html#privacy-security-and-safety,"CRD Clients are the final arbiters of what data can or cannot be shared with CRD Servers and SHOULD filter or withhold any resources or data elements necessary to support their obligations as health data custodians, including ... policy restrictions.",SHOULD,Client,,,,"",""
|
|
@@ -143,43 +141,51 @@ hl7.fhir.us.davinci-crd_2.0.1,145,https://hl7.org/fhir/us/davinci-crd/STU2/devia
|
|
|
143
141
|
hl7.fhir.us.davinci-crd_2.0.1,146,https://hl7.org/fhir/us/davinci-crd/STU2/deviations.html#controlling-hook-invocation,"Where the patient has multiple active coverages that the CRD client deems appropriate to call the respective CRD servers for, the CRD client SHALL invoke all CRD server calls in parallel and display results simultaneously to ensure timely response to user action.",SHALL,Client,,,,"",""
|
|
144
142
|
hl7.fhir.us.davinci-crd_2.0.1,147,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,the `order-select` hook SHOULD fire whenever a user of a CRD Client creates a new order or referral.,SHOULD,Client,,,,"",""
|
|
145
143
|
hl7.fhir.us.davinci-crd_2.0.1,148,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide SHALL be able to determine the correct payer CRD Service to use for each request. [appointment-book, encounter-start, encounter-discharge, order-dispatch, order-select, and order-sign]",SHALL,Client,,,,"",""
|
|
146
|
-
hl7.fhir.us.davinci-crd_2.0.1,149,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide SHALL support at least one of the hooks [appointment-book, encounter-start, encounter-discharge, order-dispatch, order-select, and order-sign]",SHALL,Client,,,,2,crd_client-
|
|
147
|
-
hl7.fhir.us.davinci-crd_2.0.1,150,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide SHALL support ... (for order-centric hooks), at least one of the order resource types [CommunicationRequest, DeviceRequest, MedicationRequest, ServiceRequest, NutritionOrder, VisionPrescription]",SHALL,Client,,,,"3.2.
|
|
144
|
+
hl7.fhir.us.davinci-crd_2.0.1,149,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide SHALL support at least one of the hooks [appointment-book, encounter-start, encounter-discharge, order-dispatch, order-select, and order-sign]",SHALL,Client,,,,1.2,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks
|
|
145
|
+
hl7.fhir.us.davinci-crd_2.0.1,150,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide SHALL support ... (for order-centric hooks), at least one of the order resource types [CommunicationRequest, DeviceRequest, MedicationRequest, ServiceRequest, NutritionOrder, VisionPrescription]",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03, 2.2.2, 2.2.5, 2.2.11, 2.2.12, 2.2.14, 2.2.17","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_fhir_api-Group02-Group02, crd_client-crd_v201_client_fhir_api-Group02-Group05, crd_client-crd_v201_client_fhir_api-Group02-Group11, crd_client-crd_v201_client_fhir_api-Group02-Group12, crd_client-crd_v201_client_fhir_api-Group02-Group14, crd_client-crd_v201_client_fhir_api-Group02-Group17"
|
|
148
146
|
hl7.fhir.us.davinci-crd_2.0.1,151,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,"CRD Clients conforming to this implementation guide ... SHOULD support all [CommunicationRequest, DeviceRequest, MedicationRequest, ServiceRequest, NutritionOrder, VisionPrescription] that apply to the context of their system.",SHOULD,Client,,,,"",""
|
|
149
147
|
hl7.fhir.us.davinci-crd_2.0.1,154,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,CRD Clients … MAY choose to support additional hooks available in the registry on the [CDS Hooks continuous integration build](https://cds-hooks.org/) or custom hooks defined elsewhere.,MAY,Client,,,,"",""
|
|
150
148
|
hl7.fhir.us.davinci-crd_2.0.1,156,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#supported-hooks,[Clients who choose to support additional hooks] SHOULD adhere to the conformance expectations defined in this specification for any hooks listed here.,SHOULD,Client,,,,"",""
|
|
151
149
|
hl7.fhir.us.davinci-crd_2.0.1,166,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#hook-categories,(CRD clients SHOULD use the configuration options to instruct CRD servers to not even try to return cards if they do not intend to display/process them.),SHOULD,Client,,,,"",""
|
|
152
|
-
hl7.fhir.us.davinci-crd_2.0.1,171,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[Clients SHALL support] version 1.0 of the [[appointment-book](https://cds-hooks.hl7.org/hooks/appointment-book/STU1/appointment-book/)] hook.,SHALL,Client,,,,2.1.
|
|
153
|
-
hl7.fhir.us.davinci-crd_2.0.1,172,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,"This [appointment-book] hook would be triggered when the user of a CRD Client books a future appointment for a patient with themselves, with someone else within their organization, or with another organization. (Note that whether the CRD Client will create an appointment - triggering the `appointment-book` hook - or a ServiceRequest - triggering an `order-select` or `order-sign` hook - can vary depending on the service being booked and the organizations involved.)",SHALL,Client,,,,2.1,crd_client-
|
|
154
|
-
hl7.fhir.us.davinci-crd_2.0.1,177,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook]
|
|
155
|
-
hl7.fhir.us.davinci-crd_2.0.1,178,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook]
|
|
156
|
-
hl7.fhir.us.davinci-crd_2.0.1,179,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook]
|
|
157
|
-
hl7.fhir.us.davinci-crd_2.0.1,180,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,<html>[
|
|
158
|
-
hl7.fhir.us.davinci-crd_2.0.1,183,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,"CRD clients... SHALL, at minimum, support ... processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-ext-coverage-information.html) system action for all invocations of this [[appointment-book](https://cds-hooks.hl7.org/hooks/appointment-book/STU1/appointment-book/)] hook.",SHALL,Client,,,,2.1.
|
|
159
|
-
hl7.fhir.us.davinci-crd_2.0.1,186,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[Clients SHALL support] version 1.0 of the [[encounter-start](https://cds-hooks.hl7.org/hooks/encounter-start/2023SepSTU1Ballot/encounter-start/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/encounter-start/STU1/encounter-start/))],SHALL,Client,,,,2.2.
|
|
160
|
-
hl7.fhir.us.davinci-crd_2.0.1,187,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,"This [[encounter-start](https://cds-hooks.hl7.org/hooks/encounter-start/STU1/encounter-start/)] hook would be triggered when a patient is admitted, a patient arrives for an out-patient visit, and/or when a provider first engages with a patient during an encounter.",SHALL,Client,,,,2.2,crd_client-
|
|
161
|
-
hl7.fhir.us.davinci-crd_2.0.1,192,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook]
|
|
162
|
-
hl7.fhir.us.davinci-crd_2.0.1,193,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook]
|
|
163
|
-
hl7.fhir.us.davinci-crd_2.0.1,194,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook]
|
|
164
|
-
hl7.fhir.us.davinci-crd_2.0.1,197,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[Clients SHALL support] version 1.0 of the [[encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/2023SepSTU1Ballot/encounter-discharge/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/))],SHALL,Client,,,,2.3.
|
|
165
|
-
hl7.fhir.us.davinci-crd_2.0.1,199,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,"[In response to an [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook call, [clients should]
|
|
166
|
-
hl7.fhir.us.davinci-crd_2.0.1,200,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,"[In response to an [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook call, [clients should]
|
|
167
|
-
hl7.fhir.us.davinci-crd_2.0.1,201,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook]
|
|
168
|
-
hl7.fhir.us.davinci-crd_2.0.1,202,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook]
|
|
169
|
-
hl7.fhir.us.davinci-crd_2.0.1,203,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook]
|
|
170
|
-
hl7.fhir.us.davinci-crd_2.0.1,205,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch,[Clients SHALL support] version 1.0 of the [[order-dispatch](https://cds-hooks.hl7.org/hooks/order-dispatch/2023SepSTU1Ballot/order-dispatch/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/order-dispatch/STU1/order-dispatch/))],SHALL,Client,,,,2.5.
|
|
171
|
-
hl7.fhir.us.davinci-crd_2.0.1,207,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch,"CRD clients and servers SHALL, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-ext-coverage-information.html) system action for all invocations of this [[order-dispatch](order-dispatch](https://cds-hooks.hl7.org/hooks/order-dispatch/STU1/order-dispatch/)] hook",SHALL,"Client,Server",,,,2.5.
|
|
172
|
-
hl7.fhir.us.davinci-crd_2.0.1,209,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select,[Clients SHALL support] version 1.0 of the [[order-select](https://cds-hooks.hl7.org/hooks/order-select/2023SepSTU1Ballot/order-select/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/order-select
|
|
173
|
-
hl7.fhir.us.davinci-crd_2.0.1,
|
|
174
|
-
hl7.fhir.us.davinci-crd_2.0.1,
|
|
150
|
+
hl7.fhir.us.davinci-crd_2.0.1,171,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[Clients SHALL support] version 1.0 of the [[appointment-book](https://cds-hooks.hl7.org/hooks/appointment-book/STU1/appointment-book/)] hook.,SHALL,Client,,,,1.2.1.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group01-crd_v201_appointment_book_request
|
|
151
|
+
hl7.fhir.us.davinci-crd_2.0.1,172,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,"This [appointment-book] hook would be triggered when the user of a CRD Client books a future appointment for a patient with themselves, with someone else within their organization, or with another organization. (Note that whether the CRD Client will create an appointment - triggering the `appointment-book` hook - or a ServiceRequest - triggering an `order-select` or `order-sign` hook - can vary depending on the service being booked and the organizations involved.)",SHALL,Client,,,,1.2.1,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book
|
|
152
|
+
hl7.fhir.us.davinci-crd_2.0.1,177,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook t]he profiles expected to be used for the resources resolved to by the userId … are … [profile-practitioner](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-practitioner.html) [or] [us-core-practitionerrole](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html),SHALL,Client,,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
153
|
+
hl7.fhir.us.davinci-crd_2.0.1,178,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook t]he profiles expected to be used for the resources resolved to by the … patientId … are … [profile-patient](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-patient.html),SHALL,Client,,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
154
|
+
hl7.fhir.us.davinci-crd_2.0.1,179,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,[For the appointment-book hook t]he profiles expected to be used for the resources resolved to by the … encounterId … are … [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html),SHALL,Client,,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
155
|
+
hl7.fhir.us.davinci-crd_2.0.1,180,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,<html>[For the appointment-book hook t]he profiles expected to be used for the resources resolved to by the … `appointments` … are …<b> </b>[profile-appointment](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-appointment.html)</html>,SHALL,Client,,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
156
|
+
hl7.fhir.us.davinci-crd_2.0.1,183,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#appointment-book,"CRD clients... SHALL, at minimum, support ... processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-ext-coverage-information.html) system action for all invocations of this [[appointment-book](https://cds-hooks.hl7.org/hooks/appointment-book/STU1/appointment-book/)] hook.",SHALL,Client,,,,1.2.1.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group01-crd_v201_appointment_book_request
|
|
157
|
+
hl7.fhir.us.davinci-crd_2.0.1,186,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[Clients SHALL support] version 1.0 of the [[encounter-start](https://cds-hooks.hl7.org/hooks/encounter-start/2023SepSTU1Ballot/encounter-start/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/encounter-start/STU1/encounter-start/))],SHALL,Client,,,,1.2.2.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group01-crd_v201_encounter_start_request
|
|
158
|
+
hl7.fhir.us.davinci-crd_2.0.1,187,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,"This [[encounter-start](https://cds-hooks.hl7.org/hooks/encounter-start/STU1/encounter-start/)] hook would be triggered when a patient is admitted, a patient arrives for an out-patient visit, and/or when a provider first engages with a patient during an encounter.",SHALL,Client,,,,1.2.2,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start
|
|
159
|
+
hl7.fhir.us.davinci-crd_2.0.1,192,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook t]he profiles expected to be used for the resources resolved to by the userId … are … [profile-practitioner](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-practitioner.html) [or] [us-core-practitionerrole](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html),SHALL,Client,,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
160
|
+
hl7.fhir.us.davinci-crd_2.0.1,193,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook t]he profiles expected to be used for the resources resolved to by the … patientId … are … [profile-patient](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-patient.html),SHALL,Client,,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
161
|
+
hl7.fhir.us.davinci-crd_2.0.1,194,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-start,[For the enounter-start hook t]he profiles expected to be used for the resources resolved to by the … encounterId … are … [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html),SHALL,Client,,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
162
|
+
hl7.fhir.us.davinci-crd_2.0.1,197,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[Clients SHALL support] version 1.0 of the [[encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/2023SepSTU1Ballot/encounter-discharge/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/))],SHALL,Client,,,,1.2.3.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group01-crd_v201_encounter_discharge_request
|
|
163
|
+
hl7.fhir.us.davinci-crd_2.0.1,199,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,"[In response to an [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook call, [clients should v]erify that documentation requirements for the services performed have been met to ensure the services provided can be reimbursed",SHOULD,Client,,,,"",""
|
|
164
|
+
hl7.fhir.us.davinci-crd_2.0.1,200,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,"[In response to an [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook call, [clients should e]nsure that required follow-up planning is complete and appropriate transfer of care has been arranged, particularly for accountable care models",SHOULD,Client,,,,"",""
|
|
165
|
+
hl7.fhir.us.davinci-crd_2.0.1,201,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook t]he profiles expected to be used for the resources resolved to by the userId … are … [profile-practitioner](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-practitioner.html) [or] [us-core-practitionerrole](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html),SHALL,Client,,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
166
|
+
hl7.fhir.us.davinci-crd_2.0.1,202,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook t]he profiles expected to be used for the resources resolved to by the … patientId … are … [profile-patient](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-patient.html),SHALL,Client,,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
167
|
+
hl7.fhir.us.davinci-crd_2.0.1,203,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#encounter-discharge,[for the [encounter-discharge](https://cds-hooks.hl7.org/hooks/encounter-discharge/STU1/encounter-discharge/) hook t]he profiles expected to be used for the resources resolved to by the … encounterId … are … [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html),SHALL,Client,,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
168
|
+
hl7.fhir.us.davinci-crd_2.0.1,205,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch,[Clients SHALL support] version 1.0 of the [[order-dispatch](https://cds-hooks.hl7.org/hooks/order-dispatch/2023SepSTU1Ballot/order-dispatch/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/order-dispatch/STU1/order-dispatch/))],SHALL,Client,,,,1.2.5.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group01-crd_v201_order_dispatch_request
|
|
169
|
+
hl7.fhir.us.davinci-crd_2.0.1,207,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-dispatch,"CRD clients and servers SHALL, at minimum, support returning and processing the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-ext-coverage-information.html) system action for all invocations of this [[order-dispatch](order-dispatch](https://cds-hooks.hl7.org/hooks/order-dispatch/STU1/order-dispatch/)] hook",SHALL,"Client,Server",,,,1.2.5.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group01-crd_v201_order_dispatch_request
|
|
170
|
+
hl7.fhir.us.davinci-crd_2.0.1,209,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select,[Clients SHALL support] version 1.0 of the [[order-select](https://cds-hooks.hl7.org/hooks/order-select/2023SepSTU1Ballot/order-select/)] Hook [([published v1.0 link](https://cds-hooks.hl7.org/hooks/order-select.html))],SHALL,Client,,,,1.2.4.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group01-crd_v201_order_select_request
|
|
171
|
+
hl7.fhir.us.davinci-crd_2.0.1,212,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select,[For the [order-select](https://cds-hooks.hl7.org/hooks/order-select.html) hook] the profiles expected to be used for the resources resolved to by the `patientId` [are] [profile-patient](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-patient.html),SHALL,Client,,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
172
|
+
hl7.fhir.us.davinci-crd_2.0.1,213,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select,[For the [order-select](https://cds-hooks.hl7.org/hooks/order-select.html) hook] the profiles expected to be used for the resources resolved to by the … `encounterId` [are] [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html),SHALL,Client,,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
173
|
+
hl7.fhir.us.davinci-crd_2.0.1,214,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select,"[for the [order-select](https://cds-hooks.hl7.org/hooks/order-select.html) hook] The profiles expected to be used for the resources resolved to by the ... `draftOrders` context element [are] [profile-devicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html), [profile-medicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html), [profile-nutritionorder](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-nutritionorder.html), [profile-visionprescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html), [and] [profile-servicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html)",SHALL,Client,,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
174
|
+
hl7.fhir.us.davinci-crd_2.0.1,215,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select,"While this [order-select](https://cds-hooks.hl7.org/hooks/order-select.html)] hook does not explicitly list PractitionerRole [([us-core-practitionerrole](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html)) in addition to [profile-practitioner](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-practitioner.html)] as an expected resource type for userId, it is not prohibited and is included to allow linking the user to a Practitioner in a specific role acting on behalf of a specific Organization.",SHALL,Client,,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
175
|
+
hl7.fhir.us.davinci-crd_2.0.1,216,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select,This [[order-select](https://cds-hooks.hl7.org/hooks/order-select.html)] hook MAY be used in scenarios that don’t involve creating a true order,MAY,Client,,,,"",""
|
|
176
|
+
hl7.fhir.us.davinci-crd_2.0.1,218,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign,[Clients SHALL support] version 1.1 of the [[order-sign](https://cds-hooks.org/hooks/order-sign/2020May/order-sign)] Hook [([published v1.0 link (v1.1.0 in the change log)](https://cds-hooks.hl7.org/hooks/STU1/order-sign.html))],SHALL,Client,,,,1.2.6.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_request
|
|
177
|
+
hl7.fhir.us.davinci-crd_2.0.1,220,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign,Use and profiles for [order-select](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select) also apply to `order-sign` [([link](https://cds-hooks.hl7.org/hooks/STU1/order-sign.html)) including: the profiles expected to be used for the resources resolved to by the `patientId`are [profile-patient](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-patient.html)],SHALL,Client,,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
178
|
+
hl7.fhir.us.davinci-crd_2.0.1,221,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign,Use and profiles for [order-select](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select) also apply to `order-sign` [([link](https://cds-hooks.hl7.org/hooks/STU1/order-sign.html)) including: the profiles expected to be used for the resources resolved to by the … `encounterId` are [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html)],SHALL,Client,,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
179
|
+
hl7.fhir.us.davinci-crd_2.0.1,222,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign,"Use and profiles for [order-select](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select) also apply to `order-sign` [([link](https://cds-hooks.hl7.org/hooks/STU1/order-sign.html)) including: The profiles expected to be used for the resources resolved to by the ... `draftOrders` context element [are] [profile-devicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html), [profile-medicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html), [profile-nutritionorder](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-nutritionorder.html), [profile-visionprescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html), [profile-servicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html)]",SHALL,Client,,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
180
|
+
hl7.fhir.us.davinci-crd_2.0.1,223,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign,"Use and profiles for [order-select](https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-select) also apply to `order-sign` [([link](https://cds-hooks.hl7.org/hooks/STU1/order-sign.html)) including: while this hook does not explicitly list PractitionerRole [([us-core-practitionerrole](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html)) in addition to [profile-practitioner](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-practitioner.html)] as an expected resource type for userId, it is not prohibited and is included to allow linking the user to a Practitioner in a specific role acting on behalf of a specific Organization.]",SHALL,Client,,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
181
|
+
hl7.fhir.us.davinci-crd_2.0.1,225,https://hl7.org/fhir/us/davinci-crd/STU2/hooks.html#order-sign,"CRD clients ... SHALL, at minimum, support … processing the Coverage Information system action for all invocations of this [[order-sign hook](https://cds-hooks.hl7.org/hooks/STU1/order-sign.html)] hook.",SHALL,Client,,,,1.2.6.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_request
|
|
175
182
|
hl7.fhir.us.davinci-crd_2.0.1,242,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#cards-profiles,It is the responsibility of the CRD Client to determine how best to present the results of the newly created or revised records.,SHOULD,Client,,,,"",""
|
|
176
|
-
hl7.fhir.us.davinci-crd_2.0.1,243,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"conformant CRD Clients SHALL support the [External Reference](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#external-reference), … response",SHALL,Client,,,,"2.1.
|
|
177
|
-
hl7.fhir.us.davinci-crd_2.0.1,244,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"conformant CRD Clients SHALL support the ... [Instructions](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#instructions), … response",SHALL,Client,,,,"2.1.
|
|
178
|
-
hl7.fhir.us.davinci-crd_2.0.1,245,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,conformant CRD Clients SHALL support the... [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information) response,SHALL,Client,,,,"2.1.
|
|
183
|
+
hl7.fhir.us.davinci-crd_2.0.1,243,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"conformant CRD Clients SHALL support the [External Reference](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#external-reference), … response",SHALL,Client,,,,"1.2.1.1.01, 1.2.2.1.01, 1.2.3.1.01, 1.2.4.1.01, 1.2.5.1.01, 1.2.6.1.01","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group01-crd_v201_appointment_book_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group01-crd_v201_encounter_start_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group01-crd_v201_encounter_discharge_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group01-crd_v201_order_select_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group01-crd_v201_order_dispatch_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_request"
|
|
184
|
+
hl7.fhir.us.davinci-crd_2.0.1,244,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"conformant CRD Clients SHALL support the ... [Instructions](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#instructions), … response",SHALL,Client,,,,"1.2.1.1.01, 1.2.2.1.01, 1.2.3.1.01, 1.2.4.1.01, 1.2.5.1.01, 1.2.6.1.01","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group01-crd_v201_appointment_book_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group01-crd_v201_encounter_start_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group01-crd_v201_encounter_discharge_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group01-crd_v201_order_select_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group01-crd_v201_order_dispatch_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_request"
|
|
185
|
+
hl7.fhir.us.davinci-crd_2.0.1,245,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,conformant CRD Clients SHALL support the... [Coverage Information](https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information) response,SHALL,Client,,,,"1.2.1.1.01, 1.2.2.1.01, 1.2.3.1.01, 1.2.4.1.01, 1.2.5.1.01, 1.2.6.1.01","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group01-crd_v201_appointment_book_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group01-crd_v201_encounter_start_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group01-crd_v201_encounter_discharge_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group01-crd_v201_order_select_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group01-crd_v201_order_dispatch_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_request"
|
|
179
186
|
hl7.fhir.us.davinci-crd_2.0.1,246,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,conformant CRD Clients... SHOULD support the remaining types [of [Responses](https://cds-hooks.hl7.org/2.0/#cds-service-response)].,SHOULD,Client,,,,"",""
|
|
180
187
|
hl7.fhir.us.davinci-crd_2.0.1,251,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,[A]cceptance of decision support cards outside the coverage and documentation requirements space is optional (for both server and client).,MAY,Client,,,,"",""
|
|
181
|
-
hl7.fhir.us.davinci-crd_2.0.1,
|
|
182
|
-
hl7.fhir.us.davinci-crd_2.0.1,255,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"When a Coverage Information card type indicating that additional clinical documentation is needed and the CRD client supports DTR, CRD Clients SHALL ensure that clinical users have an opportunity to launch the DTR app as part of the current workflow.",SHALL,Client,,,,"",""
|
|
188
|
+
hl7.fhir.us.davinci-crd_2.0.1,255,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"When a Coverage Information card type indicating that additional clinical documentation is needed and the CRD client supports DTR, CRD Clients SHALL ensure that clinical users have an opportunity to launch the DTR app as part of the current workflow.",SHALL,Client,true,,,"",""
|
|
183
189
|
hl7.fhir.us.davinci-crd_2.0.1,256,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"Where a Coverage Information indicates that additional administrative documentation is needed, CRD Clients SHOULD allow clinical users to have an opportunity to launch the DTR app",SHOULD,Client,,,,"",""
|
|
184
190
|
hl7.fhir.us.davinci-crd_2.0.1,257,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#potential-crd-response-types,"Where a Coverage Information indicates that additional administrative documentation is needed, CRD Clients ... SHOULD make it clear that the information to be captured is non-clinical.",SHOULD,Client,,,,"",""
|
|
185
191
|
hl7.fhir.us.davinci-crd_2.0.1,263,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,"If a CRD client submits a claim related to an order for which it has received a coverage-information extension for the coverage type associated with the claim, that claim SHALL include the `coverage-assertion-id` and, if applicable, the `satisfied-pa-id` in the X12 837 K3 segment.",SHALL,Client,,,,"",""
|
|
@@ -187,18 +193,18 @@ hl7.fhir.us.davinci-crd_2.0.1,266,https://hl7.org/fhir/us/davinci-crd/STU2/cards
|
|
|
187
193
|
hl7.fhir.us.davinci-crd_2.0.1,278,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,"CRD clients... SHALL support the new CDS Hooks system action functionality to cause annotations to automatically be stored on the relevant request, appointment, etc. without any user intervention.",SHALL,Client,,,,"",""
|
|
188
194
|
hl7.fhir.us.davinci-crd_2.0.1,280,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,"In this case, [Where CRD clients and services support the new CDS Hooks system action functionality to cause annotations to automatically be stored on the relevant request, appointment, etc.] the discrete information propagated into the order extension SHALL be available to the user for viewing",SHALL,Client,,,,"",""
|
|
189
195
|
hl7.fhir.us.davinci-crd_2.0.1,281,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#coverage-information,CRD clients MAY be configured to not execute system actions under some circumstances - e.g. if the order has been cancelled/abandoned.,MAY,Client,,,,"",""
|
|
190
|
-
hl7.fhir.us.davinci-crd_2.0.1,284,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-device](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-device.html) profile",SHALL,Client,,,,"2.4.
|
|
191
|
-
hl7.fhir.us.davinci-crd_2.0.1,285,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [device] orders (and any associated resources) SHALL comply with the [profile-devicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html) profile",SHALL,Client,,,,"2.4.
|
|
192
|
-
hl7.fhir.us.davinci-crd_2.0.1,286,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [encounter] orders (and any associated resources) SHALL comply with the [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html) profile",SHALL,Client,,,,"2.1.
|
|
193
|
-
hl7.fhir.us.davinci-crd_2.0.1,287,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [medication] orders (and any associated resources) SHALL comply with the [profile-medicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html) profile [and referenced Medications SHALL comply with the [us-core-medication](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html) profile.]",SHALL,Client,,,,"2.4.
|
|
194
|
-
hl7.fhir.us.davinci-crd_2.0.1,288,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [nutrition] orders (and any associated resources) SHALL comply with the [profile-nutritionorder](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-nutritionorder.html) profile",SHALL,Client,,,,"2.4.
|
|
195
|
-
hl7.fhir.us.davinci-crd_2.0.1,289,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [service] orders (and any associated resources) SHALL comply with the [profile-servicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html) profile",SHALL,Client,,,,"2.4.
|
|
196
|
-
hl7.fhir.us.davinci-crd_2.0.1,290,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [vision] orders (and any associated resources) SHALL comply with the [profile-visionprescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html) profile",SHALL,Client,,,,"2.4.
|
|
197
|
-
hl7.fhir.us.davinci-crd_2.0.1,291,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [communication] orders (and any associated resources) SHALL comply with the [profile-communicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-communicationrequest.html) profile",SHALL,Client,,,,"2.4.
|
|
198
|
-
hl7.fhir.us.davinci-crd_2.0.1,292,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-devicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html) profile [and referenced devices SHALL comply with the [profile-device](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-device.html) profile]",SHALL,Client,,,,"2.4.
|
|
199
|
-
hl7.fhir.us.davinci-crd_2.0.1,293,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-medicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html) profile [and referenced medications SHALL comply with the [us-core-medication](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html) profile]",SHALL,Client,,,,"2.4.
|
|
200
|
-
hl7.fhir.us.davinci-crd_2.0.1,294,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [service] orders (and any associated resources) SHALL comply with the [profile-servicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html) profile",SHALL,Client,,,,"2.4.
|
|
201
|
-
hl7.fhir.us.davinci-crd_2.0.1,295,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [vision] orders (and any associated resources) SHALL comply with the [profile-visionprescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html) profile",SHALL,Client,,,,"2.4.
|
|
196
|
+
hl7.fhir.us.davinci-crd_2.0.1,284,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-device](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-device.html) profile",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
197
|
+
hl7.fhir.us.davinci-crd_2.0.1,285,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [device] orders (and any associated resources) SHALL comply with the [profile-devicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html) profile",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
198
|
+
hl7.fhir.us.davinci-crd_2.0.1,286,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [encounter] orders (and any associated resources) SHALL comply with the [profile-encounter](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-encounter.html) profile",SHALL,Client,,,,"1.2.1.3.03, 1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
199
|
+
hl7.fhir.us.davinci-crd_2.0.1,287,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [medication] orders (and any associated resources) SHALL comply with the [profile-medicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html) profile [and referenced Medications SHALL comply with the [us-core-medication](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html) profile.]",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
200
|
+
hl7.fhir.us.davinci-crd_2.0.1,288,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [nutrition] orders (and any associated resources) SHALL comply with the [profile-nutritionorder](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-nutritionorder.html) profile",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
201
|
+
hl7.fhir.us.davinci-crd_2.0.1,289,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [service] orders (and any associated resources) SHALL comply with the [profile-servicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html) profile",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
202
|
+
hl7.fhir.us.davinci-crd_2.0.1,290,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#propose-alternate-request,"When using this [Propose alternate request] response type, the proposed [vision] orders (and any associated resources) SHALL comply with the [profile-visionprescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html) profile",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
203
|
+
hl7.fhir.us.davinci-crd_2.0.1,291,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [communication] orders (and any associated resources) SHALL comply with the [profile-communicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-communicationrequest.html) profile",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
204
|
+
hl7.fhir.us.davinci-crd_2.0.1,292,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-devicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-devicerequest.html) profile [and referenced devices SHALL comply with the [profile-device](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-device.html) profile]",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
205
|
+
hl7.fhir.us.davinci-crd_2.0.1,293,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed orders (and any associated resources) SHALL comply with the [profile-medicationrequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-medicationrequest.html) profile [and referenced medications SHALL comply with the [us-core-medication](http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html) profile]",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
206
|
+
hl7.fhir.us.davinci-crd_2.0.1,294,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [service] orders (and any associated resources) SHALL comply with the [profile-servicerequest](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-servicerequest.html) profile",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
207
|
+
hl7.fhir.us.davinci-crd_2.0.1,295,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#identify-additional-orders-as-companionsprerequisites-for-current-order,"When using this [Identify additional orders as companions/prerequisites for current order] response type, the proposed [vision] orders (and any associated resources) SHALL comply with the [profile-visionprescription](https://hl7.org/fhir/us/davinci-crd/STU2/StructureDefinition-profile-visionprescription.html) profile",SHALL,Client,,,,"1.2.4.3.03, 1.2.5.3.03, 1.2.6.3.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context"
|
|
202
208
|
hl7.fhir.us.davinci-crd_2.0.1,297,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion,CRD clients supporting this [Request form completion] card type SHALL support either approach [Card or systemAction],SHALL,Client,,,,"",""
|
|
203
209
|
hl7.fhir.us.davinci-crd_2.0.1,301,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#request-form-completion,[for the Request form completion response type] CRD Clients SHOULD retain a copy of all completed forms for future reference.,SHOULD,Client,,,,"",""
|
|
204
210
|
hl7.fhir.us.davinci-crd_2.0.1,303,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#create-or-update-coverage-information,CRD clients supporting this [Create or update coverage information] card type SHALL support either approach [Card or systemAction],SHALL,Client,,,,"",""
|
|
@@ -206,3 +212,222 @@ hl7.fhir.us.davinci-crd_2.0.1,304,https://hl7.org/fhir/us/davinci-crd/STU2/cards
|
|
|
206
212
|
hl7.fhir.us.davinci-crd_2.0.1,307,https://hl7.org/fhir/us/davinci-crd/STU2/cards.html#launch-smart-application,This [Launch SMART application] response type can cause the launching of ... [SMART] apps to occur in the context in which they are relevant to patient care and/or to payment-related decision-making,MAY,Client,,,,"",""
|
|
207
213
|
hl7.fhir.us.davinci-crd_2.0.1,308,https://hl7.org/fhir/us/davinci-crd/STU2/implementation.html#suppressing-guidance,"Clients that [suppress certain types of payer guidance as being the ‘default’ presumption. E.g. “Covered, no prior authorization required”] … SHALL mitigate this potential for misinterpretation.",SHALL,Client,,,,"",""
|
|
208
214
|
hl7.fhir.us.davinci-crd_2.0.1,311,https://hl7.org/fhir/us/davinci-crd/STU2/implementation.html#impact-on-payer-processes,"In situations where CRD Clients are aware of the likely billing codes at the time of ordering, they MAY send these codes as additional CodeableConcept.coding repetitions to assist in server processing.",MAY,Client,,,,"",""
|
|
215
|
+
hl7.fhir.us.davinci-crd_2.0.1,312,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,the CRD Client SHALL support all ‘SHOULD’ ‘read’ and ‘search’ capabilities listed below for resources referenced in supported hooks and order types if it does not support returning the associated resources as part of CDS Hooks pre-fetch.,SHALL,Client,,,,"",""
|
|
216
|
+
hl7.fhir.us.davinci-crd_2.0.1,313,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html#mode1,Implementations SHALL meet the general security requirements documented in the [HRex implementation guide](http://hl7.org/fhir/us/davinci-hrex/STU1/security.html),SHALL,Client,,,,"",""
|
|
217
|
+
hl7.fhir.us.davinci-crd_2.0.1,314,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,[CRD Clients SHALL also implement the US Core Server Capability Statement imported by this CapabilityStatement],SHALL,Client,,,,"",""
|
|
218
|
+
hl7.fhir.us.davinci-crd_2.0.1,315,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,The CRD Client SHALL also support ‘update’ functionality for [the Appointment resource type when] the client allows invoking [the appointment-book hook].,SHALL,Client,,,,"",""
|
|
219
|
+
hl7.fhir.us.davinci-crd_2.0.1,316,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,The CRD Client SHALL also support ‘update’ functionality for [the Encounter resource type when] the client allows invoking [the encounter-start or encounter-discharge hook].,SHALL,Client,,,,"",""
|
|
220
|
+
hl7.fhir.us.davinci-crd_2.0.1,317,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,"The CRD Client SHALL also support ‘update’ functionality for [the CommunicationRequest resource type when] the client allows invoking [the order-dispatch, order-select, or order-sign hook].",SHALL,Client,,,,"",""
|
|
221
|
+
hl7.fhir.us.davinci-crd_2.0.1,318,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,"The CRD Client SHALL also support ‘update’ functionality for [the DeviceRequest resource type when] the client allows invoking [the order-dispatch, order-select, or order-sign hook].",SHALL,Client,,,,"",""
|
|
222
|
+
hl7.fhir.us.davinci-crd_2.0.1,319,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,"The CRD Client SHALL also support ‘update’ functionality for [the MedicationRequest resource type when] the client allows invoking [the order-dispatch, order-select, or order-sign hook].",SHALL,Client,,,,"",""
|
|
223
|
+
hl7.fhir.us.davinci-crd_2.0.1,320,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,"The CRD Client SHALL also support ‘update’ functionality for [the NutritionOrder resource type when] the client allows invoking [the order-dispatch, order-select, or order-sign hook].",SHALL,Client,,,,"",""
|
|
224
|
+
hl7.fhir.us.davinci-crd_2.0.1,321,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,"The CRD Client SHALL also support ‘update’ functionality for [the ServiceRequest resource type when] the client allows invoking [the order-dispatch, order-select, or order-sign hook].",SHALL,Client,,,,"",""
|
|
225
|
+
hl7.fhir.us.davinci-crd_2.0.1,322,https://hl7.org/fhir/us/davinci-crd/STU2/CapabilityStatement-crd-client.html,"The CRD Client SHALL also support ‘update’ functionality for [the VisionPrescription resource type when] the client allows invoking [the order-dispatch, order-select, or order-sign hook].",SHALL,Client,,,,"",""
|
|
226
|
+
hl7.fhir.us.davinci-crd_2.0.1,323,https://hl7.org/fhir/us/davinci-crd/STU2/foundation.html#crd-access-tokens,"When a CRD client invokes a CRD server via CDS Hooks, it will provide an access token that allows the CRD server to retrieve additional patient information.",SHALL,Client,,,,"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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_fetched_data, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_fetched_data"
|
|
227
|
+
cds-hooks_2.0,1,https://cds-hooks.hl7.org/2.0/#use-of-json,All data exchanged through production RESTful APIs MUST be sent and received as JSON (JavaScript Object Notation) structures.,SHALL,"Client,Service",,,,"1.2.1.3.01, 1.2.1.3.02, 1.2.2.3.01, 1.2.2.3.02, 1.2.3.3.01, 1.2.3.3.02, 1.2.4.3.01, 1.2.4.3.02, 1.2.5.3.01, 1.2.5.3.02, 1.2.6.3.01, 1.2.6.3.02","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
228
|
+
cds-hooks_2.0,2,https://cds-hooks.hl7.org/2.0/#use-of-json,All data exchanged through production RESTful APIs MUST be ... transmitted over HTTPS,SHALL,"Client,Service",,,,"",""
|
|
229
|
+
cds-hooks_2.0,3,https://cds-hooks.hl7.org/2.0/#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.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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
230
|
+
cds-hooks_2.0,15,https://cds-hooks.hl7.org/2.0/#http-request_1,A CDS Client SHALL call a CDS Service by POSTing a JSON document to the service,SHALL,Client,,,,"1.2.1.1.01, 1.2.2.1.01, 1.2.3.1.01, 1.2.4.1.01, 1.2.5.1.01, 1.2.6.1.01","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group01-crd_v201_appointment_book_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group01-crd_v201_encounter_start_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group01-crd_v201_encounter_discharge_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group01-crd_v201_order_select_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group01-crd_v201_order_dispatch_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_request"
|
|
231
|
+
cds-hooks_2.0,17,https://cds-hooks.hl7.org/2.0/#http-request_1,"CDS Clients may add additional requirements for the triggering of a hook, based upon the user, workflow, CDS Service or other reasons (e.g. if the service is provided by a payer, the patient has active coverage with that payer).",MAY,Client,,,,"",""
|
|
232
|
+
cds-hooks_2.0,18,https://cds-hooks.hl7.org/2.0/#http-request_1,"The [service invocation] request SHALL include a JSON POST body with the following input fields [including]:
|
|
233
|
+
- field: hook
|
|
234
|
+
- optionality: REQUIRED
|
|
235
|
+
- type: string
|
|
236
|
+
- description: The hook that triggered this CDS Service call.",SHALL,Client,,,,"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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_required_fields"
|
|
237
|
+
cds-hooks_2.0,19,https://cds-hooks.hl7.org/2.0/#http-request_1,"The [service invocation] request SHALL include a JSON POST body with the following input fields [including]:
|
|
238
|
+
- field: hookInstance
|
|
239
|
+
- optionality: REQUIRED
|
|
240
|
+
- type: string
|
|
241
|
+
- description: A universally unique identifier (UUID) for this particular hook call",SHALL,Client,,,,"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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_required_fields"
|
|
242
|
+
cds-hooks_2.0,20,https://cds-hooks.hl7.org/2.0/#http-request_1,"The [service invocation] request SHALL include a JSON POST body with the following input fields [including]:
|
|
243
|
+
- field: fhirServer
|
|
244
|
+
- optionality: CONDITIONAL
|
|
245
|
+
- type: URL
|
|
246
|
+
- description: The base URL of the CDS Client's FHIR server. If fhirAuthorization is provided, this field is REQUIRED. The scheme MUST be https when production data is exchanged.",SHALL,Client,true,,,"1.2.1.3.01, 1.2.1.3.02, 1.2.2.3.01, 1.2.2.3.02, 1.2.3.3.01, 1.2.3.3.02, 1.2.4.3.01, 1.2.4.3.02, 1.2.5.3.01, 1.2.5.3.02, 1.2.6.3.01, 1.2.6.3.02","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
247
|
+
cds-hooks_2.0,21,https://cds-hooks.hl7.org/2.0/#http-request_1,"The [service invocation] request SHALL include a JSON POST body with the following input fields [including]:
|
|
248
|
+
- field: fhirAuthorization
|
|
249
|
+
- optionality: OPTIONAL
|
|
250
|
+
- type: object
|
|
251
|
+
- description: A structure holding an OAuth 2.0 bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token.",MAY,Client,,,,"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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
252
|
+
cds-hooks_2.0,22,https://cds-hooks.hl7.org/2.0/#http-request_1,"The [service invocation] request SHALL include a JSON POST body with the following input fields [including]:
|
|
253
|
+
- field: context
|
|
254
|
+
- optionality: REQUIRED
|
|
255
|
+
- type: object
|
|
256
|
+
- description: Hook-specific contextual data that the CDS service will need. For example, with the patient-view hook this will include the FHIR id of the Patient being viewed",SHALL,Client,,,,"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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_required_fields"
|
|
257
|
+
cds-hooks_2.0,23,https://cds-hooks.hl7.org/2.0/#http-request_1,"The [service invocation] request SHALL include a JSON POST body with the following input fields [including]:
|
|
258
|
+
- field: prefetch
|
|
259
|
+
- optionality: OPTIONAL
|
|
260
|
+
- type: object
|
|
261
|
+
- description: The FHIR data that was prefetched by the CDS Client",MAY,Client,,,,"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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
262
|
+
cds-hooks_2.0,25,https://cds-hooks.hl7.org/2.0/#hookinstance,the hookInstance is globally unique,SHALL,Client,,,,"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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_required_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_required_fields"
|
|
263
|
+
cds-hooks_2.0,26,https://cds-hooks.hl7.org/2.0/#hookinstance,the hookInstance ... should contain enough entropy to be un-guessable.,SHOULD,Client,,,,"",""
|
|
264
|
+
cds-hooks_2.0,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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_prefetch"
|
|
265
|
+
cds-hooks_2.0,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,,,"",""
|
|
266
|
+
cds-hooks_2.0,35,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
267
|
+
cds-hooks_2.0,37,https://cds-hooks.hl7.org/2.0/#prefetch-template,"CDS Client MAY choose to honor zero, some, or all of the desired prefetch templates",MAY,Client,false,,,"",""
|
|
268
|
+
cds-hooks_2.0,38,https://cds-hooks.hl7.org/2.0/#prefetch-template,A CDS Client MAY ... choose the most appropriate source for … [its prefetch] data,MAY,Client,false,,,"",""
|
|
269
|
+
cds-hooks_2.0,39,https://cds-hooks.hl7.org/2.0/#prefetch-template,"[To avoid a network call,] the CDS Client MAY ... [use] prefetched data already in memory",MAY,Client,false,,,"",""
|
|
270
|
+
cds-hooks_2.0,40,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
271
|
+
cds-hooks_2.0,41,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
272
|
+
cds-hooks_2.0,42,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
273
|
+
cds-hooks_2.0,43,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
274
|
+
cds-hooks_2.0,44,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
275
|
+
cds-hooks_2.0,45,https://cds-hooks.hl7.org/2.0/#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.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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_prefetch_equals_queried, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_prefetch_equals_queried, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_prefetch_equals_queried, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_prefetch_equals_queried, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_prefetch_equals_queried, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_prefetch_equals_queried"
|
|
276
|
+
cds-hooks_2.0,46,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
277
|
+
cds-hooks_2.0,47,https://cds-hooks.hl7.org/2.0/#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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_prefetch, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_prefetch"
|
|
278
|
+
cds-hooks_2.0,48,https://cds-hooks.hl7.org/2.0/#prefetch-template,CDS Client MAY paginate prefetch results,MAY,Client,false,,,"",""
|
|
279
|
+
cds-hooks_2.0,49,https://cds-hooks.hl7.org/2.0/#prefetch-template,The CDS Client MUST NOT send any prefetch template key that it chooses not to satisfy.,SHALL NOT,Client,false,,,"",""
|
|
280
|
+
cds-hooks_2.0,50,https://cds-hooks.hl7.org/2.0/#prefetch-template,"If the CDS Client encounters errors prefetching the requested data, OperationOutcome(s) SHOULD be used to communicate those errors",SHOULD,Client,true,,,"",""
|
|
281
|
+
cds-hooks_2.0,51,https://cds-hooks.hl7.org/2.0/#prefetch-template,CDS Clients MUST omit the prefetch key if relevant details cannot be provided (e.g. intermittent connectivity issues),SHALL,Client,false,,,"",""
|
|
282
|
+
cds-hooks_2.0,53,https://cds-hooks.hl7.org/2.0/#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.",SHALL,Client,true,,,"",""
|
|
283
|
+
cds-hooks_2.0,63,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
284
|
+
cds-hooks_2.0,64,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
285
|
+
cds-hooks_2.0,65,https://cds-hooks.hl7.org/2.0/#passing-the-access-token-to-the-cds-service,"If the CDS Client chooses not to pass along an access token, the fhirAuthorization parameter [SHALL be] … omitted.",SHALL,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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
286
|
+
cds-hooks_2.0,66,https://cds-hooks.hl7.org/2.0/#passing-the-access-token-to-the-cds-service,"[When sending a fhirAuthorization request parameter, the] access_token field [SHALL be populated with] the [Oauth 2.0](https://oauth.net/2/) access token [as a] string data type",SHALL,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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
287
|
+
cds-hooks_2.0,67,https://cds-hooks.hl7.org/2.0/#passing-the-access-token-to-the-cds-service,"[When sending a fhirAuthorization request parameter, the] token_type field [SHALL be populated with the] fixed value: 'Bearer'",SHALL,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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
288
|
+
cds-hooks_2.0,68,https://cds-hooks.hl7.org/2.0/#passing-the-access-token-to-the-cds-service,"[When sending a fhirAuthorization request parameter, the] expires_in field [SHALL be populated with the] the lifetime in seconds of the access token [as an] integer data type",SHALL,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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
289
|
+
cds-hooks_2.0,69,https://cds-hooks.hl7.org/2.0/#passing-the-access-token-to-the-cds-service,"[When sending a fhirAuthorization request parameter, the] scope field [SHALL be populated with the] the scopes the access token grants the CDS Service [as a] string data type",SHALL,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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
290
|
+
cds-hooks_2.0,70,https://cds-hooks.hl7.org/2.0/#passing-the-access-token-to-the-cds-service,"[When sending a fhirAuthorization request parameter, the] subject field [SHALL be populated with] the [Oauth 2.0](https://oauth.net/2/) client identifier of the CDS Service, as registered with the CDS Client's authorization server [as a] string data type",SHALL,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-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_optional_fields, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_optional_fields"
|
|
291
|
+
cds-hooks_2.0,71,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
292
|
+
cds-hooks_2.0,72,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
293
|
+
cds-hooks_2.0,73,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
294
|
+
cds-hooks_2.0,79,https://cds-hooks.hl7.org/2.0/#card-attributes,[When receiving a card object] the uuid field SHALL be included in any subsequent calls to the CDS service's feedback endpoint.,SHALL,Client,true,,,"",""
|
|
295
|
+
cds-hooks_2.0,86,https://cds-hooks.hl7.org/2.0/#card-attributes,"For non-urgent cards, the CDS Client MAY hide [the information from the detail field] until the user clicks a link like ""view more details.",MAY,Client,true,,,"",""
|
|
296
|
+
cds-hooks_2.0,91,https://cds-hooks.hl7.org/2.0/#card-attributes,"[When receiving a card object,] the source field [/ source object] should be the primary source of guidance for the decision support the card represents.",SHOULD,Client,true,,,"",""
|
|
297
|
+
cds-hooks_2.0,97,https://cds-hooks.hl7.org/2.0/#card-attributes,"[When receiving a card object,] CDS Clients that do not understand the value [in the selectionBehavior field] MUST treat the card as an error.",SHALL,Client,true,,,"",""
|
|
298
|
+
cds-hooks_2.0,101,https://cds-hooks.hl7.org/2.0/#card-attributes,"[When receiving a card object,] if override reasons are present … the CDS Client SHOULD present these reasons to the clinician when they dismiss a card.",SHOULD,Client,true,,,"",""
|
|
299
|
+
cds-hooks_2.0,102,https://cds-hooks.hl7.org/2.0/#card-attributes,"[When receiving a card object,] if override reasons are present … a CDS Client MAY augment the override reasons presented to the user with its own reasons.",MAY,Client,true,,,"",""
|
|
300
|
+
cds-hooks_2.0,114,https://cds-hooks.hl7.org/2.0/#source,"[When receiving a Source object,] the CDS Client may ignore or scale the image during display as appropriate for user experience.",MAY,Client,true,,,"",""
|
|
301
|
+
cds-hooks_2.0,125,https://cds-hooks.hl7.org/2.0/#suggestion,"Within a suggestion, all actions … [SHALL use] AND [logic], such that a user selecting a suggestion selects all of the actions within it.",SHALL,"Client,Service",true,,,"",""
|
|
302
|
+
cds-hooks_2.0,126,https://cds-hooks.hl7.org/2.0/#suggestion,"[When receiving a Suggestion object,] When a suggestion contains multiple actions, the actions SHOULD be processed as per FHIR's rules for processing [transactions](https://hl7.org/fhir/http.html#trules) with the CDS Client's fhirServer as the base url for the inferred full URL of the transaction bundle entries. (Specifically, deletes happen first, then creates, then updates).",SHOULD,Client,true,,,"",""
|
|
303
|
+
cds-hooks_2.0,137,https://cds-hooks.hl7.org/2.0/#reasons-for-rejecting-a-card,CDS Clients MAY incorporate [the card.overrideReason.display] into their user interface,MAY,Client,false,,,"",""
|
|
304
|
+
cds-hooks_2.0,143,https://cds-hooks.hl7.org/2.0/#link,"[When receiving a Link object and the link.type field is smart,] CDS Client should ensure the SMART app launch URL is populated with the appropriate SMART launch parameters.",SHOULD,Client,true,,,"",""
|
|
305
|
+
cds-hooks_2.0,149,https://cds-hooks.hl7.org/2.0/#feedback,a CDS Client SHOULD be capable of sending feedback [to send suggestion analytics to the CDS service],SHOULD,Client,false,,,"",""
|
|
306
|
+
cds-hooks_2.0,150,https://cds-hooks.hl7.org/2.0/#feedback,CDS Clients should report ... end-user interactions as feedback.,SHOULD,Client,false,,,"",""
|
|
307
|
+
cds-hooks_2.0,151,https://cds-hooks.hl7.org/2.0/#feedback,A CDS Client provides feedback by POSTing a JSON document,SHALL,Client,false,,,"",""
|
|
308
|
+
cds-hooks_2.0,152,https://cds-hooks.hl7.org/2.0/#feedback,"The [service's] feedback endpoint can ([SHALL]) be constructed from the CDS Service endpoint and a path segment of ""feedback"" as {baseUrl}/cds-services/{service.id}/feedback",SHALL,Client,true,,,"",""
|
|
309
|
+
cds-hooks_2.0,153,https://cds-hooks.hl7.org/2.0/#feedback,"The feedback endpoint [for submission] can ([SHALL]) be constructed from the CDS Service endpoint and a path segment of ""feedback"" as {baseUrl}/cds-services/{service.id}/feedback",SHALL,Client,false,,,"",""
|
|
310
|
+
cds-hooks_2.0,154,https://cds-hooks.hl7.org/2.0/#feedback,The request to the feedback endpoint SHALL be an object containing an array [of [Feedback](https://cds-hooks.hl7.org/2.0/#feedback) objects],SHALL,Client,false,,,"",""
|
|
311
|
+
cds-hooks_2.0,155,https://cds-hooks.hl7.org/2.0/#feedback,"[When sending a feedback object,] the card field is required [and SHALL be a] string data type [containing] the card.uuid from the CDS Hooks response",SHALL,Client,true,,,"",""
|
|
312
|
+
cds-hooks_2.0,156,https://cds-hooks.hl7.org/2.0/#feedback,"[When sending a feedback object,] the outcome field is required [and SHALL be a] string data type [with a value of either] accepted or overridden",SHALL,Client,true,,,"",""
|
|
313
|
+
cds-hooks_2.0,157,https://cds-hooks.hl7.org/2.0/#feedback,"[When sending a feedback object,] the outcome field is required [and SHALL be a] string data type [with a value of either] accepted or overridden",SHALL,Client,true,,,"",""
|
|
314
|
+
cds-hooks_2.0,158,https://cds-hooks.hl7.org/2.0/#feedback,"[When sending a feedback object,] the acceptedSuggestions field is an array of json objects and is required [when feedback.outcome is accepted]",SHALL,Client,true,,,"",""
|
|
315
|
+
cds-hooks_2.0,159,https://cds-hooks.hl7.org/2.0/#feedback,"[When sending a feedback object,] the overrideReason field is a overrideReason object",SHALL,Client,true,,,"",""
|
|
316
|
+
cds-hooks_2.0,160,https://cds-hooks.hl7.org/2.0/#feedback,"[When sending a feedback object,] the overrideReason field is optional",MAY,Client,true,,,"",""
|
|
317
|
+
cds-hooks_2.0,161,https://cds-hooks.hl7.org/2.0/#feedback,"[When sending a feedback object,] the outcomeTimestamp field is required [and SHALL be a] string data type [using the] [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) representation of the date and time in Coordinated Universal Time (UTC) when action was taken on the card, as profiled in [section 5.6 of RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)",SHALL,Client,true,,,"",""
|
|
318
|
+
cds-hooks_2.0,162,https://cds-hooks.hl7.org/2.0/#suggestion-accepted,"[When sending an AcceptedSuggestion object], the id field is required [and SHALL be a] string data type [containing] card.suggestion.uuid from the CDS Hooks response",SHALL,Client,true,,,"",""
|
|
319
|
+
cds-hooks_2.0,163,https://cds-hooks.hl7.org/2.0/#suggestion-accepted,"If either the card or the suggestion has no uuid, the CDS Client does not send a [feedback] notification",SHALL,Client,true,,,"",""
|
|
320
|
+
cds-hooks_2.0,164,https://cds-hooks.hl7.org/2.0/#card-ignored,If the end-user doesn't interact with the CDS Service's card at all … the CDS Client [SHALL NOT] inform the CDS Service of the rejected guidance,SHALL NOT,Client,true,,,"",""
|
|
321
|
+
cds-hooks_2.0,165,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
322
|
+
cds-hooks_2.0,166,https://cds-hooks.hl7.org/2.0/#overridereason,"[When sending a overrideReason object,] the userComment field is a string data type",SHALL,Client,true,,,"",""
|
|
323
|
+
cds-hooks_2.0,167,https://cds-hooks.hl7.org/2.0/#overridereason,"[When sending a overrideReason object,] the userComment field is optional",MAY,Client,true,,,"",""
|
|
324
|
+
cds-hooks_2.0,168,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
325
|
+
cds-hooks_2.0,169,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
326
|
+
cds-hooks_2.0,170,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
327
|
+
cds-hooks_2.0,171,https://cds-hooks.hl7.org/2.0/#trusting-cds-services,The CDS Service can be registered with the CDS Client's authorization server,MAY,Client,false,,,"",""
|
|
328
|
+
cds-hooks_2.0,172,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
329
|
+
cds-hooks_2.0,173,https://cds-hooks.hl7.org/2.0/#trusting-cds-services,CDS Client SHALL deny access to a requested resource if it is outside the user's authorized scope,SHALL,Client,false,,,"",""
|
|
330
|
+
cds-hooks_2.0,174,https://cds-hooks.hl7.org/2.0/#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.01, 1.1.02, 2.1","crd_client-crd_v201_client_hook_invocation-crd_v201_client_registration-crd_v201_client_registration_verification, crd_client-crd_v201_client_hook_invocation-crd_v201_client_registration-crd_v201_client_service_registration_attestation, crd_client-crd_v201_client_fhir_api-Group01"
|
|
331
|
+
cds-hooks_2.0,178,https://cds-hooks.hl7.org/2.0/#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:
|
|
332
|
+
Authorization: Bearer {{JWT}}",SHALL,Client,true,,,"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","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_decode_auth_token"
|
|
333
|
+
cds-hooks_2.0,179,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
334
|
+
cds-hooks_2.0,180,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
335
|
+
cds-hooks_2.0,181,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
336
|
+
cds-hooks_2.0,182,https://cds-hooks.hl7.org/2.0/#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.2.03, 1.2.2.2.03, 1.2.3.2.03, 1.2.4.2.03, 1.2.5.2.03, 1.2.6.2.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_header"
|
|
337
|
+
cds-hooks_2.0,183,https://cds-hooks.hl7.org/2.0/#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.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","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_retrieve_jwks"
|
|
338
|
+
cds-hooks_2.0,184,https://cds-hooks.hl7.org/2.0/#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.2.03, 1.2.2.2.03, 1.2.3.2.03, 1.2.4.2.03, 1.2.5.2.03, 1.2.6.2.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_header"
|
|
339
|
+
cds-hooks_2.0,185,https://cds-hooks.hl7.org/2.0/#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.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","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_retrieve_jwks"
|
|
340
|
+
cds-hooks_2.0,186,https://cds-hooks.hl7.org/2.0/#trusting-cds-clients,"[When sending a JWT header,] the jku field is optional",MAY,Client,true,,,"",""
|
|
341
|
+
cds-hooks_2.0,187,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
342
|
+
cds-hooks_2.0,188,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
343
|
+
cds-hooks_2.0,189,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
344
|
+
cds-hooks_2.0,190,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
345
|
+
cds-hooks_2.0,191,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
346
|
+
cds-hooks_2.0,192,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
347
|
+
cds-hooks_2.0,193,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
348
|
+
cds-hooks_2.0,194,https://cds-hooks.hl7.org/2.0/#trusting-cds-clients,"[When sending a JWT payload,] the tenant field is optional",MAY,Client,true,,,"",""
|
|
349
|
+
cds-hooks_2.0,196,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
350
|
+
cds-hooks_2.0,197,https://cds-hooks.hl7.org/2.0/#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.1.01, 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","crd_client-crd_v201_client_hook_invocation-crd_v201_client_registration-crd_v201_client_registration_verification, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_retrieve_jwks"
|
|
351
|
+
cds-hooks_2.0,198,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
352
|
+
cds-hooks_2.0,199,https://cds-hooks.hl7.org/2.0/#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.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","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_retrieve_jwks"
|
|
353
|
+
cds-hooks_2.0,200,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
354
|
+
cds-hooks_2.0,202,https://cds-hooks.hl7.org/2.0/#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.2.03, 1.2.2.2.03, 1.2.3.2.03, 1.2.4.2.03, 1.2.5.2.03, 1.2.6.2.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_header"
|
|
355
|
+
cds-hooks_2.0,203,https://cds-hooks.hl7.org/2.0/#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.2.04, 1.2.2.2.04, 1.2.3.2.04, 1.2.4.2.04, 1.2.5.2.04, 1.2.6.2.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group02-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group02-crd_v201_token_payload"
|
|
356
|
+
cds-hooks_2.0,204,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
357
|
+
cds-hooks_2.0,205,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
358
|
+
cds-hooks_2.0,206,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
359
|
+
cds-hooks_2.0,208,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
360
|
+
cds-hooks_2.0,209,https://cds-hooks.hl7.org/2.0/#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,,,"",""
|
|
361
|
+
cds-hooks_2.0,214,https://cds-hooks.hl7.org/2.0/#extensions,The value of an extension element MUST be a pre-coordinated JSON object,SHALL,"Client,Service",false,,,"",""
|
|
362
|
+
cds-hooks_2.0,215,https://cds-hooks.hl7.org/2.0/#extensions,"Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation",SHOULD,"Client,Service",false,,,"",""
|
|
363
|
+
cds-hooks-library_1.0.1,17,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook the context field] `userId`[is] REQUIRED,SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
364
|
+
cds-hooks-library_1.0.1,18,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook if context field] `userId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
365
|
+
cds-hooks-library_1.0.1,19,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,"[When invoking the appointment-book hook if context field] `userId`[is populated it SHALL be t]he id of the current user … of type [Practitioner](https://www.hl7.org/fhir/practitioner.html), [PractitionerRole](https://www.hl7.org/fhir/practitionerrole.html), [Patient](https://www.hl7.org/fhir/patient.html), or [RelatedPerson](https://www.hl7.org/fhir/relatedperson.html).",SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
366
|
+
cds-hooks-library_1.0.1,21,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook the context field] `patientId`[is] REQUIRED,SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
367
|
+
cds-hooks-library_1.0.1,22,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook if context field] `patientId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
368
|
+
cds-hooks-library_1.0.1,23,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook if context field] `patientId`[is populated it SHALL be t]he FHIR `Patient.id` of Patient appointment(s) is/are for,SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
369
|
+
cds-hooks-library_1.0.1,25,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook the context field] `encounterId`[is] OPTIONAL,MAY,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
370
|
+
cds-hooks-library_1.0.1,26,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook if context field] `encounterId`[is populated it SHALL be a ] *string*,SHALL,Client,true,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
371
|
+
cds-hooks-library_1.0.1,27,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook if context field] `encounterId`[is populated it SHALL be t]he FHIR `Encounter.id` of Encounter where booking was initiated,SHALL,Client,true,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
372
|
+
cds-hooks-library_1.0.1,29,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook the context field] `appointments`[is] REQUIRED,SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
373
|
+
cds-hooks-library_1.0.1,30,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook if context field] `appointments`[is populated it SHALL be an ] *object*,SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
374
|
+
cds-hooks-library_1.0.1,31,https://cds-hooks.hl7.org/hooks/STU1/appointment-book.html#context,[When invoking the appointment-book hook if context field] `appointments`[is populated it SHALL be a] FHIR Bundle of Appointments in 'proposed' state,SHALL,Client,false,,,1.2.1.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group03-crd_v201_hook_request_valid_context
|
|
375
|
+
cds-hooks-library_1.0.1,33,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook the context field] `userId`[is] REQUIRED,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
376
|
+
cds-hooks-library_1.0.1,34,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook if context field] `userId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
377
|
+
cds-hooks-library_1.0.1,35,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook if context field] `userId`[is populated it SHALL be t]he id of the current user … of type [Practitioner](https://www.hl7.org/fhir/practitioner.html) or [PractitionerRole](https://www.hl7.org/fhir/practitionerrole.html).,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
378
|
+
cds-hooks-library_1.0.1,37,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook the context field] `patientId`[is] REQUIRED,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
379
|
+
cds-hooks-library_1.0.1,38,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook if context field] `patientId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
380
|
+
cds-hooks-library_1.0.1,39,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook if context field] `patientId`[is populated it SHALL be t]he FHIR `Patient.id` of the Patient the Encounter is for,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
381
|
+
cds-hooks-library_1.0.1,41,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook the context field] `encounterId`[is] REQUIRED,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
382
|
+
cds-hooks-library_1.0.1,42,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook if context field] `encounterId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
383
|
+
cds-hooks-library_1.0.1,43,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-start hook if context field] `encounterId`[is populated it SHALL be t]he FHIR `Encounter.id` of the Encounter being started,SHALL,Client,false,,,1.2.2.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group03-crd_v201_hook_request_valid_context
|
|
384
|
+
cds-hooks-library_1.0.1,45,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-discharge hook the context field] `userId`[is] REQUIRED,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
385
|
+
cds-hooks-library_1.0.1,46,https://cds-hooks.hl7.org/hooks/STU1/encounter-discharge.html#context,[When invoking the encounter-discharge hook if context field] `userId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
386
|
+
cds-hooks-library_1.0.1,47,https://cds-hooks.hl7.org/hooks/STU1/encounter-discharge.html#context,[When invoking the encounter-discharge hook if context field] `userId`[is populated it SHALL be t]he id of the current user … of type [Practitioner](https://www.hl7.org/fhir/practitioner.html) or [PractitionerRole](https://www.hl7.org/fhir/practitionerrole.html).,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
387
|
+
cds-hooks-library_1.0.1,49,https://cds-hooks.hl7.org/hooks/STU1/encounter-discharge.html#context,[When invoking the encounter-discharge hook the context field] `patientId`[is] REQUIRED,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
388
|
+
cds-hooks-library_1.0.1,50,https://cds-hooks.hl7.org/hooks/STU1/encounter-discharge.html#context,[When invoking the encounter-discharge hook if context field] `patientId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
389
|
+
cds-hooks-library_1.0.1,51,https://cds-hooks.hl7.org/hooks/STU1/encounter-discharge.html#context,[When invoking the encounter-discharge hook if context field] `patientId`[is populated it SHALL be t]he FHIR `Patient.id` of the [patient] being discharged,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
390
|
+
cds-hooks-library_1.0.1,53,https://cds-hooks.hl7.org/hooks/STU1/encounter-discharge.html#context,[When invoking the encounter-discharge hook the context field] `encounterId`[is] REQUIRED,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
391
|
+
cds-hooks-library_1.0.1,54,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.html#context,[When invoking the encounter-discharge hook if context field] `encounterId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
392
|
+
cds-hooks-library_1.0.1,55,https://cds-hooks.hl7.org/hooks/STU1/encounter-discharge.html#context,[When invoking the encounter-discharge hook if context field] `encounterId`[is populated it SHALL be t]he FHIR `Encounter.id` of the Encounter being ended,SHALL,Client,false,,,1.2.3.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group03-crd_v201_hook_request_valid_context
|
|
393
|
+
cds-hooks-library_1.0.1,57,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook the context field] `patientId`[is] REQUIRED,SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
394
|
+
cds-hooks-library_1.0.1,58,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook if context field] `patientId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
395
|
+
cds-hooks-library_1.0.1,59,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook if context field] `patientId`[is populated it SHALL be t]he FHIR `Patient.id` of the current patient in context,SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
396
|
+
cds-hooks-library_1.0.1,61,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook the context field] `dispatchedOrders`[is] REQUIRED,SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
397
|
+
cds-hooks-library_1.0.1,62,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook if context field] `dispatchedOrders`[is populated it SHALL be an ] *array*,SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
398
|
+
cds-hooks-library_1.0.1,63,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook if context field] `dispatchedOrders`[is populated it SHALL be a c]ollection of the FHIR local references for the Request resource(s) for which fulfillment is sought,SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
399
|
+
cds-hooks-library_1.0.1,65,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook the context field] `performer`[is] REQUIRED,SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
400
|
+
cds-hooks-library_1.0.1,66,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook if context field] `performer`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
401
|
+
cds-hooks-library_1.0.1,67,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,"[When invoking the order-dispatch hook if context field] `performer`[is populated it SHALL be t]he FHIR local reference for the Practitioner, PractitionerRole, Organization, CareTeam, etc. who is being asked to execute the order",SHALL,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
402
|
+
cds-hooks-library_1.0.1,69,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook the context field] `fulfillmentTasks`[is] Optional,MAY,Client,false,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
403
|
+
cds-hooks-library_1.0.1,70,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook if context field] `fulfillmentTasks`[is populated it SHALL be an] *array*,SHALL,Client,true,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
404
|
+
cds-hooks-library_1.0.1,71,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook if context field] `fulfillmentTasks`[is populated it SHALL be a c]ollection of the Task instances (as objects) that provides a full description of the fulfillment request - including the timing and any constraints on fulfillment.,SHALL,Client,true,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
405
|
+
cds-hooks-library_1.0.1,72,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.html#context,[When invoking the order-dispatch hook if context field] `fulfillmentTasks`[is populated] each [task] will be for a separate order and SHALL reference one of the dispatched-orders.,SHALL,Client,true,,,1.2.5.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group03-crd_v201_hook_request_valid_context
|
|
406
|
+
cds-hooks-library_1.0.1,74,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook the context field] `userId`[is] REQUIRED,SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
407
|
+
cds-hooks-library_1.0.1,75,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook if context field] `userId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
408
|
+
cds-hooks-library_1.0.1,76,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook if context field] `userId`[is populated it SHALL be t]he id of the current user … of type [Practitioner](https://www.hl7.org/fhir/practitioner.html) or [PractitionerRole](https://www.hl7.org/fhir/practitionerrole.html).,SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
409
|
+
cds-hooks-library_1.0.1,78,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook the context field] `patientId`[is] REQUIRED,SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
410
|
+
cds-hooks-library_1.0.1,79,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook if context field] `patientId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
411
|
+
cds-hooks-library_1.0.1,80,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook if context field] `patientId`[is populated it SHALL be t]he FHIR `Patient.id` of the current patient in context,SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
412
|
+
cds-hooks-library_1.0.1,82,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook the context field] `encounterId`[is] OPTIONAL,MAY,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
413
|
+
cds-hooks-library_1.0.1,83,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook if context field] `encounterId`[is populated it SHALL be a ] *string*,SHALL,Client,true,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
414
|
+
cds-hooks-library_1.0.1,84,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook if context field] `encounterId`[is populated it SHALL be t]he FHIR `Encounter.id` of the current encounter in context,SHALL,Client,true,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
415
|
+
cds-hooks-library_1.0.1,86,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook the context field] `selections`[is] Optional,MAY,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
416
|
+
cds-hooks-library_1.0.1,87,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook if context field] `selections`[is populated it SHALL be an] *array*,SHALL,Client,true,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
417
|
+
cds-hooks-library_1.0.1,88,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,"[When invoking the order-select hook if context field] `selections`[is populated it SHALL be t]he FHIR id of the newly selected order(s) … [that]
|
|
418
|
+
references FHIR resources in the `draftOrders` Bundle.",SHALL,Client,true,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
419
|
+
cds-hooks-library_1.0.1,90,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook the context field] `draftOrders`[is] REQUIRED,SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
420
|
+
cds-hooks-library_1.0.1,91,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,[When invoking the order-select hook if context field] `draftOrders`[is populated it SHALL be an ] *object*,SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
421
|
+
cds-hooks-library_1.0.1,92,https://cds-hooks.hl7.org/hooks/STU1/order-select.html#context,"[When invoking the order-select hook if context field] `draftOrders`[is populated it SHALL be a] Bundle of FHIR request resources with a draft status, representing orders that aren't yet signed from the current ordering session.",SHALL,Client,false,,,1.2.4.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group03-crd_v201_hook_request_valid_context
|
|
422
|
+
cds-hooks-library_1.0.1,1,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook the context field] `userId`[is] REQUIRED,SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
423
|
+
cds-hooks-library_1.0.1,2,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook if context field] `userId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
424
|
+
cds-hooks-library_1.0.1,3,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook if context field] `userId`[is populated it SHALL be t]he id of the current user … of type [Practitioner](https://www.hl7.org/fhir/practitioner.html) or [PractitionerRole](https://www.hl7.org/fhir/practitionerrole.html).,SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
425
|
+
cds-hooks-library_1.0.1,5,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook the context field] `patientId`[is] REQUIRED,SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
426
|
+
cds-hooks-library_1.0.1,6,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook if context field] `patientId`[is populated it SHALL be a ] *string*,SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
427
|
+
cds-hooks-library_1.0.1,7,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook if context field] `patientId`[is populated it SHALL be t]he FHIR `Patient.id` of the current patient in context,SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
428
|
+
cds-hooks-library_1.0.1,9,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook the context field] `encounterId`[is] OPTIONAL,MAY,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
429
|
+
cds-hooks-library_1.0.1,10,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook if context field] `encounterId`[is populated it SHALL be a ] *string*,SHALL,Client,true,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
430
|
+
cds-hooks-library_1.0.1,11,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook if context field] `encounterId`[is populated it SHALL be t]he FHIR `Encounter.id` of the current encounter in context,SHALL,Client,true,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
431
|
+
cds-hooks-library_1.0.1,13,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook the context field] `draftOrders`[is] REQUIRED,SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
432
|
+
cds-hooks-library_1.0.1,14,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,[When invoking the order-sign hook if context field] `draftOrders`[is populated it SHALL be an ] *object*,SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|
|
433
|
+
cds-hooks-library_1.0.1,15,https://cds-hooks.hl7.org/hooks/STU1/order-sign.html#context,"[When invoking the order-sign hook if context field] `draftOrders`[is populated it SHALL be a] Bundle of FHIR request resources with a draft status, representing orders that aren't yet signed from the current ordering session.",SHALL,Client,false,,,1.2.6.3.03,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group03-crd_v201_hook_request_valid_context
|