TestScript

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

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

Interaction	Method	Path
Read	GET	/fhir/R4/TestScript/[id]
Vread	GET	/fhir/R4/TestScript/[id]/_history/[vid]
Update	PUT	/fhir/R4/TestScript/[id]
Patch	PATCH	/fhir/R4/TestScript/[id]
Delete	DELETE	/fhir/R4/TestScript/[id]
Create	POST	/fhir/R4/TestScript
Search	GET	/fhir/R4/TestScript
History	GET	/fhir/R4/TestScript/[id]/_history

Top-level elements

Element	Type	Cardinality	Description
id	string	0..1	Logical id of this artifact
meta	Meta	0..1	Metadata about the resource
implicitRules	uri	0..1	A set of rules under which this content was created
language	code	0..1	Language of the resource content
text	Narrative	0..1	Text summary of the resource, for human interpretation
contained	Resource	0..*	Contained, inline Resources
extension	Extension	0..*	Additional content defined by implementations
modifierExtension	Extension	0..*	Extensions that cannot be ignored
url	uri	1..1	Canonical identifier for this test script, represented as a URI (globally unique)
identifier	Identifier	0..1	Additional identifier for the test script
version	string	0..1	Business version of the test script
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 | active | retired | unknown
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 (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
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
fixture	BackboneElement	0..*	Fixture in the test script - by reference (uri)
profile	Reference	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 test script
context-quantity	quantity	A quantity- or range-valued use context assigned to the test script
context-type	token	A type of use context assigned to the test script
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the test script
context-type-value	composite	A use context type and value assigned to the test script
date	date	The test script publication date
description	string	The description of the test script
identifier	token	External identifier for the test script
jurisdiction	token	Intended jurisdiction for the test script
name	string	Computationally friendly name of the test script
publisher	string	Name of the publisher of the test script
status	token	The current status of the test script
testscript-capability	string	TestScript required and validated capability
title	string	The human-friendly name of the test script
url	uri	The uri that identifies the test script
version	token	The business version of the test script

Reference

Official FHIR R4 spec: TestScript.
Maturity: Trial Use 2 (FMM 2).