test reports

Create Test Report

post

/organizations/{organizationId}/fhir/4/TestReport

A summary of information based on the results of executing a TestScript.

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 TestReport 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).
identifier	Identifier		Identifier for the TestScript assigned for external purposes outside the context of FHIR.
name	string		A free text natural language name identifying the executed TestScript.
status		completed\|in-progress\|waiting\|stopped\|entered-in-error	The current state of this test report.
testScript*	Reference		Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.
result		pass\|fail\|pending	The overall result from the execution of the TestScript.
score	decimal		The final score (percentage of tests passed) resulting from the execution of the TestScript.
tester	string		Name of the tester producing this report (Organization or individual).
issued	dateTime		When the TestScript was executed and this TestReport was generated.
participant	array(TestReport_Participant)		A participant in the test execution, either the execution engine, a client, or a server.
setup	TestReport_Setup		The results of the series of required setup operations before the tests were executed.
test	array(TestReport_Test)		A test executed from the test script.
teardown	TestReport_Teardown		The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).

Response

200 400 401 404

Patch Test Report

patch

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

A summary of information based on the results of executing a TestScript.

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*			This is a TestReport 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).
identifier	Identifier		Identifier for the TestScript assigned for external purposes outside the context of FHIR.
name	string		A free text natural language name identifying the executed TestScript.
status		completed\|in-progress\|waiting\|stopped\|entered-in-error	The current state of this test report.
testScript*	Reference		Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.
result		pass\|fail\|pending	The overall result from the execution of the TestScript.
score	decimal		The final score (percentage of tests passed) resulting from the execution of the TestScript.
tester	string		Name of the tester producing this report (Organization or individual).
issued	dateTime		When the TestScript was executed and this TestReport was generated.
participant	array(TestReport_Participant)		A participant in the test execution, either the execution engine, a client, or a server.
setup	TestReport_Setup		The results of the series of required setup operations before the tests were executed.
test	array(TestReport_Test)		A test executed from the test script.
teardown	TestReport_Teardown		The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).

Response

200 400 401 404 409

Read Test Report

get

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

Request

Headers


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

get

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

Request

Headers


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

get

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

Request

Headers


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

delete

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

Request

Headers


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

get

/organizations/{organizationId}/fhir/4/TestReport

Request

Headers


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

Query params


_id	string
_language	string
identifier	string
issued	string
participant	string
result	string
tester	string
testscript	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Test Report

get

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

Request

Headers


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

post

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

A summary of information based on the results of executing a TestScript.

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
identifier	string
issued	string
participant	string
result	string
tester	string
testscript	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a TestReport 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).
identifier	Identifier		Identifier for the TestScript assigned for external purposes outside the context of FHIR.
name	string		A free text natural language name identifying the executed TestScript.
status		completed\|in-progress\|waiting\|stopped\|entered-in-error	The current state of this test report.
testScript*	Reference		Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.
result		pass\|fail\|pending	The overall result from the execution of the TestScript.
score	decimal		The final score (percentage of tests passed) resulting from the execution of the TestScript.
tester	string		Name of the tester producing this report (Organization or individual).
issued	dateTime		When the TestScript was executed and this TestReport was generated.
participant	array(TestReport_Participant)		A participant in the test execution, either the execution engine, a client, or a server.
setup	TestReport_Setup		The results of the series of required setup operations before the tests were executed.
test	array(TestReport_Test)		A test executed from the test script.
teardown	TestReport_Teardown		The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).

Response

200 401 404

Update Test Report

put

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

A summary of information based on the results of executing a TestScript.

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 TestReport 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).
identifier	Identifier		Identifier for the TestScript assigned for external purposes outside the context of FHIR.
name	string		A free text natural language name identifying the executed TestScript.
status		completed\|in-progress\|waiting\|stopped\|entered-in-error	The current state of this test report.
testScript*	Reference		Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.
result		pass\|fail\|pending	The overall result from the execution of the TestScript.
score	decimal		The final score (percentage of tests passed) resulting from the execution of the TestScript.
tester	string		Name of the tester producing this report (Organization or individual).
issued	dateTime		When the TestScript was executed and this TestReport was generated.
participant	array(TestReport_Participant)		A participant in the test execution, either the execution engine, a client, or a server.
setup	TestReport_Setup		The results of the series of required setup operations before the tests were executed.
test	array(TestReport_Test)		A test executed from the test script.
teardown	TestReport_Teardown		The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).

Response

200 400 401 404 409