FHIR Testing IG
0.1.0-SNAPSHOT - Draft International flag

FHIR Testing IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 0.1.0-SNAPSHOT built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-testing-ig/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

TestPlanContext-quantitySearchParam

A quantity- or range-valued use context assigned to the test script

TestPlanContext-type-quantitySearchParam

A use context type and quantity- or range-based value assigned to the test script

TestPlanContext-type-valueSearchParam

A use context type and value assigned to the test script

TestPlanContext-typeSearchParam

A type of use context assigned to the test script

TestPlanContextSearchParam

A use context assigned to the test script

TestPlanDateSearchParam

The test script publication date

TestPlanDependencySearchParam

URL contained in TestPlan.dependency.reference

TestPlanDescriptionSearchParam

The description of the test script

TestPlanExperimentalSearchParam

Whether the TestPlan is experimental

TestPlanIdentifierSearchParam

An identifier for the test plan

TestPlanJurisdictionSearchParam

Intended jurisdiction for the test script

TestPlanNameSearchParam

Computationally friendly name of the test script

TestPlanPublisherSearchParam

Name of the publisher of the test script

TestPlanRunnerSearchParam

Reference to the runner for the test case

TestPlanScopeSearchParam

URL contained in TestPlan.scope.reference

TestPlanStatusSearchParam

The current status of the test plan

TestPlanTitleSearchParam

The human-friendly name of the test script

TestPlanUrlSearchParam

The uri that identifies the test plan

TestPlanVersionSearchParam

The business version of the test script

TestReportIdentifierSearchParam

An external identifier for the test report

TestReportIssuedSearchParam

The test report generation date

TestReportParticipantSearchParam

The reference to a participant in the test execution

TestReportResultSearchParam

The result disposition of the test execution

TestReportStatusSearchParam

The current status of the test report

TestReportTesterSearchParam

The name of the testing organization

TestReportTestscriptSearchParam

The test script executed to produce this report

TestScriptArtifactSearchParam

The artifact under test

TestScriptConformanceSearchParam

The artifact conformance testing expectation

TestScriptContext-quantitySearchParam

A quantity- or range-valued use context assigned to the test script

TestScriptContext-type-quantitySearchParam

A use context type and quantity- or range-based value assigned to the test script

TestScriptContext-type-valueSearchParam

A use context type and value assigned to the test script

TestScriptContext-typeSearchParam

A type of use context assigned to the test script

TestScriptContextSearchParam

A use context assigned to the test script

TestScriptDateSearchParam

The test script publication date

TestScriptDescriptionSearchParam

The description of the test script

TestScriptExperimentalSearchParam

Whether the TestScript is experimental

TestScriptIdentifierSearchParam

External identifier for the test script

TestScriptJurisdictionSearchParam

Intended jurisdiction for the test script

TestScriptNameSearchParam

Computationally friendly name of the test script

TestScriptPhaseSearchParam

The artifact phase of testing

TestScriptPublisherSearchParam

Name of the publisher of the test script

TestScriptScope-artifact-conformanceSearchParam

The artifact under test and conformance testing expectation

TestScriptScope-artifact-phaseSearchParam

The artifact under test and phase of testing

TestScriptStatusSearchParam

The current status of the test script

TestScriptTestscript-capabilitySearchParam

TestScript required and validated capability

TestScriptTitleSearchParam

The human-friendly name of the test script

TestScriptUrlSearchParam

The uri that identifies the test script

TestScriptVersionSearchParam

The business version of the test script

Structures: Additional Resources

'Additional' resources that are not yet published in the FHIR core specification.

Test Plan

A plan for executing testing on an artifact or specifications

Test Report

A summary of information based on the results of executing a TestScript.

Test Script

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Shareable Test Script

Enforces the minimum information set for the test script metadata required by HL7 and other organizations that share and publish test scripts

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Assertion Direction Type Value Set

The type of direction to use for assertion.

