RubyGems - us_core_test_kit - Versions diffs - 0.11.3 → 0.11.4 - Mend

us_core_test_kit 0.11.3 → 0.11.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2064) hide show

data/lib/us_core_test_kit/client/generated/v4.0.0/us_core_client_test_suite.rb CHANGED Viewed

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-require 'udap_security_test_kit'
 require 'smart_app_launch_test_kit'
 require_relative '../../../version'
 require_relative 'tags'
 require_relative 'urls'
 require_relative '../../metadata_helper'
-require_relative 'authorization_endpoint'
-require_relative 'token_endpoint'
 require_relative 'read_endpoint'
 require_relative 'search_endpoint'
 require_relative '../../test_helper'
@@ -17,7 +14,6 @@ require_relative 'wait_group'
 require_relative 'auth_smart_alca_group'
 require_relative 'auth_smart_alcs_group'
 require_relative 'auth_smart_alp_group'
-require_relative 'auth_udap_group'
 require_relative 'patient_client_group'
 require_relative 'allergy_intolerance_client_group'
 require_relative 'care_plan_client_group'
@@ -27,6 +23,7 @@ require_relative 'device_client_group'
 require_relative 'diagnostic_report_lab_client_group'
 require_relative 'diagnostic_report_note_client_group'
 require_relative 'document_reference_client_group'
+require_relative 'encounter_client_group'
 require_relative 'goal_client_group'
 require_relative 'immunization_client_group'
 require_relative 'medication_request_client_group'
@@ -44,10 +41,9 @@ require_relative 'pediatric_weight_for_height_client_group'
 require_relative 'pulse_oximetry_client_group'
 require_relative 'respiratory_rate_client_group'
 require_relative 'smokingstatus_client_group'
-require_relative 'procedure_client_group'
-require_relative 'encounter_client_group'
 require_relative 'organization_client_group'
 require_relative 'practitioner_client_group'
+require_relative 'procedure_client_group'
 require_relative 'provenance_client_group'
 module USCoreTestKit
