TestScript - FHIR Resource (dstu2)
This TestScript Resource uses the FHIR API standard for access and structure.
Validate an TestScript FHIR Resource (dstu2)
TestScript Attributes
AttributeField is listTypeDescription
Description: Reference of the validation profile
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"profile": Learn more about the (TestScript) profile FHIR attribute
Description: draft | active | retired
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (TestScript) status FHIR attribute
Description: Scope and Usage this Test Script is for
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requirements": Learn more about the (TestScript) requirements FHIR attribute
Description: Natural language description of the TestScript
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (TestScript) description FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (TestScript) copyright FHIR attribute
Description: Name of the publisher (Organization or individual)
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (TestScript) publisher FHIR attribute
Description: A series of required clean up steps
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"teardown": Learn more about the (TestScript) teardown FHIR attribute
Description: A series of required setup operations before tests are executed
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"setup": Learn more about the (TestScript) setup FHIR attribute
Description: Contact details of the publisher
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (TestScript) contact FHIR attribute
Description: Fixture in the test script - by reference (uri)
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"fixture": Learn more about the (TestScript) fixture FHIR attribute
Description: Whether or not the tests apply to more than one FHIR server
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"multiserver": Learn more about the (TestScript) multiserver FHIR attribute
Description: Informal name for this TestScript
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (TestScript) name FHIR attribute
Description: A test in this script
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"test": Learn more about the (TestScript) test FHIR attribute
Description: Logical id for this version of the TestScript
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (TestScript) version FHIR attribute
Description: Content intends to support these contexts
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (TestScript) useContext FHIR attribute
Description: Absolute URL used to reference this TestScript
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (TestScript) url FHIR attribute
Description: Placeholder for evaluated elements
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"variable": Learn more about the (TestScript) variable FHIR attribute
Description: Date for this version of the TestScript
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (TestScript) date FHIR attribute
Description: External identifier
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (TestScript) identifier FHIR attribute
Description: If for testing purposes, not real usage
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (TestScript) experimental FHIR attribute
Description: Required capability that is assumed to function correctly on the FHIR server being tested
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"metadata": Learn more about the (TestScript) metadata FHIR attribute
TestScript Structure
{
"resourceType" : "TestScript",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Absolute URL used to reference this TestScript
"version" : "<string>", // Logical id for this version of the TestScript
"name" : "<string>", // R! Informal name for this TestScript
"status" : "<code>", // R! draft | active | retired
"identifier" : { Identifier }, // External identifier
"experimental" : <boolean>, // If for testing purposes, not real usage
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"name" : "<string>", // Name of a individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"date" : "<dateTime>", // Date for this version of the TestScript
"description" : "<string>", // Natural language description of the TestScript
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"requirements" : "<string>", // Scope and Usage this Test Script is for
"copyright" : "<string>", // Use and/or publishing restrictions
"metadata" : { // Required capability that is assumed to function correctly on the FHIR server being tested
"link" : [{ // Links to the FHIR specification
"url" : "<uri>", // R! URL to the specification
"description" : "<string>" // Short description
}],
"capability" : [{ // R! Capabilities that are assumed to function correctly on the FHIR server being tested
"required" : <boolean>, // Are the capabilities required?
"validated" : <boolean>, // Are the capabilities validated?
"description" : "<string>", // The expected capabilities of the server
"destination" : <integer>, // Which server these requirements apply to
"link" : ["<uri>"], // Links to the FHIR specification
"conformance" : { Reference(Conformance) } // R! Required Conformance
}]
},
"multiserver" : <boolean>, // Whether or not the tests apply to more than one FHIR server
"fixture" : [{ // Fixture in the test script - by reference (uri)
"autocreate" : <boolean>, // Whether or not to implicitly create the fixture during setup
"autodelete" : <boolean>, // Whether or not to implicitly delete the fixture during teardown
"resource" : { Reference(Any) } // Reference of the resource
}],
"profile" : [{ Reference(Any) }], // Reference of the validation profile
"variable" : [{ // Placeholder for evaluated elements
"name" : "<string>", // R! Descriptive name for this variable
"headerField" : "<string>", // HTTP header field name for source
"path" : "<string>", // XPath or JSONPath against the fixture body
"sourceId" : "<id>" // Fixture Id of source expression or headerField within this variable
}],
"setup" : { // A series of required setup operations before tests are executed
"metadata" : { Content as for TestScript.metadata }, // Capabilities that are assumed to function correctly on the FHIR server being tested
"action" : [{ // R! A setup operation or assert to perform
"operation" : { // The setup operation to perform
"type" : { Coding }, // The setup operation type that will be executed
"resource" : "<code>", // Resource type
"label" : "<string>", // Tracking/logging operation label
"description" : "<string>", // Tracking/reporting operation description
"accept" : "<code>", // xml | json
"contentType" : "<code>", // xml | json
"destination" : <integer>, // Which server to perform the operation on
"encodeRequestUrl" : <boolean>, // Whether or not to send the request url in encoded format
"params" : "<string>", // Explicitly defined path parameters
"requestHeader" : [{ // Each operation can have one ore more header elements
"field" : "<string>", // R! HTTP header field name
"value" : "<string>" // R! HTTP headerfield value
}],
"responseId" : "<id>", // Fixture Id of mapped response
"sourceId" : "<id>", // Fixture Id of body for PUT and POST requests
"targetId" : "<id>", // Id of fixture used for extracting the [id], [type], and [vid] for GET requests
"url" : "<string>" // Request URL
},
"assert" : { // The assertion to perform
"label" : "<string>", // Tracking/logging assertion label
"description" : "<string>", // Tracking/reporting assertion description
"direction" : "<code>", // response | request
"compareToSourceId" : "<string>", // Id of fixture used to compare the "sourceId/path" evaluations to
"compareToSourcePath" : "<string>", // XPath or JSONPath expression against fixture used to compare the "sourceId/path" evaluations to
"contentType" : "<code>", // xml | json
"headerField" : "<string>", // HTTP header field name
"minimumId" : "<string>", // Fixture Id of minimum content resource
"navigationLinks" : <boolean>, // Perform validation on navigation links?
"operator" : "<code>", // equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains
"path" : "<string>", // XPath or JSONPath expression
"resource" : "<code>", // Resource type
"response" : "<code>", // okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable
"responseCode" : "<string>", // HTTP response code to test
"sourceId" : "<id>", // Fixture Id of source expression or headerField
"validateProfileId" : "<id>", // Profile Id of validation profile reference
"value" : "<string>", // The value to compare to
"warningOnly" : <boolean> // Will this assert produce a warning only on error?
}
}]
},
"test" : [{ // A test in this script
"name" : "<string>", // Tracking/logging name of this test
"description" : "<string>", // Tracking/reporting short description of the test
"metadata" : { Content as for TestScript.metadata }, // Capabilities that are expected to function correctly on the FHIR server being tested
"action" : [{ // R! A test operation or assert to perform
"operation" : { Content as for TestScript.setup.action.operation }, // The setup operation to perform
"assert" : { Content as for TestScript.setup.action.assert } // The setup assertion to perform
}]
}],
"teardown" : { // A series of required clean up steps
"action" : [{ // R! One or more teardown operations to perform
"operation" : { Content as for TestScript.setup.action.operation } // The teardown operation to perform
}]
}
}
TestScript Search Parameters
The following search parameters can be used to query TestScript resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/TestScript?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
description | text | description |
identifier | text | identifier |
name | text | name |
testscript-capability | text | metadata.capability.description |
testscript-setup-capability | text | setup.metadata.capability.description |
testscript-test-capability | text | test.metadata.capability.description |
url | uri | url |
