https://github.com/inferno-framework/ipa-test-kit
International Patient Access (IPA) Inferno Test Kit
https://github.com/inferno-framework/ipa-test-kit
Last synced: 8 months ago
JSON representation
International Patient Access (IPA) Inferno Test Kit
- Host: GitHub
- URL: https://github.com/inferno-framework/ipa-test-kit
- Owner: inferno-framework
- License: apache-2.0
- Created: 2021-12-10T19:59:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-22T17:23:38.000Z (11 months ago)
- Last Synced: 2025-10-07T21:33:31.499Z (8 months ago)
- Language: Ruby
- Size: 2.56 MB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inferno International Patient Access (IPA) Test Kit
The Inferno International Patient Access Test Kit provides an
executable set of tests for the [International Patient Access (IPA)
Implementation Guide](https://build.fhir.org/ig/HL7/fhir-ipa/). This test kit
is designed and maintained by the Inferno team to support the development of the
IPA IG and improve the core Inferno Framework.
This test kit includes a preliminary test suite based on the [Inferno US
Core](https://github.com/inferno-framework/us-core-test-kit) test suite.
The [Office of the National Coordinator for Health IT
(ONC)](https://healthit.gov) provides a running instance of these tests that can
be accessed at https://inferno.healthit.gov/suites/ipa_v100
## Local Installation Instructions (Docker required)
- Install [Docker](https://www.docker.com)
- Clone this repository
- Run `setup.sh` in this repo to pull the needed docker images and set up the
database.
- Run `run.sh` to build and run the Inferno environment
- Navigate to `http://localhost` to access the Inferno IPA Test Suite
## Maintaining this Test Kit
The tests within this Test Kit are created using a generator that parses
the implementation guide provided in `./lib/ipa_test_kit/igs` and writes
Inferno DSL tests to `./lib/ipa_test_kit/generated`. Resource instances
are validated using the HL7 FHIR Validator, and will use the tx.fhir.org
terminology service to validate terminology by default.
To update this test kit to a new version of the IG:
1. Add the .tgz file in `./lib/ipa_test_kit/igs` with the new version
of the IG package. This IG will be used by the HL7 FHIR Validator to
validate resource instances when Inferno is started.
2. Run the generator to generate a new version-specific copy of the IPA suite.
After installing Ruby, run the following:
```sh
bundle install
bundle exec rake ipa:generate
```
3. Tell Inferno to load the new version of the test suite by
adding a new line to `./lib/ipa_test_kit.rb`, similar to
the existing lines. For example:
```ruby
require_relative 'ipa_test_kit/generated/v2.0.0/ipa_test_suite'
```
While the tests should be stable, the generator is still under development and
will likely need to be updated if there is any major structural changes to how
the implementation guide represents constraints. For example, if the
implementation guide alters its strategy for conveying Must Support
requirements, the generator will need to be updated.
The generator is located in `./lib/ipa_test_kit/generator`, and is a fork of the
US Core generator after being altered based on differing requirements. Updates include:
- Inclusion of a full set of search parameters from the FHIR specification, as
IPA does not provide a copy of them like US Core does.
- Altered method for validating Provenance records, as there is no requirement
for supporting Provenance READ interaction.
## TODOS
* Support `client-confidential-asymmetric`.
* Verify that the server supports all required SMART capabilities, rather than
just verifying that the server advertises support for them.
* Test `$docref` operation.
* Test `Patient.link` requirements.
* Verify that the server requires both a code and system for Patient identifier
search.
## License
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
```md
http://www.apache.org/licenses/LICENSE-2.0
```
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
## Trademark Notice
HL7, FHIR and the FHIR [FLAME DESIGN] are the registered trademarks of Health
Level Seven International and their use does not constitute endorsement by HL7.