Assertion Manual Completion Type Value Set

The type of manual completion to use for assertion.

Assertion Operator Type Value Set

The type of operator to use for assertion.

Assertion Response Types Value Set

The type of response code to use for assertion.

Inventory Count Type Value Set

The type of count.

Test Plan Assertion Type ValueSet

The TestPlan test case assertion type.

Test Plan Script Language Value Set

The TestPlan test run script language.

Test Plan Status Value Set

The status of the TestPlan.

Test Report Action Result Value Set

The results of executing an action.

Test Report Participant Type Value Set

The type of participant.

Test Report Result Value Set

The reported execution result.

Test Report Status Value Set

The current status of the test report.

Test Script Operation Code Value Set

This value set defines a set of codes that are used to indicate the supported operations of a testing engine or tool.

Test Script Request Method Code Value Set

The allowable request method or HTTP operation codes.

Test Script Scope Conformance Type Value Set

The expectation of whether the test must pass for the system to be considered conformant with the artifact.

Test Script Scope Phase Type Value Set

The phase of testing for this artifact.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Assertion Direction Type

The type of direction to use for assertion.

Assertion Manual Completion Type

The type of manual completion to use for assertion.

Assertion Operator Type

The type of operator to use for assertion.

Assertion Response Types

The type of response code to use for assertion.

Inventory Count Type

The type of count.

Test Plan Assertion Type

The TestPlan test case assertion type.

Test Plan Script Language

The TestPlan test run script language.

Test Plan Status

The status of the TestPlan.

Test Report Action Result

The results of executing an action.

Test Report Participant Type

The type of participant.

Test Report Result

The reported execution result.

Test Report Status

The current status of the test report.

Test Script Request Method Code

The allowable request method or HTTP operation codes.

Test Script Scope Conformance Type

The expectation of whether the test must pass for the system to be considered conformant with the artifact.

Test Script Scope Phase Type

The phase of testing for this artifact.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

TestReport/testreport-example
Example Test Plan

This test plan describes a manual test that a given observation can be read from the server using POSTMan. The user is instructed in the documentation to perform a POSTMan get with the $id in the URL and the Accept header, and compare with the expected output.

Multisystem Test Script

TestScript example resource showing use of origin and destination for multisystem support. The single origin will execute a Patient read against the two destination systems using user defined dynamic variables. The test engine will wait at each operation action with a defined origin and destination for the origin test system to send the expected FHIR operation to the destination test system. Once the expected request and response is observed, the test engine will continue with the test execution.

Terminology Connectathon #1 Test Script

This is the test script the 1st Terminology Services Connectathon

Terminology Ecosystem Test Plan

This is a subset of the full terminology ecosystem tests

TestScript Example

TestScript example resource with setup to delete if present and create a new instance of a Patient; and single test definition to read the created Patient with various asserts.

TestScript Example Effective Period Test

TestScript example resource the demonstrates the use of the artifact-effectivePeriod extenstion. There is a single test for a Patient read operation. The effective period range represents the period of use for the FHIR R4 v4.0.1 specification starting from its release date on Oct 30, 2019 with no expiration.

TestScript Example History

TestScript example resource with setup to delete if present and create a new instance of a Patient then update that Patient to create a minimum history; and single test definition to get the history of that Patient with various asserts.

TestScript Example Read Common

TestScript example resource showing the use of the common element to reuse actions within the test element. Each test will perform a Patient read operation utilizing user defined dynamic variables that will hold the Patient resource id values.

TestScript Example Read Test

TestScript example resource with ported Sprinkler basic read tests R001, R002, R003, R004. The read tests will utilize user defined dynamic variables that will hold the Patient resource id values.

TestScript Example Search

TestScript example resource with simple Patient search test. The read tests will utilize user defined dynamic variables that will hold the Patient search parameter values.

TestScript Example Update

TestScript example resource with setup to delete if present and create a new instance of a Patient; and single test definition to update that Patient with various asserts.