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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringTestScriptThis is a TestScript resource
urlstringAn 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).
identifierIdentifierA 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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the test script.
statusstringdraft|active|retired|unknownThe status of this test script. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the test script.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the test script from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the test script is intended to be used.
purposestringExplaination of why this test script is needed and why it has been designed as it has.
copyrightstringA 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.
originarray(TestScript_Origin)An abstract server used in operations within this test script in the origin element.
destinationarray(TestScript_Destination)An abstract server used in operations within this test script in the destination element.
metadataTestScript_MetadataThe required capability must exist and are assumed to function correctly on the FHIR server being tested.
fixturearray(TestScript_Fixture)Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
profilearray(Reference)Reference to the profile to be used for validation.
variablearray(TestScript_Variable)Variable is set based either on element value in response body or on header field value in the response headers.
rulearray(TestScript_Rule)Assert rule to be used in one or more asserts within the test script.
rulesetarray(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.
setupTestScript_SetupA series of required setup operations before tests are executed.
testarray(TestScript_Test)A test in this script.
teardownTestScript_TeardownA series of operations required to clean up after the all the tests are executed (successfully or otherwise).

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringTestScriptThis is a TestScript resource
urlstringAn 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).
identifierIdentifierA 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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the test script.
statusstringdraft|active|retired|unknownThe status of this test script. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the test script.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the test script from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the test script is intended to be used.
purposestringExplaination of why this test script is needed and why it has been designed as it has.
copyrightstringA 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.
originarray(TestScript_Origin)An abstract server used in operations within this test script in the origin element.
destinationarray(TestScript_Destination)An abstract server used in operations within this test script in the destination element.
metadataTestScript_MetadataThe required capability must exist and are assumed to function correctly on the FHIR server being tested.
fixturearray(TestScript_Fixture)Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
profilearray(Reference)Reference to the profile to be used for validation.
variablearray(TestScript_Variable)Variable is set based either on element value in response body or on header field value in the response headers.
rulearray(TestScript_Rule)Assert rule to be used in one or more asserts within the test script.
rulesetarray(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.
setupTestScript_SetupA series of required setup operations before tests are executed.
testarray(TestScript_Test)A test in this script.
teardownTestScript_TeardownA series of operations required to clean up after the all the tests are executed (successfully or otherwise).

Response

Read Test Script

get
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Test Script

get
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Test Script

get
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Test Script

delete
/organizations/{organizationId}/fhir/3/TestScript/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Test Script

get
/organizations/{organizationId}/fhir/3/TestScript

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
descriptionstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
testscript-capabilitystring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Test Script

get
/organizations/{organizationId}/fhir/3/TestScript/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
descriptionstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
testscript-capabilitystring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringTestScriptThis is a TestScript resource
urlstringAn 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).
identifierIdentifierA 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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the test script.
statusstringdraft|active|retired|unknownThe status of this test script. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the test script.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the test script from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the test script is intended to be used.
purposestringExplaination of why this test script is needed and why it has been designed as it has.
copyrightstringA 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.
originarray(TestScript_Origin)An abstract server used in operations within this test script in the origin element.
destinationarray(TestScript_Destination)An abstract server used in operations within this test script in the destination element.
metadataTestScript_MetadataThe required capability must exist and are assumed to function correctly on the FHIR server being tested.
fixturearray(TestScript_Fixture)Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
profilearray(Reference)Reference to the profile to be used for validation.
variablearray(TestScript_Variable)Variable is set based either on element value in response body or on header field value in the response headers.
rulearray(TestScript_Rule)Assert rule to be used in one or more asserts within the test script.
rulesetarray(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.
setupTestScript_SetupA series of required setup operations before tests are executed.
testarray(TestScript_Test)A test in this script.
teardownTestScript_TeardownA series of operations required to clean up after the all the tests are executed (successfully or otherwise).

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringTestScriptThis is a TestScript resource
urlstringAn 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).
identifierIdentifierA 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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the test script.
statusstringdraft|active|retired|unknownThe status of this test script. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the test script.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the test script from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the test script is intended to be used.
purposestringExplaination of why this test script is needed and why it has been designed as it has.
copyrightstringA 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.
originarray(TestScript_Origin)An abstract server used in operations within this test script in the origin element.
destinationarray(TestScript_Destination)An abstract server used in operations within this test script in the destination element.
metadataTestScript_MetadataThe required capability must exist and are assumed to function correctly on the FHIR server being tested.
fixturearray(TestScript_Fixture)Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
profilearray(Reference)Reference to the profile to be used for validation.
variablearray(TestScript_Variable)Variable is set based either on element value in response body or on header field value in the response headers.
rulearray(TestScript_Rule)Assert rule to be used in one or more asserts within the test script.
rulesetarray(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.
setupTestScript_SetupA series of required setup operations before tests are executed.
testarray(TestScript_Test)A test in this script.
teardownTestScript_TeardownA series of operations required to clean up after the all the tests are executed (successfully or otherwise).

Response