TestScript

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification. If the element is present, it must have either a @value, an @id, or extensions

type TestScript implements Resource {
  url: Uri
  identifier: Identifier
  version: String
  name: String
  title: String
  status: String
  experimental: Boolean
  date: Date
  publisher: String
  contact: [ContactDetail]
  description: String
  useContext: [UsageContext]
  jurisdiction: [CodeableConcept]
  purpose: String
  copyright: String
  origin: [TestScriptOrigin]
  destination: [TestScriptDestination]
  metadata: TestScriptMetadata
  fixture: [TestScriptFixture]
  profile: [Reference]
  variable: [TestScriptVariable]
  setup: TestScriptSetup
  test: [TestScriptTest]
  teardown: TestScriptTeardown
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields

TestScript.url ● Uri scalar

An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.

TestScript.identifier ● Identifier object

A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.

TestScript.version ● String scalar

The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

TestScript.name ● String scalar

A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.

TestScript.title ● String scalar

A short, descriptive, user-friendly title for the test script.

TestScript.status ● String scalar

The status of this test script. Enables tracking the life-cycle of the content.

TestScript.experimental ● Boolean scalar

A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

TestScript.date ● Date scalar

The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.

TestScript.publisher ● String scalar

The name of the organization or individual that published the test script.

TestScript.contact ● [ContactDetail] list object

Contact details to assist a user in finding and communicating with the publisher.

TestScript.description ● String scalar

A free text natural language description of the test script from a consumer s perspective.

TestScript.useContext ● [UsageContext] list object

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.

TestScript.jurisdiction ● [CodeableConcept] list object

A legal or geographic region in which the test script is intended to be used.

TestScript.purpose ● String scalar

Explanation of why this test script is needed and why it has been designed as it has.

TestScript.copyright ● String scalar

A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.

TestScript.origin ● [TestScriptOrigin] list object

An abstract server used in operations within this test script in the origin element.

TestScript.destination ● [TestScriptDestination] list object

An abstract server used in operations within this test script in the destination element.

TestScript.metadata ● TestScriptMetadata object

The required capability must exist and are assumed to function correctly on the FHIR server being tested.

TestScript.fixture ● [TestScriptFixture] list object

Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

TestScript.profile ● [Reference] list object

Reference to the profile to be used for validation.

TestScript.variable ● [TestScriptVariable] list object

Variable is set based either on element value in response body or on header field value in the response headers.

TestScript.setup ● TestScriptSetup object

A series of required setup operations before tests are executed.

TestScript.test ● [TestScriptTest] list object

A test in this script.

TestScript.teardown ● TestScriptTeardown object

A series of operations required to clean up after all the tests are executed (successfully or otherwise).

TestScript.text ● Narrative object

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

TestScript.contained ● [Resource] list interface

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

TestScript.extension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

TestScript.modifierExtension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

TestScript.id ● String scalar

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

TestScript.meta ● Meta object

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

TestScript.implicitRules ● Uri scalar

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

TestScript.language ● String scalar

The base language in which the resource is written.

Interfaces

Resource interface

This is the base resource type for everything.

Returned By

TestScript query ● TestScriptCreate mutation ● TestScriptList query ● TestScriptUpdate mutation