FHIR Standards¶
FHIR Frog implements the HL7 FHIR testing standards. Understanding these resources helps you know what FHIR Frog is executing and producing.
TestScript (R4)¶
A FHIR R4 resource that describes a sequence of operations and assertions to execute against a FHIR server.
Key elements:
| Element | Purpose |
|---|---|
fixture |
Test data resources loaded before execution |
variable |
Named values extracted from responses via FHIRPath |
setup |
Actions run once before tests (create fixtures, extract IDs) |
test |
Named test cases with operations and assertions |
teardown |
Cleanup actions run after tests regardless of outcome |
FHIR Frog executes TestScript JSON natively, and also compiles TSH files to TestScript at runtime.
TestPlan (R5)¶
A FHIR R5 resource that organises multiple TestScripts into a test suite with named test cases and dependency relationships.
Key elements:
| Element | Purpose |
|---|---|
testCase |
Named test case with one or more TestScript references |
testCase.dependency |
Predecessor test cases that must run first |
testCase.testRun |
References to TestScript resources |
FHIR Frog expands TestPlans into JUnit DynamicTest entries in topological order.
TestReport (R4)¶
A FHIR R4 resource produced by FHIR Frog after executing a TestScript. Records the pass/fail outcome of each action.
Key elements:
| Element | Purpose |
|---|---|
result |
Overall outcome: pass, fail, pending |
setup/test/teardown |
Action results mirroring the TestScript structure |
action.assert.result |
Per-assertion outcome |
action.assert.message |
Failure message if assertion failed |
TestReport JSON is storable to the filesystem or a FHIR server, and is readable by standard FHIR tooling.