TestScript

Trial Use 4 Specialized — Quality & Testing

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/TestScript

Interaction	Method	Path
Read	GET	/fhir/R5/TestScript/[id]
Vread	GET	/fhir/R5/TestScript/[id]/_history/[vid]
Update	PUT	/fhir/R5/TestScript/[id]
Patch	PATCH	/fhir/R5/TestScript/[id]
Delete	DELETE	/fhir/R5/TestScript/[id]
Create	POST	/fhir/R5/TestScript
Search	GET	/fhir/R5/TestScript?...
History	GET	/fhir/R5/TestScript/[id]/_history
Type-history	GET	/fhir/R5/TestScript/_history

Top-level elements

Element	Type(s)	Cardinality	Description
url	uri	0..1	Canonical identifier for this test script, represented as a URI (globally unique)
identifier	Identifier	0..*	Additional identifier for the test script
version	string	0..1	Business version of the test script
versionAlgorithm[x]	string / Coding	0..1	How to compare versions
name	string	1..1	Name for this test script (computer friendly)
title	string	0..1	Name for this test script (human friendly)
status	code	1..1	draft
experimental	boolean	0..1	For testing purposes, not real usage
date	dateTime	0..1	Date last changed
publisher	string	0..1	Name of the publisher/steward (organization or individual)
contact	ContactDetail	0..*	Contact details for the publisher
description	markdown	0..1	Natural language description of the test script
useContext	UsageContext	0..*	The context that the content is intended to support
jurisdiction	CodeableConcept	0..*	Intended jurisdiction for test script (if applicable)
purpose	markdown	0..1	Why this test script is defined
copyright	markdown	0..1	Use and/or publishing restrictions
copyrightLabel	string	0..1	Copyright holder and year(s)
origin	BackboneElement	0..*	An abstract server representing a client or sender in a message exchange
destination	BackboneElement	0..*	An abstract server representing a destination or receiver in a message exchange
metadata	BackboneElement	0..1	Required capability that is assumed to function correctly on the FHIR server being tested
scope	BackboneElement	0..*	Indication of the artifact(s) that are tested by this test case
fixture	BackboneElement	0..*	Fixture in the test script - by reference (uri)
profile	canonical	0..*	Reference of the validation profile
variable	BackboneElement	0..*	Placeholder for evaluated elements
setup	BackboneElement	0..1	A series of required setup operations before tests are executed
test	BackboneElement	0..*	A test in this script
teardown	BackboneElement	0..1	A series of required clean up steps

Resource-specific search parameters

Parameter	Type	Description
context	token	A use context assigned to the activity definition
context-quantity	quantity	A quantity- or range-valued use context assigned to the activity definition
context-type	token	A type of use context assigned to the activity definition
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the activity definition
context-type-value	composite	A use context type and value assigned to the activity definition
date	date	The activity definition publication date
description	string	The description of the activity definition
identifier	token	External identifier for the activity definition
jurisdiction	token	Intended jurisdiction for the activity definition
name	string	Computationally friendly name of the activity definition
publisher	string	Name of the publisher of the activity definition
scope-artifact	reference	The artifact under test
scope-artifact-conformance	composite	The artifact under test and conformance testing expectation
scope-artifact-phase	composite	The artifact under test and phase of testing
status	token	The current status of the activity definition
testscript-capability	string	TestScript required and validated capability
title	string	The human-friendly name of the activity definition
url	uri	The uri that identifies the activity definition
version	token	The business version of the activity definition

Reference

• Official FHIR R5 spec: TestScript
• Maturity: Trial Use 4 (FMM 4).