test reports

Create Test Report

post
/organizations/{organizationId}/fhir/3/TestReport

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

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringTestReportThis is a TestReport resource
identifierIdentifierIdentifier for the TestScript assigned for external purposes outside the context of FHIR.
namestringA free text natural language name identifying the executed TestScript.
statusstringcompleted|in-progress|waiting|stopped|entered-in-errorThe current state of this test report.
testScript*ReferenceIdeally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.
resultstringpass|fail|pendingThe overall result from the execution of the TestScript.
scorenumberThe final score (percentage of tests passed) resulting from the execution of the TestScript.
testerstringName of the tester producing this report (Organization or individual).
issuedstringWhen the TestScript was executed and this TestReport was generated.
participantarray(TestReport_Participant)A participant in the test execution, either the execution engine, a client, or a server.
setupTestReport_SetupThe results of the series of required setup operations before the tests were executed.
testarray(TestReport_Test)A test executed from the test script.
teardownTestReport_TeardownThe results of the series of operations required to clean up after the all the tests were executed (successfully or otherwise).

Response

Patch Test Report

patch
/organizations/{organizationId}/fhir/3/TestReport/{resourceId}

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

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*stringTestReportThis is a TestReport resource
identifierIdentifierIdentifier for the TestScript assigned for external purposes outside the context of FHIR.
namestringA free text natural language name identifying the executed TestScript.
statusstringcompleted|in-progress|waiting|stopped|entered-in-errorThe current state of this test report.
testScript*ReferenceIdeally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.
resultstringpass|fail|pendingThe overall result from the execution of the TestScript.
scorenumberThe final score (percentage of tests passed) resulting from the execution of the TestScript.
testerstringName of the tester producing this report (Organization or individual).
issuedstringWhen the TestScript was executed and this TestReport was generated.
participantarray(TestReport_Participant)A participant in the test execution, either the execution engine, a client, or a server.
setupTestReport_SetupThe results of the series of required setup operations before the tests were executed.
testarray(TestReport_Test)A test executed from the test script.
teardownTestReport_TeardownThe results of the series of operations required to clean up after the all the tests were executed (successfully or otherwise).

Response

Read Test Report

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Test Report

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

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Test Report

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Test Report

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Test Report

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

Request

Headers

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

Query params

_idstring
_languagestring
identifierstring
issuedstring
participantstring
resultstring
testerstring
testscriptstring

Params

organizationId*string|stringid|slug

Response

Search History Test Report

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

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Test Report

post
/organizations/{organizationId}/fhir/3/TestReport/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
identifierstring
issuedstring
participantstring
resultstring
testerstring
testscriptstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringTestReportThis is a TestReport resource
identifierIdentifierIdentifier for the TestScript assigned for external purposes outside the context of FHIR.
namestringA free text natural language name identifying the executed TestScript.
statusstringcompleted|in-progress|waiting|stopped|entered-in-errorThe current state of this test report.
testScript*ReferenceIdeally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.
resultstringpass|fail|pendingThe overall result from the execution of the TestScript.
scorenumberThe final score (percentage of tests passed) resulting from the execution of the TestScript.
testerstringName of the tester producing this report (Organization or individual).
issuedstringWhen the TestScript was executed and this TestReport was generated.
participantarray(TestReport_Participant)A participant in the test execution, either the execution engine, a client, or a server.
setupTestReport_SetupThe results of the series of required setup operations before the tests were executed.
testarray(TestReport_Test)A test executed from the test script.
teardownTestReport_TeardownThe results of the series of operations required to clean up after the all the tests were executed (successfully or otherwise).

Response

Update Test Report

put
/organizations/{organizationId}/fhir/3/TestReport/{resourceId}

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringTestReportThis is a TestReport resource
identifierIdentifierIdentifier for the TestScript assigned for external purposes outside the context of FHIR.
namestringA free text natural language name identifying the executed TestScript.
statusstringcompleted|in-progress|waiting|stopped|entered-in-errorThe current state of this test report.
testScript*ReferenceIdeally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the `TestScript.url`.
resultstringpass|fail|pendingThe overall result from the execution of the TestScript.
scorenumberThe final score (percentage of tests passed) resulting from the execution of the TestScript.
testerstringName of the tester producing this report (Organization or individual).
issuedstringWhen the TestScript was executed and this TestReport was generated.
participantarray(TestReport_Participant)A participant in the test execution, either the execution engine, a client, or a server.
setupTestReport_SetupThe results of the series of required setup operations before the tests were executed.
testarray(TestReport_Test)A test executed from the test script.
teardownTestReport_TeardownThe results of the series of operations required to clean up after the all the tests were executed (successfully or otherwise).

Response