@@ -57,13 +53,11 @@ module USCoreTestKit
         include URLs
         id :us_core_client_v400
         title 'US Core Client v4.0.0'
         description %(
 The US Core Test Kit Client Suite tests client systems for their conformance
-to the US Core Implementation Guide.
+to the [US Core Implementation Guide](http://hl7.org/fhir/us/core/STU4).
 # Scope
@@ -74,103 +68,63 @@ requirements and may change the test verification logic.
 # Test Methodology
-For these tests Inferno simulates the FHIR server. Inferno's simulated server contains
-data for each of the following US Core Profiles:
-* **Patient**
-  * id: us-core-client-tests-patient
-* **AllergyIntolerance**
-  * id: us-core-client-tests-allergy-intolerance
-* **CarePlan**
-  * id: us-core-client-tests-care-plan
-* **CareTeam**
-  * id: us-core-client-tests-care-team
-* **Condition**
-  * id: us-core-client-tests-condition
-* **Device**
-  * id: us-core-client-tests-device
-* **DiagnosticReportLab**
-  * id: us-core-client-tests-diagnostic-report-lab
-* **DiagnosticReportNote**
-  * id: us-core-client-tests-diagnostic-report-note
-* **DocumentReference**
-  * id: us-core-client-tests-document-reference
-* **Goal**
-  * id: us-core-client-tests-goal
-* **Immunization**
-  * id: us-core-client-tests-immunization
-* **MedicationRequest**
-  * id: us-core-client-tests-medication-request
-* **ObservationLab**
-  * id: us-core-client-tests-observation-lab
-* **BloodPressure**
-  * id: us-core-client-tests-blood-pressure
-* **Bmi**
-  * id: us-core-client-tests-bmi
-* **HeadCircumference**
-  * id: us-core-client-tests-head-circumference
-* **BodyHeight**
-  * id: us-core-client-tests-body-height
-* **BodyWeight**
-  * id: us-core-client-tests-body-weight
-* **BodyTemperature**
-  * id: us-core-client-tests-body-temperature
-* **HeartRate**
-  * id: us-core-client-tests-heart-rate
-* **PediatricBmiForAge**
-  * id: us-core-client-tests-pediatric-bmi-for-age
-* **HeadCircumferencePercentile**
-  * id: us-core-client-tests-head-circumference-percentile
-* **PediatricWeightForHeight**
-  * id: us-core-client-tests-pediatric-weight-for-height
-* **PulseOximetry**
-  * id: us-core-client-tests-pulse-oximetry
-* **RespiratoryRate**
-  * id: us-core-client-tests-respiratory-rate
-* **Smokingstatus**
-  * id: us-core-client-tests-smokingstatus
-* **Procedure**
-  * id: us-core-client-tests-procedure
-* **Encounter**
-  * id: us-core-client-tests-encounter
-* **Organization**
-  * id: us-core-client-tests-organization
-* **Practitioner**
-  * id: us-core-client-tests-practitioner
-* **Provenance**
-  * id: us-core-client-tests-provenance
+For these tests Inferno simulates the FHIR server containing data for each US Core Profile
+(see the *Available Instances* section below for details on the data served by Inferno).
 During execution, Inferno will wait for the client under test to issue requests and will
 respond to them with the requested data. Inferno will then evaluate the requests in aggregate
 to verify that they demonstrate that the client:
-* Retrieved instances of each profile
+* Retrieved a target instance for each profile.
 * Performed searches using the required search parameters and search parameter combinations
+  for the profile's resource type.
+# Interpreting the Results
+These tests will check for support for requesting data for every US Core profile.
+The "Read & Search" group includes a sub-group for each US Core profile. Groups
+for profiles of resources that are required by the US Core Client CapabilityStatement
+are marked as required while groups for others are optional. Each profile group will be
+evaluated on every run through these tests, but feedback will only be provided on
+profiles of resource types that the client makes requests for.
+- If a client makes a request for a given resource type, support for all profiles of that
+  resource type will be evaluated, meaning that the group for each profile of that resource
+  type will be executed, checking that the client read the target instance for that profile
+  and perform searches with all required search parameters and combinations for the resource
+  type. The executed group will pass or fail and include details of the issues encountered by
+  Inferno.
+- If a client makes no requests for a given resource type, support is not evaluated. If support
+  for the resource type is required, the tests will be marked as skiped, forcing an overall
+  failure. Otherwise, the tests will be marked as omitted on the assumption that the client
+  does not support the optional resource type and profile represented by the group.
+The tests will not pass unless at least one profile group passes.
 # Running the Tests
 ## Quick Start
 Inferno's simulated US Core endpoints require authentication using the OAuth flows
-conforming to one of the following:
-- SMART [App Launch flow](https://hl7.org/fhir/smart-app-launch/STU2.2/app-launch.html), or
-- UDAP [Consumer-Facing flow](https://hl7.org/fhir/us/udap-security/STU1/consumer.html).
+conforming the SMART [App Launch flow](https://hl7.org/fhir/smart-app-launch/STU2.2/app-launch.html).
 When creating a test session, select the Client Security Type corresponding to an
 authentication approach supported by the client. Then, start by running the "Client Registration"
 group which will guide you through the registration process, including what inputs to provide.
 See the *Auth Configuration Details* section below for details.
-Once registration is complete, run the "Read & Search" group to have Inferno wait for US Core
-read and search requests from the client, return the requested US Core
-resources to the client, and verify the interactions. The Patient that the client
+Once registration is complete, run the "Read & Search" group to activate Inferno's
+simulated US Core server, allowing it to wait for US Core read and search requests
+from the client and return the requested US Core resources. The Patient that the client
 needs to request data for has the following demographic details:
-- **Resource ID**: us-core-client-tests-patient
+- **Resource ID**: `us-core-client-tests-patient`
 - **Name**: ClientTests USCore
-- **Member Identifier**: us-core-client-tests-patient (system: Inferno)
+- **Member Identifier**: `us-core-client-tests-patient` (system: `urn:inferno:mrn`)
 - **Date of Birth**: 1940-03-29
 - **Gender**: male
+While waiting, Inferno will display a "User Action Needed" dialog with the above details and
+more. Once the client has made all the requests, click the link in that dialog to have
+Inferno evaluate the requests made.
 ## Demonstration
 To try out these tests without an actual US Core client implementation, you may run them against
@@ -192,40 +146,32 @@ the US Core Server tests using the following steps:
    may fail.
 4. Select the "US Core FHIR API" group from the list at the left, click the "RUN ALL TESTS" button
    in the upper right, and then click "SUBMIT" at the bottom of the input dialog that appears.
-   These tests will run for a while and may result in test failures around must support and
-   conformance features.
+   These tests will run for a while. Most groups will skip due to incomplete coverage of must support
+   elements in the client test's data set.
 5. Once the server tests have completed, return to the client test session and click the link
    in the "User Action Required" dialog to continue the tests and evaluate the client's
-   interactions. These tests will also run for a while and may result in some failures.
+   interactions. These tests will also run for a while and may result in some failures or skips.
 # Input Details
 ## Auth Configuration Details
-When running these tests there are 4 options for authentication, which also allows
+When running these tests there are 3 options for SMART authentication, which also allows
 Inferno to identify which session the requests are for. The choice is made when the
 session is created with the selected Client Security Type option, which determines
-what details the tester needs to provide during the Client Registration tests:
-- **SMART App Launch Client**: the system under test will manually register
-  with Inferno and request access tokens to use when accessing FHIR endpoints
-  as per the SMART App Luanch specification, which includes providing one or more
-  redirect URI(s) in the **SMART App Launch Redirect URI(s)** input, and optionally,
-  launch URL(s) in the **SMART App Launch URL(s)** input. Additionally, testers may provide
-  a **Client Id** if they want their client assigned a specific one. Depending on the
-  specific SMART flavor chosen, additional inputs for authentication may be needed:
-  - **SMART App Launch Public Client**: no additional authentication inputs
-  - **SMART App Launch Confidential Symmetric Client**: provide a secret using the
-    **SMART Confidential Symmetric Client Secret** input.
-  - **SMART App Launch Confidential Asymmetric Client**: provide a URL that resolves
-    to a JWKS or a raw JWKS in JSON format using the **SMART JSON Web Key Set (JWKS)** input.
-- **UDAP Authorization Code Client**: the system under test will dynamically register
-  with Inferno and request access tokens used to access FHIR endpoints
-  as per the UDAP specification. It requires the **UDAP Client URI** input
-  to be populated with the URI that the client will use when dynamically
-  registering with Inferno. This will be used to generate a client id (each
-  unique UDAP Client URI will always get the same client id). All other details
-  that Inferno needs will be provided as a part of the dynamic registration.
+what details the tester needs to provide during manual SMART registration with Inferno.
+In all cases, testers will provide:
+- One or more redirect URI(s) in the **SMART App Launch Redirect URI(s)** input.
+- Zero or more launch URL(s) in the **SMART App Launch URL(s)** input.
+- Optionally, a **Client Id** if they want their client assigned a specific id.
+Depending on the specific SMART flavor chosen, additional inputs for authentication may be needed:
+- **SMART App Launch Public Client**: no additional authentication inputs
+- **SMART App Launch Confidential Symmetric Client**: provide a secret using the
+  **SMART Confidential Symmetric Client Secret** input.
+- **SMART App Launch Confidential Asymmetric Client**: provide a URL that resolves
+  to a JWKS or a raw JWKS in JSON format using the **SMART JSON Web Key Set (JWKS)** input.
 ## Inputs Controlling Token Responses
@@ -244,25 +190,63 @@ to respond with using the following inputs:
   If populated, ensure that the referenced resource is available in Inferno's simulated
   FHIR server so that it can be accessed.
+# Available Instances
+Inferno's simulated US Core server includes the following target instances for the test patient
+* **[US Core Patient Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0)** (id: us-core-client-tests-patient)
+* **[US Core AllergyIntolerance Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance|4.0.0)** (id: us-core-client-tests-allergy-intolerance)
+* **[US Core CarePlan Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan|4.0.0)** (id: us-core-client-tests-care-plan)
+* **[US Core CareTeam Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam|4.0.0)** (id: us-core-client-tests-care-team)
+* **[US Core Condition Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition|4.0.0)** (id: us-core-client-tests-condition-encounter-diagnosis)
+* **[US Core Implantable Device Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device|4.0.0)** (id: us-core-client-tests-device)
+* **[US Core DiagnosticReport Profile for Laboratory Results Reporting](http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|4.0.0)** (id: us-core-client-tests-diagnostic-report-lab)
+* **[US Core DiagnosticReport Profile for Report and Note exchange](http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note|4.0.0)** (id: us-core-client-tests-diagnostic-report-note)
+* **[US Core DocumentReference Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|4.0.0)** (id: us-core-client-tests-document-reference)
+* **[US Core Encounter Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|4.0.0)** (id: us-core-client-tests-encounter)
+* **[US Core Goal Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal|4.0.0)** (id: us-core-client-tests-goal)
+* **[US Core Immunization Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|4.0.0)** (id: us-core-client-tests-immunization)
+* **[US Core MedicationRequest Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|4.0.0)** (id: us-core-client-tests-medication-request)
+* **[US Core Laboratory Result Observation Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab|4.0.0)** (id: us-core-client-tests-observation-lab)
+* **[US Core Blood Pressure Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure|4.0.0)** (id: us-core-client-tests-blood-pressure)
+* **[US Core BMI Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi|4.0.0)** (id: us-core-client-tests-bmi)
+* **[US Core Head Circumference Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference|4.0.0)** (id: us-core-client-tests-head-circumference-percentile)
+* **[US Core Body Height Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height|4.0.0)** (id: us-core-client-tests-body-height)
+* **[US Core Body Weight Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight|4.0.0)** (id: us-core-client-tests-body-weight)
+* **[US Core Body Temperature Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature|4.0.0)** (id: us-core-client-tests-body-temperature)
+* **[US Core Heart Rate Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate|4.0.0)** (id: us-core-client-tests-heart-rate)
+* **[US Core Pediatric BMI for Age Observation Profile](http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age|4.0.0)** (id: us-core-client-tests-pediatric-bmi-for-age)
+* **[US Core Pediatric Head Occipital-frontal Circumference Percentile Profile](http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile|4.0.0)** (id: us-core-client-tests-head-circumference-percentile)
+* **[US Core Pediatric Weight for Height Observation Profile](http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height|4.0.0)** (id: us-core-client-tests-pediatric-weight-for-height)
+* **[US Core Pulse Oximetry Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry|4.0.0)** (id: us-core-client-tests-pulse-oximetry)
+* **[US Core Respiratory Rate Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate|4.0.0)** (id: us-core-client-tests-respiratory-rate)
+* **[US Core Smoking Status Observation Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus|4.0.0)** (id: us-core-client-tests-smokingstatus)
+* **[US Core Organization Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|4.0.0)** (id: us-core-client-tests-organization)
+* **[US Core Practitioner Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|4.0.0)** (id: us-core-client-tests-practitioner)
+* **[US Core Procedure Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|4.0.0)** (id: us-core-client-tests-procedure)
+* **[US Core Provenance Profile](http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance|4.0.0)** (id: us-core-client-tests-provenance)
 # Current Limitations
 This test suite is still in draft form and does not test all of the client requirements and features
 described in the US Core Implementation guide.
-The current version of this test suite supports:
+The current version of this test suite supports the following tests using a specific Inferno-specified patient:
 - Testing a client's ability to perform read requests against a FHIR server for all US Core Profiles
-summarized in the US Core Capability Statement.
-- Testing a client's ability to perform searches using the SHALL conformance search parameters
-summarized in the US Core Capability Statement.
+  listed in the [US Core Client CapabilityStatement](http://hl7.org/fhir/us/core/STU4/CapabilityStatement-us-core-client.html).
+- Testing a client's ability to perform searches using search parameters and combinations
+  listed for each resource type in the [US Core Client CapabilityStatement](http://hl7.org/fhir/us/core/STU4/CapabilityStatement-us-core-client.html).
-The current version of this test suite does not support:
-- Testing searches with/via:
+The current version of this test suite does not:
+- Support esting searches with/via:
   - date comparator
   - multiple-OR
   - _revInclude
-  - The client SHALL provide values precise to the day for elements of datatype date and to the second + time offset for elements of datatype dateTime.
-- The Must Support Conformance Requirements for clients/requestors specified in US Core IG v4.0.0
-- Clients that cannot follow the SMART App Launch or UDAP Consumer-Facing OAuth flows to obtain an access token.
+- Verify that date and dateTime search parameter values are provided at the required level of precision.
+- Check the Must Support Conformance Requirements for clients/requestors specified in US Core IG v4.0.0
+- Support clients that cannot follow the SMART App Launch OAuth flow to obtain an access token.
+- Allow testers to bring their own data. Testers must manually configure their client system to connect
+  to a specific target patient and must access and process specific curated sample US Core data.
         )
@@ -282,6 +266,10 @@ The current version of this test suite does not support:
             type: 'download',
             label: 'Download',
             url: 'https://github.com/inferno-framework/us-core-test-kit/releases/'
+          },
+          {
+            label: 'Implementation Guide',
+            url: 'http://hl7.org/fhir/us/core/STU4'
           }
         ]
@@ -299,17 +287,10 @@ The current version of this test suite does not support:
                         {
                           label: 'SMART App Launch Confidential Asymmetric Client',
                           value: USCoreClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC
-                        },
-                        {
-                          label: 'UDAP Authorization Code Client',
-                          value: USCoreClientOptions::UDAP_AUTHORIZATION_CODE
                         }
                       ]
         route(:get, METADATA_PATH, USCoreTestKit::Client::MetadataHelper.get_metadata('v400'))
-        route(:get, UDAPSecurityTestKit::UDAP_DISCOVERY_PATH, lambda { |_env|
-          UDAPSecurityTestKit::MockUDAPServer.udap_server_metadata(id)
-        })
         route(:get, SMARTAppLaunch::SMART_DISCOVERY_PATH, lambda { |_env|
           SMARTAppLaunch::MockSMARTServer.smart_server_metadata(id)
         })
@@ -320,11 +301,9 @@ The current version of this test suite does not support:
           ->(_env) { [200, { 'Content-Type' => 'application/json' }, [SMARTAppLaunch::OIDCJWKS.jwks_json]] }
         )
-        suite_endpoint :post, UDAPSecurityTestKit::REGISTRATION_PATH,
-                        UDAPSecurityTestKit::MockUDAPServer::RegistrationEndpoint
-        suite_endpoint :post, UDAPSecurityTestKit::TOKEN_PATH, MockUdapSmartServer::TokenEndpoint
-        suite_endpoint :get,  UDAPSecurityTestKit::AUTHORIZATION_PATH, MockUdapSmartServer::AuthorizationEndpoint
-        suite_endpoint :post, UDAPSecurityTestKit::AUTHORIZATION_PATH, MockUdapSmartServer::AuthorizationEndpoint
+        suite_endpoint :post, SMARTAppLaunch::TOKEN_PATH, SMARTAppLaunch::MockSMARTServer::TokenEndpoint
+        suite_endpoint :get,  SMARTAppLaunch::AUTHORIZATION_PATH, SMARTAppLaunch::MockSMARTServer::AuthorizationEndpoint
+        suite_endpoint :post, SMARTAppLaunch::AUTHORIZATION_PATH, SMARTAppLaunch::MockSMARTServer::AuthorizationEndpoint
         suite_endpoint :post, SEARCH_POST_ROUTE, SearchEndpoint
         suite_endpoint :get, SEARCH_ROUTE, SearchEndpoint
@@ -339,27 +318,15 @@ The current version of this test suite does not support:
         group do
           id :us_core_client_read_search_group_v400
           title 'Read & Search'
+          description %(
+During these tests, the US Core client system will interact with Inferno's simulated US Core Server
+and demonstrate its ability to perform the FHIR interactions described in the [US Core Client CapabilityStatement](http://hl7.org/fhir/us/core/STU4/CapabilityStatement-us-core-client.html).
-          run_as_group
-          group from: :us_core_client_wait_group_v400
-          group from: :us_core_client_v400_auth_smart_alca,
-              required_suite_options: {
-                client_type: USCoreClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_ASYMMETRIC
-              }
-          group from: :us_core_client_v400_auth_smart_alcs,
-                required_suite_options: {
-                  client_type: USCoreClientOptions::SMART_APP_LAUNCH_CONFIDENTIAL_SYMMETRIC
-                }
-          group from: :us_core_client_v400_auth_smart_alp,
-                required_suite_options: {
-                  client_type: USCoreClientOptions::SMART_APP_LAUNCH_PUBLIC
-                }
-          group from: :us_core_client_v400_auth_udap,
-                required_suite_options: {
-                  client_type: USCoreClientOptions::UDAP_AUTHORIZATION_CODE
-                }
+          )
+          group from: :us_core_client_access_group_v400
           group from: :us_core_client_v400_patient
           group from: :us_core_client_v400_allergy_intolerance
@@ -370,6 +337,7 @@ The current version of this test suite does not support:
           group from: :us_core_client_v400_diagnostic_report_lab
           group from: :us_core_client_v400_diagnostic_report_note
           group from: :us_core_client_v400_document_reference
+          group from: :us_core_client_v400_encounter
           group from: :us_core_client_v400_goal
           group from: :us_core_client_v400_immunization
           group from: :us_core_client_v400_medication_request
@@ -387,11 +355,20 @@ The current version of this test suite does not support:
           group from: :us_core_client_v400_pulse_oximetry
           group from: :us_core_client_v400_respiratory_rate
           group from: :us_core_client_v400_smokingstatus
-          group from: :us_core_client_v400_procedure
-          group from: :us_core_client_v400_encounter
           group from: :us_core_client_v400_organization
           group from: :us_core_client_v400_practitioner
+          group from: :us_core_client_v400_procedure
           group from: :us_core_client_v400_provenance
+          run do
+            passing_profile_group = groups.find do |group|
+              next if group.id.include?('wait') || group.id.include?('auth')
+              results[group.id]&.result == 'pass'
+            end
+            assert passing_profile_group.present?, 'At least one profile group must pass.'
+          end
         end
       end
     end