FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

7.5 Resource TestReport - Content

FHIR Infrastructure icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: No defined compartments

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

The TestScript resource is used to define tests that can be executed on one or more FHIR servers. The TestReport resource defines how systems should encode the summarized results of executing a TestScript.

The TestReport structure mirrors the TestScript concepts of having sections for setup, tests, and teardown. If present, these ordered lists should mirror the actions (either operations or assertions) of the referenced TestScript with a result code: pass, skip, fail, warning, or error.

Implementers should be familiar with the testing concepts and descriptions found in Testing FHIR before working with this resource.

No references for this Resource.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. TestReport TU DomainResource Describes the results of a TestScript execution

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..1 Identifier External identifier
... name Σ 0..1 string Informal name of the executed TestReport
... status ?!Σ 1..1 code completed | in-progress | waiting | stopped | entered-in-error
Binding: Test Report Status (Required)
... result Σ 1..1 code pass | fail | pending
Binding: Test Report Result (Required)
... score Σ 0..1 decimal The final score (percentage of tests passed, so 0..100) resulting from the execution of the TestScript
... tester Σ 0..1 string Name of the tester producing this report (Organization or individual)
... issued Σ 0..1 dateTime When the TestScript was executed and this TestReport was generated
... participant 0..* BackboneElement A participant in the test execution, either the execution engine, a client, or a server

.... type 1..1 code test-engine | client | server
Binding: Test Report Participant Type (Required)
.... uri 0..1 uri The uri of the participant. An absolute URL is preferred
.... version 0..1 uri The version of the participant, if known/applicable
.... display 0..1 string The display name of the participant
... parameter 0..* BackboneElement A parameter passed to the runner performing the test

.... name 1..1 string Name of the parameter passed in
.... documentation 0..1 markdown Documentation about the impact of the parameter
... setup 0..1 BackboneElement The results of the series of required setup operations before the tests were executed
.... action C 1..* BackboneElement A setup operation or assert that was executed
+ Rule: Setup action SHALL contain either an operation or assert but not both.

..... operation C 0..1 BackboneElement The operation to perform
...... result 1..1 code pass | skip | fail | warning | error
Binding: Test Report Action Result (Required)
...... message 0..1 markdown A message associated with the result
...... detail 0..1 uri A link to further details on the result
..... assert C 0..1 BackboneElement The assertion to perform
...... result 1..1 code pass | skip | fail | warning | error
Binding: Test Report Action Result (Required)
...... message 0..1 markdown A message associated with the result
...... detail 0..1 string A link to further details on the result
...... requirement 0..* BackboneElement Links or references to the testing requirements

....... link[x] 0..1 Link or reference to the testing requirement
........ linkUri uri
........ linkCanonical canonical(Requirements)
... test 0..* BackboneElement A test executed from the test script

.... name 0..1 string Tracking/logging name of this test (link to test in TestScript)
.... description 0..1 string Tracking/reporting short description of the test
.... result 0..1 code pass | skip | fail | warning | error
Binding: Test Report Action Result (Required)
.... period 0..1 Period Start and End times running the test (accurate to milliseconds)
.... action C 1..* BackboneElement A test operation or assert that was performed
+ Rule: Test action SHALL contain either an operation or assert but not both.

..... operation 0..1 see operation The operation performed
..... assert 0..1 see assert The assertion performed
.... log 0..1 Attachment Text log of the internal execution of the tests
... teardown 0..1 BackboneElement The results of running the series of required clean up steps
.... action 1..* BackboneElement One or more teardown operations performed

..... operation 1..1 see operation The teardown operation performed
... presentedForm 0..1 Attachment A document presentation of the test outcomes (e.g. PDF)
... log 0..1 Attachment Text log of the internal execution of the tests

doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

Path ValueSet Type Documentation
TestReport.status TestReportStatus Required

The current status of the test report.

TestReport.result TestReportResult Required

The reported execution result.

TestReport.participant.type TestReportParticipantType Required

The type of participant.

TestReport.setup.action.operation.result TestReportActionResult Required

The results of executing an action.

TestReport.setup.action.assert.result TestReportActionResult Required

The results of executing an action.

TestReport.test.result TestReportActionResult Required

The results of executing an action.

UniqueKeyLevelLocationDescriptionExpression
img tr-0Rule TestReport.setup.actionSetup action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
img tr-2Rule TestReport.test.actionTest action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()

Please refer to the Testing FHIR - How Tos for examples on working with this resource.

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
identifier token An external identifier for the test report TestReport.identifier
issued date The test report generation date TestReport.issued
participant uri The reference to a participant in the test execution TestReport.participant.uri
result token The result disposition of the test execution TestReport.result
status token The current status of the test report TestReport.status
tester string The name of the testing organization TestReport.tester
testscript reference The test script executed to produce this report TestReport.testScript
(TestScript)