Package org.fhirfrog.frog.api

package org.fhirfrog.frog.api
FHIR Frog Public API.

This package contains the public API for FHIR Frog, a library for executing FHIR TestScript resources. The API is designed to be simple and minimal, with most implementation details hidden in internal packages.

Core Concepts

FHIR Frog provides several ways to execute FHIR TestScripts:

  • JUnit Extension - Use @FhirTest annotation in JUnit 5 tests
  • CLI - Standalone command-line executable
  • Ant Task - Integration with Ant builds
  • Maven Plugin - Integration with Maven builds

Architecture

The following diagram shows the main components:

FHIR Frog Architecture

Configuration

Tests are configured using FhirTestConfig:


 FhirTestConfig config = FhirTestConfig.builder()
     .serverUrl("http://localhost:8080/fhir")
     .fixtureBasePath(Path.of("fixtures"))
     .build();

Test Results

Execution results are captured in TestResult, which can be rendered to FHIR TestReport resources for reporting and analysis.

See Also: