TestPlan
The test plan for a FHIR IG or implementation: scenarios, dependencies, test data, expectations. The quality governance layer.
Purpose
TestPlan structures the test plan applicable to a FHIR project: functional scenarios, data sets, dependencies, acceptance criteria. It complements TestScript (executable test cases) by formalising what must be tested before go-live and who signs off the results. A key tool of HL7 connectathons and ONC certification.
Key elements
| Field | Type | Cardinality | Role |
|---|---|---|---|
url | uri | 0..1 | Canonical URL. |
identifier | Identifier[] | 0..* | External identifiers. |
status | code | 1..1 | `draft`, `active`, `retired`, `unknown`. |
category | CodeableConcept[] | 0..* | Category (functional, performance, security). |
scope | Reference(Any)[] | 0..* | Scope. |
testCase | BackboneElement[] | 0..* | Test cases (scenarios, dependencies, data). |
dependency | BackboneElement[] | 0..* | External dependencies. |
exitCriteria | markdown | 0..1 | Exit acceptance criteria. |
JSON example
{
"resourceType": "TestPlan",
"id": "example-testplan-ig-fr",
"url": "https://ans.gouv.fr/fhir/TestPlan/ig-fr-core-2026",
"version": "1.0.0",
"name": "TestPlanFRCoreCore2026",
"title": "Plan de tests IG FR Core 2026",
"status": "active",
"date": "2026-05-15",
"category": [{
"coding": [{
"system": "http://hl7.org/fhir/CodeSystem/testscript-scope",
"code": "conformance"
}]
}],
"testCase": [{
"sequence": 1,
"scope": [{
"reference": "StructureDefinition/FRCorePatient"
}],
"assertion": [{
"type": [{
"coding": [{
"system": "http://hl7.org/fhir/testplan-assertion-type",
"code": "must-support"
}]
}],
"object": [{
"coding": [{
"system": "http://hl7.org/fhir/test-data-type",
"code": "ins-nir"
}]
}]
}]
}]
}Common pitfalls
- TestPlan / TestScript confusion: TestPlan is documentary; TestScript is executable.
- No exitCriteria: no end-of-test measure.
- Test cases without data: non-reproducible.
Related resources
- testscript — executable tests.
- requirements — requirements.
- implementationguide — IG.
- capabilitystatement — server capabilities.