davinci_crd_test_kit 0.14.0 → 0.14.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/config/presets/{inferno_crd_server_suite.json.erb → client_against_inferno_crd_server_suite.json.erb} +0 -33
- data/config/presets/{ri_crd_request_generator.json.erb → client_against_ri_crd_request_generator.json.erb} +1 -14
- data/config/presets/client_v221_against_inferno_crd_server_suite.json.erb +84 -0
- data/config/presets/client_v221_against_ri_br_provider.json.erb +31 -0
- data/config/presets/{ri_crd_request_generator.json_v221.json.erb → client_v221_against_ri_crd_request_generator.json.erb} +1 -1
- data/config/presets/{inferno_crd_client_suite.json.erb → server_against_inferno_crd_client_suite.json.erb} +0 -43
- data/config/presets/{ri_crd_server.json.erb → server_against_ri_crd_server.json.erb} +1 -44
- data/config/presets/{inferno_crd_client_suite_v221.json.erb → server_v221_against_inferno_crd_client_suite.json.erb} +48 -45
- data/config/presets/{inferno_crd_client_suite_prefetch_subset_v221.json.erb → server_v221_against_inferno_crd_client_suite_prefetch_subset.json.erb} +0 -46
- data/config/presets/server_v221_against_inferno_g31_suite.json.erb +49 -0
- data/lib/davinci_crd_test_kit/client/cross_hook_helper.rb +26 -0
- data/lib/davinci_crd_test_kit/client/endpoints/custom_service_response.rb +7 -7
- data/lib/davinci_crd_test_kit/client/endpoints/gather_response_generation_data.rb +4 -1
- data/lib/davinci_crd_test_kit/client/endpoints/hook_request_endpoint.rb +70 -39
- data/lib/davinci_crd_test_kit/client/endpoints/mock_service_response.rb +26 -7
- data/lib/davinci_crd_test_kit/client/endpoints/mocked_card_responses/external_reference.json +1 -1
- data/lib/davinci_crd_test_kit/client/endpoints/mocked_card_responses/launch_smart_app.json +0 -7
- data/lib/davinci_crd_test_kit/client/endpoints/scenario_service_response.rb +54 -0
- data/lib/davinci_crd_test_kit/client/tagged_request_load_helper.rb +8 -27
- data/lib/davinci_crd_test_kit/client/v2.0.1/auth/retrieve_jwks_test.rb +35 -23
- data/lib/davinci_crd_test_kit/client/v2.0.1/auth/token_payload_test.rb +34 -21
- data/lib/davinci_crd_test_kit/client/v2.0.1/cds-services-v201.json +20 -20
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_appointment_book_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_encounter_discharge_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_encounter_start_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_hooks_group.rb +5 -5
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_dispatch_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_select_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/client_order_sign_group.rb +12 -10
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_coverage_information.rb +3 -36
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_external_reference.rb +3 -36
- data/lib/davinci_crd_test_kit/client/v2.0.1/must_support/client_card_must_support_instructions.rb +3 -36
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_fetched_data_test.rb +4 -13
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_request/hook_request_prefetch_equals_queried_test.rb +3 -13
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_response/client_display_cards_attest.rb +3 -13
- data/lib/davinci_crd_test_kit/client/v2.0.1/verify_response/inferno_response_validation.rb +3 -13
- data/lib/davinci_crd_test_kit/client/v2.2.1/api/client_coverage_info_update_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/attestation_instructions.rb +10 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_authorized_scope_attestation_test.rb +45 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_coverage_based_invocation_attestation_test.rb +44 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_data_element_expectations_attestation_test.rb +44 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_hook_invocation_logging_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_must_support_exposure_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_must_support_use_attestation_test.rb +41 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_order_sign_support_attestation_test.rb +42 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_prefetch_key_omission_attestation_test.rb +42 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_resource_identifiers_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_response_case_distinction_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_security_and_privacy_attestation_test.rb +43 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/attestations/client_workflow_integration_attestation_test.rb +44 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/decode_auth_token_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/retrieve_jwks_test.rb +29 -18
- data/lib/davinci_crd_test_kit/client/v2.2.1/auth/token_payload_test.rb +35 -22
- data/lib/davinci_crd_test_kit/client/v2.2.1/cds-services-prefetch-subset-v221.json +47 -47
- data/lib/davinci_crd_test_kit/client/v2.2.1/cds-services-v221.json +50 -50
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_appointment_book_group.rb +24 -15
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_attestations_group.rb +49 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_cross_hook_group.rb +22 -6
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_cross_hook_interaction_group.rb +98 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_encounter_discharge_group.rb +19 -11
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_encounter_start_group.rb +19 -11
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_fhir_api_group.rb +14 -12
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_hooks_group.rb +25 -5
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_long_running_hook_group.rb +3 -2
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_dispatch_group.rb +23 -15
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_select_group.rb +19 -11
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_order_sign_group.rb +23 -15
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_registration_group.rb +6 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_scenarios_group.rb +26 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_self_pay_hook_group.rb +36 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/client_unknown_content_hook_group.rb +34 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/crd_client_suite.rb +24 -3
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_card_must_support_coverage_information_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_fhirpath_collection_as_comma_delimited_string_test.rb +4 -11
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_hook_instances_unique_test.rb +1 -9
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_location_address_propagation_test.rb +6 -2
- data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_prefetch_complete_and_subset_test.rb +3 -12
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/appointment_book_receive_request_test.rb +8 -89
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/base_hook_invocation_receive_request_test.rb +163 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/cross_hooks_receive_request_test.rb +97 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/encounter_discharge_receive_request_test.rb +8 -90
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/encounter_start_receive_request_test.rb +8 -90
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_dispatch_receive_request_test.rb +8 -98
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_select_receive_request_test.rb +8 -98
- data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_sign_receive_request_test.rb +8 -98
- data/lib/davinci_crd_test_kit/client/v2.2.1/long_running/client_long_running_receive_request_test.rb +10 -2
- data/lib/davinci_crd_test_kit/client/v2.2.1/long_running/client_skip_long_running_attestation_test.rb +11 -6
- data/lib/davinci_crd_test_kit/client/v2.2.1/registration/client_service_registration_attestation_test.rb +2 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/self_pay/client_self_pay_no_request_test.rb +30 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/self_pay/client_self_pay_workflow_test.rb +55 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/unknown_content/client_unknown_content_attestation_test.rb +99 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/unknown_content/client_unknown_content_receive_request_test.rb +62 -0
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_conformance_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_coverage_verification_test.rb +10 -2
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_data_fetch_verification_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_granted_scopes_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_prefetch_complete_test.rb +7 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_prefetch_profiles_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_requested_version_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_secured_transport_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/client_display_cards_attest.rb +54 -21
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/hook_response_support_coverage_information_test.rb +1 -1
- data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/inferno_response_validation.rb +6 -3
- data/lib/davinci_crd_test_kit/cross_suite/cards_identification.rb +18 -0
- data/lib/davinci_crd_test_kit/cross_suite/logical_models_override_helper.rb +30 -13
- data/lib/davinci_crd_test_kit/cross_suite/prefetch_completeness_checker.rb +25 -11
- data/lib/davinci_crd_test_kit/cross_suite/prefetch_profile_validation.rb +2 -0
- data/lib/davinci_crd_test_kit/cross_suite/requests_logical_model_validation.rb +28 -28
- data/lib/davinci_crd_test_kit/cross_suite/response_logical_model_validation.rb +211 -43
- data/lib/davinci_crd_test_kit/cross_suite/tags.rb +7 -0
- data/lib/davinci_crd_test_kit/requirements/cds-hooks_3.0.0-ballot_requirements.xlsx +0 -0
- data/lib/davinci_crd_test_kit/requirements/davinci_crd_test_kit_requirements.csv +6 -2
- data/lib/davinci_crd_test_kit/requirements/generated/crd_client_requirements_coverage.csv +107 -107
- data/lib/davinci_crd_test_kit/requirements/generated/crd_client_v221_requirements_coverage.csv +101 -97
- data/lib/davinci_crd_test_kit/requirements/generated/crd_server_requirements_coverage.csv +18 -18
- data/lib/davinci_crd_test_kit/requirements/generated/crd_server_v221_requirements_coverage.csv +43 -39
- data/lib/davinci_crd_test_kit/requirements/hl7.fhir.us.davinci-crd_2.2.1_requirements.xlsx +0 -0
- data/lib/davinci_crd_test_kit/server/jobs/invoke_hook.rb +3 -3
- data/lib/davinci_crd_test_kit/server/jobs/invoke_hook_no_special_requests.rb +17 -0
- data/lib/davinci_crd_test_kit/server/jobs/invoke_hook_with_bad_auth.rb +14 -0
- data/lib/davinci_crd_test_kit/server/server_abstract_invoke_hook_test.rb +24 -6
- data/lib/davinci_crd_test_kit/server/server_hook_helper.rb +2 -2
- data/lib/davinci_crd_test_kit/server/v2.0.1/crd_server_suite.rb +1 -1
- data/lib/davinci_crd_test_kit/server/v2.0.1/server_hooks_group.rb +5 -5
- data/lib/davinci_crd_test_kit/server/v2.2.1/crd_server_suite.rb +3 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/discovery/discovery_standard_prefetch_expressions_test.rb +165 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/interaction/server_invoke_hook_single_request_test.rb +22 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_appointment_book_group.rb +10 -102
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_demonstrate_hook_response_group.rb +3 -2
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_discovery_group.rb +2 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_encounter_discharge_group.rb +10 -97
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_encounter_start_group.rb +10 -97
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_hooks_group.rb +5 -5
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_dispatch_group.rb +10 -103
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_select_group.rb +12 -116
- data/lib/davinci_crd_test_kit/server/v2.2.1/server_order_sign_group.rb +12 -121
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_response_group.rb +23 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/coverage_info_reason_test.rb +108 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/coverage_not_found_group.rb +116 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/no_active_coverage_group.rb +115 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/no_member_found_group.rb +117 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/technical_issues_group.rb +121 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/specific_coverage_responses/technical_issues_invoke_test.rb +22 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_context_validation_test.rb +1 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_optional_fields_validation_test.rb +1 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_request/service_request_required_fields_validation_test.rb +1 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/additional_orders_validation_test.rb +78 -35
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_information_card_absence_test.rb +76 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_information_system_action_validation_test.rb +70 -124
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/create_or_update_coverage_info_response_validation_test.rb +83 -39
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/external_reference_card_validation_test.rb +59 -17
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/form_completion_response_validation_test.rb +80 -45
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/hook_request_resource_resolution.rb +37 -0
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/instructions_card_received_test.rb +57 -6
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/launch_smart_app_card_validation_test.rb +56 -17
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/propose_alternate_request_card_validation_test.rb +52 -25
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/service_response_validation_test.rb +17 -51
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_cds_hooks_elements_test.rb +1 -1
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_configuration_test.rb +1 -1
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/unknown_context_test.rb +1 -1
- data/lib/davinci_crd_test_kit/version.rb +2 -2
- metadata +54 -16
- data/config/presets/inferno_crd_server_suite_v221.json.erb +0 -94
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/card_optional_fields_validation_test.rb +0 -57
- data/lib/davinci_crd_test_kit/server/v2.2.1/verify_response/coverage_information_system_action_received_test.rb +0 -65
|
@@ -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,,,,"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-
|
|
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_order_select-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_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_encounter_discharge-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,7 +81,7 @@ 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,,,,"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-
|
|
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_order_select-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, 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_encounter_discharge-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,,,,"",""
|
|
@@ -93,7 +93,7 @@ hl7.fhir.us.davinci-crd_2.0.1,67,https://hl7.org/fhir/us/davinci-crd/STU2/founda
|
|
|
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,,,,"1.2.1.3.03, 1.2.
|
|
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.3.3.03, 1.2.4.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
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,,,,"",""
|
|
99
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",,,,"",""
|
|
@@ -142,7 +142,7 @@ hl7.fhir.us.davinci-crd_2.0.1,146,https://hl7.org/fhir/us/davinci-crd/STU2/devia
|
|
|
142
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,,,,"",""
|
|
143
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,,,,"",""
|
|
144
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.
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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_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"
|
|
146
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,,,,"",""
|
|
147
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,,,,"",""
|
|
148
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,,,,"",""
|
|
@@ -159,30 +159,30 @@ hl7.fhir.us.davinci-crd_2.0.1,187,https://hl7.org/fhir/us/davinci-crd/STU2/hooks
|
|
|
159
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
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
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.
|
|
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.6.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
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
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.
|
|
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.
|
|
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.
|
|
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.6.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.6.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.6.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
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
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.3.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.3.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.3.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.3.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.3.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
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.4.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.4.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.4.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.4.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.4.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.4.1.01,crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_request
|
|
182
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,,,,"",""
|
|
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-
|
|
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-
|
|
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-
|
|
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_order_select-Group01-crd_v201_order_select_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_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_encounter_discharge-Group01-crd_v201_encounter_discharge_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_order_select-Group01-crd_v201_order_select_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_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_encounter_discharge-Group01-crd_v201_encounter_discharge_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_order_select-Group01-crd_v201_order_select_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_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_encounter_discharge-Group01-crd_v201_encounter_discharge_request"
|
|
186
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,,,,"",""
|
|
187
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,,,,"",""
|
|
188
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,,,"",""
|
|
@@ -193,18 +193,18 @@ hl7.fhir.us.davinci-crd_2.0.1,266,https://hl7.org/fhir/us/davinci-crd/STU2/cards
|
|
|
193
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,,,,"",""
|
|
194
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,,,,"",""
|
|
195
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,,,,"",""
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
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.3.3.03, 1.2.4.3.03, 1.2.5.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_sign-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"
|
|
208
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,,,,"",""
|
|
209
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,,,,"",""
|
|
210
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,,,,"",""
|
|
@@ -223,45 +223,45 @@ hl7.fhir.us.davinci-crd_2.0.1,319,https://hl7.org/fhir/us/davinci-crd/STU2/Capab
|
|
|
223
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
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
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-
|
|
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-
|
|
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_order_select-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_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_encounter_discharge-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_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_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, 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_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"
|
|
228
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-
|
|
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-
|
|
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_order_select-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, 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_encounter_discharge-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_order_select-Group01-crd_v201_order_select_request, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group01-crd_v201_order_sign_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_encounter_discharge-Group01-crd_v201_encounter_discharge_request"
|
|
231
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
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
233
|
- field: hook
|
|
234
234
|
- optionality: REQUIRED
|
|
235
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-
|
|
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_order_select-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, 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_encounter_discharge-Group03-crd_v201_hook_request_required_fields"
|
|
237
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
238
|
- field: hookInstance
|
|
239
239
|
- optionality: REQUIRED
|
|
240
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-
|
|
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_order_select-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, 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_encounter_discharge-Group03-crd_v201_hook_request_required_fields"
|
|
242
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
243
|
- field: fhirServer
|
|
244
244
|
- optionality: CONDITIONAL
|
|
245
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-
|
|
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_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_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, 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_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"
|
|
247
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
248
|
- field: fhirAuthorization
|
|
249
249
|
- optionality: OPTIONAL
|
|
250
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-
|
|
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_order_select-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, 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_encounter_discharge-Group03-crd_v201_hook_request_optional_fields"
|
|
252
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
253
|
- field: context
|
|
254
254
|
- optionality: REQUIRED
|
|
255
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-
|
|
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_order_select-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, 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_encounter_discharge-Group03-crd_v201_hook_request_required_fields"
|
|
257
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
258
|
- field: prefetch
|
|
259
259
|
- optionality: OPTIONAL
|
|
260
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-
|
|
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-
|
|
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_order_select-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, 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_encounter_discharge-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_order_select-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, 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_encounter_discharge-Group03-crd_v201_hook_request_required_fields"
|
|
263
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-
|
|
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_order_select-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, 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_encounter_discharge-Group03-crd_v201_hook_request_valid_prefetch"
|
|
265
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
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
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,,,"",""
|
|
@@ -272,9 +272,9 @@ cds-hooks_2.0,41,https://cds-hooks.hl7.org/2.0/#prefetch-template,The CDS Client
|
|
|
272
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
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
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-
|
|
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_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_sign-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_encounter_discharge-Group03-crd_v201_hook_request_prefetch_equals_queried"
|
|
276
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-
|
|
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_order_select-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, 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_encounter_discharge-Group03-crd_v201_hook_request_valid_prefetch"
|
|
278
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
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
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,,,"",""
|
|
@@ -282,12 +282,12 @@ cds-hooks_2.0,51,https://cds-hooks.hl7.org/2.0/#prefetch-template,CDS Clients MU
|
|
|
282
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
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
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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_order_select-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, 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_encounter_discharge-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_order_select-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, 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_encounter_discharge-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_order_select-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, 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_encounter_discharge-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_order_select-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, 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_encounter_discharge-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_order_select-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, 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_encounter_discharge-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_order_select-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, 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_encounter_discharge-Group03-crd_v201_hook_request_optional_fields"
|
|
291
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
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
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,,,"",""
|
|
@@ -329,30 +329,30 @@ cds-hooks_2.0,172,https://cds-hooks.hl7.org/2.0/#trusting-cds-services,Every int
|
|
|
329
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
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
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.
|
|
332
|
+
Authorization: Bearer {{JWT}}",SHALL,Client,true,,,"1.2.1.4.01, 1.2.2.4.01, 1.2.3.4.01, 1.2.4.4.01, 1.2.5.4.01, 1.2.6.4.01","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_decode_auth_token, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-crd_v201_decode_auth_token"
|
|
333
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.03, 1.2.2.4.03, 1.2.3.4.03, 1.2.4.4.03, 1.2.5.4.03, 1.2.6.4.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.02, 1.2.2.4.02, 1.2.3.4.02, 1.2.4.4.02, 1.2.5.4.02, 1.2.6.4.02","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.03, 1.2.2.4.03, 1.2.3.4.03, 1.2.4.4.03, 1.2.5.4.03, 1.2.6.4.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.02, 1.2.2.4.02, 1.2.3.4.02, 1.2.4.4.02, 1.2.5.4.02, 1.2.6.4.02","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-crd_v201_retrieve_jwks"
|
|
340
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.
|
|
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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-crd_v201_token_payload"
|
|
342
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-crd_v201_token_payload"
|
|
347
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
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.
|
|
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.
|
|
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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.02, 1.2.2.4.02, 1.2.3.4.02, 1.2.4.4.02, 1.2.5.4.02, 1.2.6.4.02","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-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-crd_v201_retrieve_jwks"
|
|
351
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.
|
|
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.4.02, 1.2.2.4.02, 1.2.3.4.02, 1.2.4.4.02, 1.2.5.4.02, 1.2.6.4.02","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_retrieve_jwks, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-crd_v201_retrieve_jwks"
|
|
353
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.
|
|
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.
|
|
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.4.03, 1.2.2.4.03, 1.2.3.4.03, 1.2.4.4.03, 1.2.5.4.03, 1.2.6.4.03","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_header, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-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.4.04, 1.2.2.4.04, 1.2.3.4.04, 1.2.4.4.04, 1.2.5.4.04, 1.2.6.4.04","crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_appointment_book-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_start-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_select-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_sign-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_order_dispatch-Group04-crd_v201_token_payload, crd_client-crd_v201_client_hook_invocation-crd_v201_client_hooks-crd_v201_client_encounter_discharge-Group04-crd_v201_token_payload"
|
|
356
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
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
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,,,"",""
|
|
@@ -381,15 +381,15 @@ cds-hooks-library_1.0.1,39,https://cds-hooks.hl7.org/hooks/STU1/encounter-start.
|
|
|
381
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
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
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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
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
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
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
|
|
@@ -403,31 +403,31 @@ cds-hooks-library_1.0.1,69,https://cds-hooks.hl7.org/hooks/STU1/order-dispatch.h
|
|
|
403
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
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
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.3.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.3.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.3.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.3.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.3.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.3.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.3.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.3.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.3.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.3.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.3.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
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
418
|
+
references FHIR resources in the `draftOrders` Bundle.",SHALL,Client,true,,,1.2.3.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.3.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.3.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.3.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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
|