test scripts

Create Test Script

post

/organizations/{organizationId}/fhir/4/TestScript

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a TestScript resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		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.
implicitRules	uri		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.
language	code		The base language in which the resource is written.
text	Narrative		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.
contained	array(ResourceList)		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.
extension	array(Extension)		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.
modifierExtension	array(Extension)		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).
url	uri		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.
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		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	dateTime		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.
publisher	string		The name of the organization or individual that published the test script.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
description	markdown		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 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.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the test script is intended to be used.
purpose	markdown		Explanation of why this test script is needed and why it has been designed as it has.
copyright	markdown		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.
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 all the tests are executed (successfully or otherwise).

Response

200 400 401 404

Patch Test Script

patch

/organizations/{organizationId}/fhir/4/TestScript/{resourceId}

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Request

Headers

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a TestScript resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		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.
implicitRules	uri		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.
language	code		The base language in which the resource is written.
text	Narrative		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.
contained	array(ResourceList)		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.
extension	array(Extension)		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.
modifierExtension	array(Extension)		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).
url	uri		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.
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		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	dateTime		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.
publisher	string		The name of the organization or individual that published the test script.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
description	markdown		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 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.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the test script is intended to be used.
purpose	markdown		Explanation of why this test script is needed and why it has been designed as it has.
copyright	markdown		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.
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 all the tests are executed (successfully or otherwise).

Response

200 400 401 404 409

Read Test Script

get

/organizations/{organizationId}/fhir/4/TestScript/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Test Script

get

/organizations/{organizationId}/fhir/4/TestScript/{resourceId}/_history

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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

200 401 404

Read Version Test Script

get

/organizations/{organizationId}/fhir/4/TestScript/{resourceId}/_history/{versionId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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

200 400 401 404

Remove Test Script

delete

/organizations/{organizationId}/fhir/4/TestScript/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404 409

Search Get Test Script

get

/organizations/{organizationId}/fhir/4/TestScript

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
context	string
context-quantity	string
context-type	string
context-type-quantity	string
context-type-value	string
date
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

200 401 404

Search History Test Script

get

/organizations/{organizationId}/fhir/4/TestScript/_history

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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

200 401 404

Search Post Test Script

post

/organizations/{organizationId}/fhir/4/TestScript/_search

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml\|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
context	string
context-quantity	string
context-type	string
context-type-quantity	string
context-type-value	string
date
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*			This is a TestScript resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		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.
implicitRules	uri		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.
language	code		The base language in which the resource is written.
text	Narrative		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.
contained	array(ResourceList)		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.
extension	array(Extension)		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.
modifierExtension	array(Extension)		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).
url	uri		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.
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		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	dateTime		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.
publisher	string		The name of the organization or individual that published the test script.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
description	markdown		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 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.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the test script is intended to be used.
purpose	markdown		Explanation of why this test script is needed and why it has been designed as it has.
copyright	markdown		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.
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 all the tests are executed (successfully or otherwise).

Response

200 401 404

Update Test Script

put

/organizations/{organizationId}/fhir/4/TestScript/{resourceId}

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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*			This is a TestScript resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		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.
implicitRules	uri		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.
language	code		The base language in which the resource is written.
text	Narrative		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.
contained	array(ResourceList)		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.
extension	array(Extension)		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.
modifierExtension	array(Extension)		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).
url	uri		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.
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		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	dateTime		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.
publisher	string		The name of the organization or individual that published the test script.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
description	markdown		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 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.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the test script is intended to be used.
purpose	markdown		Explanation of why this test script is needed and why it has been designed as it has.
copyright	markdown		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.
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 all the tests are executed (successfully or otherwise).

Response

200 400 401 404 409