# TestScript

Canonical page: https://docs.ovok.com/api/fhir/r4/test-script

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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `1..1` | Canonical identifier for this test script, represented as a URI (globally unique) |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..1` | Additional identifier for the test script |
| <span id="element-version"></span>`version` | [string](/fhir-elements/primitive/string) | `0..1` | Business version of the test script |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `1..1` | Name for this test script (computer friendly) |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this test script (human friendly) |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| retired \| unknown |
| <span id="element-experimental"></span>`experimental` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | For testing purposes, not real usage |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date last changed |
| <span id="element-publisher"></span>`publisher` | [string](/fhir-elements/primitive/string) | `0..1` | Name of the publisher (organization or individual) |
| <span id="element-contact"></span>`contact` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Contact details for the publisher |
| <span id="element-description"></span>`description` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Natural language description of the test script |
| <span id="element-use-context"></span>`useContext` | [UsageContext](/fhir-elements/complex/usage-context) | `0..*` | The context that the content is intended to support |
| <span id="element-jurisdiction"></span>`jurisdiction` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Intended jurisdiction for test script (if applicable) |
| <span id="element-purpose"></span>`purpose` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Why this test script is defined |
| <span id="element-copyright"></span>`copyright` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Use and/or publishing restrictions |
| <span id="element-origin"></span>`origin` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | An abstract server representing a client or sender in a message exchange |
| <span id="element-destination"></span>`destination` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | An abstract server representing a destination or receiver in a message exchange |
| <span id="element-metadata"></span>`metadata` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Required capability that is assumed to function correctly on the FHIR server being tested |
| <span id="element-fixture"></span>`fixture` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Fixture in the test script - by reference (uri) |
| <span id="element-profile"></span>`profile` | [Reference](/fhir-elements/complex/reference) | `0..*` | Reference of the validation profile |
| <span id="element-variable"></span>`variable` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Placeholder for evaluated elements |
| <span id="element-setup"></span>`setup` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | A series of required setup operations before tests are executed |
| <span id="element-test"></span>`test` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | A test in this script |
| <span id="element-teardown"></span>`teardown` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | A series of required clean up steps |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [TestScript](https://hl7.org/fhir/R4/testscript.html).  
Maturity: Trial Use 2 (FMM 2).
