Skip to content

Commit 1a958fa

Browse files
authored
Various minor docs improvements. (#608)
1 parent ed36384 commit 1a958fa

File tree

8 files changed

+43
-37
lines changed

8 files changed

+43
-37
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# ONC Certification (g)(10) Standardized API Test Kit
22

33
The **ONC Certification (g)(10) Standardized API Test Kit** is a testing tool
4-
for Health IT systems seeking to meet the requirements of the ONC [Standardized
4+
for Health IT systems seeking to meet the requirements of the [Standardized
55
API for Patient and Population Services criterion §
66
170.315(g)(10)](https://www.healthit.gov/test-method/standardized-api-patient-and-population-services)
7-
in the ONC Certification Program.
7+
in the ONC Health IT Certification Program.
88

99
The **(g)(10) Standardized API Test Kit** behaves like an API consumer, making a
1010
series of HTTP requests that mimic a real world client to ensure that the API
@@ -16,24 +16,28 @@ supports an approved version of each of the required standards:
1616
v2.0.0, or v2.2.0)
1717
* HL7 FHIR Bulk Data Access (Flat FHIR) (v1.0.1, or v2.0.0)
1818

19-
Please note that US Core Implementation Guide v.7.0.0 should only be used
19+
_Please note that US Core Implementation Guide v.7.0.0 should only be used
2020
with SMART Application Launch Guide v2.0.0 or above due to granular scope
21-
support requirements.
21+
support requirements._
2222

2323
This test kit is [open source](#license) and freely available for use or
2424
adoption by the health IT community including EHR vendors, health app
2525
developers, and testing labs. It is an approved test method for the §
26-
170.315(g)(10) certification criterion in the EHR Certification program by the
27-
Office of the National Coordinator for Health IT (ONC).
26+
170.315(g)(10) certification criterion in the ONC Health IT Certification
27+
program by the Assistant Secretary for Technology Policy (ASTP).
2828

29-
The (g)(10) Standarized API Test Kit is built using the [Inferno
29+
The (g)(10) Standardized API Test Kit is built using the [Inferno
3030
Framework](https://inferno-framework.github.io/). The Inferno Framework is
3131
designed for reuse and aims to make it easier to build test kits for any
3232
FHIR-based data exchange.
3333

34+
Visit the [(g)(10) Standardized API Test Kit
35+
Documentation](http://github.com/onc-healthit/onc-certification-g10-test-kit/wiki)
36+
for information on using and contributing to this test kit.
37+
3438
## Getting Started
3539

36-
ONC hosts a [public
40+
ASTP hosts a [public
3741
instance](https://inferno.healthit.gov/suites/g10_certification) of this test
3842
kit that developers and testers are welcome to use. However, users are
3943
encouraged to download and run this tool locally to allow testing within private
@@ -42,7 +46,7 @@ Please see the [Local Installation
4246
Instructions](#local-installation-instructions) section below for more
4347
information.
4448

45-
ONC hosts a [(g)(10) reference
49+
ASTP also hosts a [(g)(10) reference
4650
server](https://inferno.healthit.gov/reference-server/) that can be used to
4751
orient new users on these tests. The [(g)(10) Standardized API Test Kit
4852
Walkthrough](https://github.com/onc-healthit/onc-certification-g10-test-kit/wiki/Walkthrough)

docs/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@ The **ONC Certification (g)(10) Standardized API Test Kit** is a testing tool
22
for Health IT systems seeking to meet the requirements of the ONC [Standardized
33
API for Patient and Population Services criterion §
44
170.315(g)(10)](https://www.healthit.gov/test-method/standardized-api-patient-and-population-services)
5-
in the ONC Certification Program. The following documentation provides information
5+
in the ONC Health IT Certification Program. The following documentation provides information
66
on how to use and contribute to this test kit.
77

88
## Using this Test Kit
99

1010
* [Getting Started](https://github.com/onc-healthit/onc-certification-g10-test-kit/?tab=readme-ov-file#getting-started): Installation instructions for this test kit.
11-
* [Test Kit Walkthrough](Walkthrough): A step-by-step guide to using this test kit.
11+
* [Test Kit Walkthrough](Walkthrough.md): A step-by-step guide to using this test kit.
1212
* [Testing FAQ](FAQ.md): Frequently asked questions about the tests in this test kit.
13-
* [IE Browser](IE-Browser): A guide to using this test kit with legacy/unsupported versions of Internet Explorer.
13+
* [IE Browser](IE-Browser.md): A guide to using this test kit with legacy/unsupported versions of Internet Explorer.
1414

15-
## Updating this Test Kit
15+
## Contributing to this Test Kit
1616

1717
Developers contributing to this test kit should be familiar with [authoring
1818
Inferno Framework test suites](https://inferno-framework.github.io/docs/writing-tests/). The following guides provide additional
1919
information about the design and implementation of this test kit to aid
2020
contributing to these tests:
2121

22-
* [Technical Overview](Technical-Overview): A guide to the architecture of this test kit.
23-
* [Standards Update Guide](SVAP-Update-Guide): How to update this test kit when new versions of standards are approved.
24-
* [Terminology Update Guide](Terminology-Update-Guide): How to update terminology used in this test kit.
25-
* [Unusual Implementation Details](Unusual-Implementation-Details): Gotchas and special cases to be aware of when updating this test kit.
22+
* [Technical Overview](Technical-Overview.md): A guide to the architecture of this test kit.
23+
* [SVAP Update Guide](SVAP-Update-Guide.md): How to update this test kit when new versions of standards are approved.
24+
* [Terminology Update Guide](Terminology-Update-Guide.md): How to update terminology used in this test kit.
25+
* [Unusual Implementation Details](Unusual-Implementation-Details.md): Gotchas and special cases to be aware of when updating this test kit.
2626

2727
## Reference Documents
2828
* [Test Procedure Matrix](https://github.com/onc-healthit/onc-certification-g10-test-kit/raw/refs/heads/main/onc_certification_g10_matrix.xlsx): A matrix of test procedures and their associated test cases.

docs/Technical-Overview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ and is intended to serve multiple purposes:
66
effective transfer of this software to new stewards.
77

88
This document does not provide detailed instructions on how to use
9-
an Inferno Test Kit, the contents of the (g)(10) Certification Criteria,
9+
an Inferno test kit, the contents of the (g)(10) Certification Criteria,
1010
basics of the Inferno Framework, or details on how to use Ruby, Docker,
1111
or other tools. Developers are expected to have at least a basic understanding
1212
of all these topics. Please refer to the References section of this document
1313
for links to more information about these topics.
1414

1515
Please note that the focus of this document are on features that are specific to
16-
this Test Kit and does not provide a detailed explanation of common Inferno
16+
this test kit and does not provide a detailed explanation of common Inferno
1717
Framework functionality.
1818

1919
## Test Design Principles and features
@@ -30,7 +30,7 @@ Tests for this test kit have been designed with the following principles:
3030
configuration, and tests should complete in a reasonable amount of time.
3131
* Limit extraneous constraints: The tests should not place additional constraints
3232
on the system under test.
33-
* Reuse existing tests when possible: Reuse tests from Test Kits that target
33+
* Reuse existing tests when possible: Reuse tests from test kits that target
3434
implementation guides that are required within this test kit.
3535

3636
The design of the tests within this test kit reflect these principles
@@ -56,7 +56,7 @@ The (g)(10) Test Kit manages this complexity through standard software design
5656
practices and approaches, leveraging the functionality provided by the Ruby
5757
programming language. And while this code is intended to be accessible to
5858
developers new to the Ruby language, developers are expected to learn the basics
59-
of Ruby development before attempting to alter these tests. This Test Kit also
59+
of Ruby development before attempting to alter these tests. This test kit also
6060
uses RSpec to "unit test" components of these tests, and developers are expected
6161
to learn the basics of RSpec as well.
6262

@@ -67,16 +67,16 @@ FHIR Implementation Guides, while providing guidance on how to support these
6767
test kits to accomplish the specific requirements of the certification
6868
criterion. In order to facilitate testing systems independently of the (g)(10)
6969
Certification requirements, each of these Implementation Guides also has a
70-
stand-alone Test Kit. The (g)(10) Test Kit then imports tests defined in these
71-
Test Kits and integrates them into a single cohesive test procedure, while also
70+
stand-alone test kit. The (g)(10) Test Kit then imports tests defined in these
71+
test kits and integrates them into a single cohesive test procedure, while also
7272
further constraining their implementation to meet any (g)(10)-specific
7373
requirements.
7474

7575
*Please note that the Multi-Patient API tests do not currently reuse
7676
the SMART Bulk Data Test Kit. A future version of this test kit
7777
may reuse the SMART Bulk Data Test Kit.*
7878

79-
The specific Test Kits that are imported into this Test Kit include:
79+
The specific test kits that are imported into this test kit include:
8080

8181
1. **[US Core Test Kit](https://github.com/inferno-framework/us-core-test-kit)**:
8282
Data access within the Single Patient API tests in this Test Kit are
@@ -104,7 +104,7 @@ libraries. It is organized into several main directories:
104104
The (g)(10) Test Kit contains a single suite of tests, which is capable of testing
105105
any valid combination of approved standards for certification. This suite
106106
is defined in `lib/onc_certification_g10_test_kit.rb` and imports all necessary
107-
tests from both external Test Kits and from within the (g)(10) Test Kit itself.
107+
tests from both external test kits and from within the (g)(10) Test Kit itself.
108108

109109
## Testing Code Changes
110110

@@ -128,7 +128,7 @@ likely to change.
128128

129129
### End-to-End testing
130130

131-
Besides the unit tests provided within this Test Kit, after each update
131+
Besides the unit tests provided within this test kit, after each update
132132
the tests should be validated against a complete server implementation
133133
that is known to be correct. The Inferno Reference Server provides this functionality,
134134
and contains data that passes all of these tests. Note that if test changes

docs/Terminology-Update-Guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ the version of UMLS should be updated approximately yearly to incorporate any
4444
new valid codes that may have been introduced. These two updates are typically done together,
4545
and the following instructions assume this is the case. During this process,
4646
metadata about the CodeSystems and ValueSets (e.g. number of codes in each) is
47-
also updated and stored within the Test Kit. This enables the (g)(10) Test Kit
47+
also updated and stored within the test kit. This enables the (g)(10) Test Kit
4848
to provide a warning to users if they need to rerun the terminology update
4949
process.
5050

docs/Unusual-Implementation-Details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
While code in this Test Kit is intended to be as simple and as
2+
While code in this test kit is intended to be as simple and as
33
easy-to-understand as possible, sometimes unanticipated testing requirements are
44
introduced that require special handling. The ability for Inferno to
55
accommodate these requirements is a key feature of the Inferno framework.

docs/Walkthrough.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ criterion](https://www.healthit.gov/test-method/standardized-api-patient-and-pop
77
of the [21st Century Cures Act: Interoperability, Information Blocking, and the
88
ONC Health IT Certification
99
Program](https://www.govinfo.gov/content/pkg/FR-2019-03-04/pdf/2019-02224.pdf).
10-
It uses the [ONC-hosted
10+
It uses the [ASTP-hosted
1111
instance](https://inferno.healthit.gov/suites/g10_certification) of the (g)(10)
1212
Standardized API Test Kit to test against a [publicly available reference
1313
server](https://inferno.healthit.gov/reference-server) that mimics a (g)(10)
1414
conformant API.
1515

1616
At the end of this walkthrough, you will be able to use the **Inferno ONC
1717
Certification (g)(10) Standardized API Test Kit** to evaluate APIs for
18-
conformance to the ONC (g)(10) certification criteria. If you are interested in
18+
conformance to the ONC (g)(10) certification criterion. If you are interested in
1919
how to use the Inferno Framework to test other FHIR-based data exchanges that
20-
fall outside the scope of ONC (g)(10) certification criteria, please visit the
20+
fall outside the scope of ONC (g)(10) certification criterion, please visit the
2121
[Inferno Framework](https://inferno-framework.github.io) for more information.
2222

2323
* [Step 1: Create a new (g)(10) Test Session](#step-1-create-a-new-inferno-g10-test-session-and-select-standard-versions)
@@ -40,7 +40,7 @@ fall outside the scope of ONC (g)(10) certification criteria, please visit the
4040
* Go to <https://inferno.healthit.gov>.
4141
* Select 'ONC (g)(10) Standardized Test Kit' under 'ONC Health Certification
4242
Program', which is an instance of Inferno configured to specifically test
43-
the requirements of the criteria in the ONC Health IT Certification Program.
43+
the requirements of the criterion in the ONC Health IT Certification Program.
4444

4545
![step-01-landing](images/step-01-landing.png)
4646

@@ -83,7 +83,7 @@ pane, or click 'Standalone Patient App' in the menu on the left.
8383

8484
## Step 3: Perform Standalone Patient App Tests
8585

86-
Inferno's tests for the ONC certification criteria are organized into seven steps.
86+
Inferno's tests for the ONC certification criterion are organized into seven steps.
8787
This allows the tester to walk through the requirements in an order similar to
8888
what would be done in a real-world situation, while limiting redundant testing.
8989

docs/_Footer.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1-
_Test Kit documentation is stored within the `/docs` folder of this git repository
2-
and is automatically copied to the wiki with each update to the `main` branch.
3-
Do not change content within the wiki directly as changes will be overwritten._
1+
_Test kit documentation is stored within the [./docs](../tree/main/docs) folder of
2+
this repository and is automatically synchronized to this wiki with each update
3+
to the `main` branch using the [Publish Docs Wiki
4+
workflow](../actions/workflows/publish-docs-wiki.yml). Do not change content
5+
within this wiki directly as changes will be overwritten._

docs/_Sidebar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- [Testing FAQ](FAQ)
77
- [IE Browser Notes](IE-Browser)
88

9-
**Updating this Test Kit**
9+
**Contributing to this Test Kit**
1010
- [Technical Overview](Technical-Overview)
1111
- [Standards Update Guide](SVAP-Update-Guide)
1212
- [Terminology Update Guide](Terminology-Update-Guide)

0 commit comments

Comments
 (0)