Merge pull request #2 from inferno-framework/rm-ci

readme and rm ci

Author: rpassas

.gitlab-ci.yml

@@ -1,27 +1,62 @@
-# Inferno Template Test Kit
+# Central Cancer Registry Reporting      
+      
+The Central Cancer Registry Reporting (CCRR) Test Kit is a testing tool for Health IT systems
+seeking to meet the requirements of the STU 1.0.0 version of the HL7® FHIR®
+[Central Cancer Registry Reporting IG](https://hl7.org/fhir/us/central-cancer-registry-reporting/STU1/).
 
-Inferno template [Inferno](https://github.com/inferno-community/inferno-core) Test Kit
-for FHIR testing.
 
-## Inferno Developers Notes
-The generator is not capable of bringing the test kit to its current state.  It is used to generate tests that are then organized manually.
+This test kit currently contains suites that verify the conformance of systems playing the following roles:
+- **Health Data Exchange App (HDEA) Report Generator**: Verifies that the Health IT system can generate
+  conformant and complete reports to send to a cancer registry.
+- **Electronic Health Record (EHR) Data Source**: Verifies that the Health IT system can respond to queries
+  for the data needed to create a cancer registry report.
 
-## Instructions for Developing Your Test Kit
+## Status
 
-Refer to the Inferno documentation for information about [setting up
-your development environment and running your Test Kit](https://inferno-framework.github.io/docs/getting-started/).
+These tests are a **DRAFT** intended to allow CCRR IG implementers to
+perform preliminary checks of their implementations against the IG's requirements and provide feedback
+on the tests. Future versions of these tests may validate other requirements and may change how these
+are tested.
 
-More information about what is included in this repository can be [found here](https://inferno-framework.github.io/docs/getting-started/repo-layout-and-organization.html).
+## Known Limitations
 
-## Documentation
+This test kit does not currently include test suites for all actors and all capabilities defined by the CCRR IG.
+Out of scope areas of the IG include the Cancer Registry and Trusted Third Party actors and details related to the use of the
+[MedMorph framework](https://hl7.org/fhir/us/medmorph/STU1/) by all actors to coordinate reporting triggering,
+report content, and report delivery requirements.
+
+The existing HDEA and EHR suites focus on report content and do not currently test most details of
+the report exchange workflow. The following areas are not tested:
+- EHR requirements around authentication and authorization and the use of Subscriptions to provide
+  notifications to HDEAs.
+- HDEA requirements around the gathering of report contents from EHRs and the delivery of completed reports
+  using FHIR APIs.
+
+For additional details on suite-specific limitations, see the suite documention in the running tests or the
+corresponding content in the source repository ([EHR suite limitations](https://github.com/inferno-framework/cancer-registry-reporting-test-kit/blob/main/lib/cancer_registry_reporting_test_kit/docs/ehr_suite_description.md#current-limitations),
+[HDEA suite limitations](https://github.com/inferno-framework/cancer-registry-reporting-test-kit/blob/main/lib/cancer_registry_reporting_test_kit/docs/hdea_suite_description.md#current-limitations))
+
+## Repository and Resources
+
+The Central Cancer Registry Reporting Test Kit can be [downloaded](https://github.com/inferno-framework/cancer-registry-reporting-test-kit/releases)
+from its [GitHub repository](https://github.com/inferno-framework/cancer-registry-reporting-test-kit).
+
+## Providing Feedback and Reporting Issues
+
+We welcome feedback on the tests, including but not limited to the following areas:
+- Validation logic, such as potential bugs, lax checks, and unexpected failures.
+- Requirements coverage, such as requirements that have been missed, tests that necessitate features that the
+  IG does not require, or other issues with the interpretation of the IG’s requirements.
+- User experience, such as confusing or missing information in the test UI.
+
+Please report any issues with this set of tests in the [issues section](https://github.com/inferno-framework/cancer-registry-reporting-test-kit/issues)
+      of the repository.
+
+## Inferno Documentation
 - [Inferno documentation](https://inferno-framework.github.io/docs/)
 - [Ruby API documentation](https://inferno-framework.github.io/inferno-core/docs/)
 - [JSON API documentation](https://inferno-framework.github.io/inferno-core/api-docs/)
 
-## Example Inferno Test Kits
-
-A list of all Test Kits registered with the Inferno Team can be found on the [Test Kit Registry](https://inferno-framework.github.io/community/test-kits.html) page.
-
 ## License
 Copyright 2024 TODO
 

README.md

@@ -3,7 +3,7 @@
 module CancerRegistryReportingTestKit
   class Metadata < Inferno::TestKit
     id :cancer_registry_reporting_test_kit
-    title 'Central Cancer Registry Reporting IG Test Kit'
+    title 'Central Cancer Registry Reporting Test Kit'
     description <<~DESCRIPTION
 
       The Central Cancer Registry Reporting (CCRR) Test Kit is a testing tool for Health IT systems