test scripts
Create Test Script
post
/organizations/{organizationId}/fhir/3/TestScript
A structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | TestScript | This is a TestScript resource |
| url | string | An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this test script is (or will be) published. The URL SHOULD include the major version of the test script. For more information see [Technical and Business Versions](resource.html#versions). | |
| identifier | Identifier | 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. | |
| version | string | 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. | |
| name | string | 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. | |
| title | string | A short, descriptive, user-friendly title for the test script. | |
| status | string | draft|active|retired|unknown | The status of this test script. Enables tracking the life-cycle of the content. |
| experimental | boolean | 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. | |
| date | string | The date (and optionally time) when the test script was published. The date must change if and 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. | |
| publisher | string | The name of the individual or organization that published the test script. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| description | string | A free text natural language description of the test script from a consumer's perspective. | |
| useContext | array(UsageContext) | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate test script instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the test script is intended to be used. | |
| purpose | string | Explaination of why this test script is needed and why it has been designed as it has. | |
| copyright | string | 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. | |
| origin | array(TestScript_Origin) | An abstract server used in operations within this test script in the origin element. | |
| destination | array(TestScript_Destination) | An abstract server used in operations within this test script in the destination element. | |
| metadata | TestScript_Metadata | The required capability must exist and are assumed to function correctly on the FHIR server being tested. | |
| fixture | array(TestScript_Fixture) | Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. | |
| profile | array(Reference) | Reference to the profile to be used for validation. | |
| variable | array(TestScript_Variable) | Variable is set based either on element value in response body or on header field value in the response headers. | |
| rule | array(TestScript_Rule) | Assert rule to be used in one or more asserts within the test script. | |
| ruleset | array(TestScript_Ruleset) | Contains one or more rules. Offers a way to group rules so assertions could reference the group of rules and have them all applied. | |
| setup | TestScript_Setup | A series of required setup operations before tests are executed. | |
| test | array(TestScript_Test) | A test in this script. | |
| teardown | TestScript_Teardown | A series of operations required to clean up after the all the tests are executed (successfully or otherwise). |
Response
keyboard_arrow_down
Patch Test Script
patch
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}
A structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | TestScript | This is a TestScript resource |
| url | string | An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this test script is (or will be) published. The URL SHOULD include the major version of the test script. For more information see [Technical and Business Versions](resource.html#versions). | |
| identifier | Identifier | 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. | |
| version | string | 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. | |
| name | string | 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. | |
| title | string | A short, descriptive, user-friendly title for the test script. | |
| status | string | draft|active|retired|unknown | The status of this test script. Enables tracking the life-cycle of the content. |
| experimental | boolean | 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. | |
| date | string | The date (and optionally time) when the test script was published. The date must change if and 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. | |
| publisher | string | The name of the individual or organization that published the test script. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| description | string | A free text natural language description of the test script from a consumer's perspective. | |
| useContext | array(UsageContext) | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate test script instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the test script is intended to be used. | |
| purpose | string | Explaination of why this test script is needed and why it has been designed as it has. | |
| copyright | string | 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. | |
| origin | array(TestScript_Origin) | An abstract server used in operations within this test script in the origin element. | |
| destination | array(TestScript_Destination) | An abstract server used in operations within this test script in the destination element. | |
| metadata | TestScript_Metadata | The required capability must exist and are assumed to function correctly on the FHIR server being tested. | |
| fixture | array(TestScript_Fixture) | Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. | |
| profile | array(Reference) | Reference to the profile to be used for validation. | |
| variable | array(TestScript_Variable) | Variable is set based either on element value in response body or on header field value in the response headers. | |
| rule | array(TestScript_Rule) | Assert rule to be used in one or more asserts within the test script. | |
| ruleset | array(TestScript_Ruleset) | Contains one or more rules. Offers a way to group rules so assertions could reference the group of rules and have them all applied. | |
| setup | TestScript_Setup | A series of required setup operations before tests are executed. | |
| test | array(TestScript_Test) | A test in this script. | |
| teardown | TestScript_Teardown | A series of operations required to clean up after the all the tests are executed (successfully or otherwise). |
Response
keyboard_arrow_down
Read Test Script
get
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Test Script
get
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Test Script
get
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Test Script
delete
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Test Script
get
/organizations/{organizationId}/fhir/3/TestScript
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| date | string | ||
| description | string | ||
| identifier | string | ||
| jurisdiction | string | ||
| name | string | ||
| publisher | string | ||
| status | string | ||
| testscript-capability | string | ||
| title | string | ||
| url | string | ||
| version | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Test Script
get
/organizations/{organizationId}/fhir/3/TestScript/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Test Script
post
/organizations/{organizationId}/fhir/3/TestScript/_search
A structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| date | string | ||
| description | string | ||
| identifier | string | ||
| jurisdiction | string | ||
| name | string | ||
| publisher | string | ||
| status | string | ||
| testscript-capability | string | ||
| title | string | ||
| url | string | ||
| version | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | TestScript | This is a TestScript resource |
| url | string | An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this test script is (or will be) published. The URL SHOULD include the major version of the test script. For more information see [Technical and Business Versions](resource.html#versions). | |
| identifier | Identifier | 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. | |
| version | string | 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. | |
| name | string | 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. | |
| title | string | A short, descriptive, user-friendly title for the test script. | |
| status | string | draft|active|retired|unknown | The status of this test script. Enables tracking the life-cycle of the content. |
| experimental | boolean | 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. | |
| date | string | The date (and optionally time) when the test script was published. The date must change if and 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. | |
| publisher | string | The name of the individual or organization that published the test script. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| description | string | A free text natural language description of the test script from a consumer's perspective. | |
| useContext | array(UsageContext) | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate test script instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the test script is intended to be used. | |
| purpose | string | Explaination of why this test script is needed and why it has been designed as it has. | |
| copyright | string | 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. | |
| origin | array(TestScript_Origin) | An abstract server used in operations within this test script in the origin element. | |
| destination | array(TestScript_Destination) | An abstract server used in operations within this test script in the destination element. | |
| metadata | TestScript_Metadata | The required capability must exist and are assumed to function correctly on the FHIR server being tested. | |
| fixture | array(TestScript_Fixture) | Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. | |
| profile | array(Reference) | Reference to the profile to be used for validation. | |
| variable | array(TestScript_Variable) | Variable is set based either on element value in response body or on header field value in the response headers. | |
| rule | array(TestScript_Rule) | Assert rule to be used in one or more asserts within the test script. | |
| ruleset | array(TestScript_Ruleset) | Contains one or more rules. Offers a way to group rules so assertions could reference the group of rules and have them all applied. | |
| setup | TestScript_Setup | A series of required setup operations before tests are executed. | |
| test | array(TestScript_Test) | A test in this script. | |
| teardown | TestScript_Teardown | A series of operations required to clean up after the all the tests are executed (successfully or otherwise). |
Response
keyboard_arrow_down
Update Test Script
put
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}
A structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | TestScript | This is a TestScript resource |
| url | string | An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this test script is (or will be) published. The URL SHOULD include the major version of the test script. For more information see [Technical and Business Versions](resource.html#versions). | |
| identifier | Identifier | 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. | |
| version | string | 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. | |
| name | string | 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. | |
| title | string | A short, descriptive, user-friendly title for the test script. | |
| status | string | draft|active|retired|unknown | The status of this test script. Enables tracking the life-cycle of the content. |
| experimental | boolean | 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. | |
| date | string | The date (and optionally time) when the test script was published. The date must change if and 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. | |
| publisher | string | The name of the individual or organization that published the test script. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| description | string | A free text natural language description of the test script from a consumer's perspective. | |
| useContext | array(UsageContext) | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate test script instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the test script is intended to be used. | |
| purpose | string | Explaination of why this test script is needed and why it has been designed as it has. | |
| copyright | string | 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. | |
| origin | array(TestScript_Origin) | An abstract server used in operations within this test script in the origin element. | |
| destination | array(TestScript_Destination) | An abstract server used in operations within this test script in the destination element. | |
| metadata | TestScript_Metadata | The required capability must exist and are assumed to function correctly on the FHIR server being tested. | |
| fixture | array(TestScript_Fixture) | Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute. | |
| profile | array(Reference) | Reference to the profile to be used for validation. | |
| variable | array(TestScript_Variable) | Variable is set based either on element value in response body or on header field value in the response headers. | |
| rule | array(TestScript_Rule) | Assert rule to be used in one or more asserts within the test script. | |
| ruleset | array(TestScript_Ruleset) | Contains one or more rules. Offers a way to group rules so assertions could reference the group of rules and have them all applied. | |
| setup | TestScript_Setup | A series of required setup operations before tests are executed. | |
| test | array(TestScript_Test) | A test in this script. | |
| teardown | TestScript_Teardown | A series of operations required to clean up after the all the tests are executed (successfully or otherwise). |
Response
keyboard_arrow_down