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.8 Resource TestReport - Detailed Descriptions

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

Detailed Descriptions for the elements in the TestReport resource.

TestReport
Element Id TestReport
Definition

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

Short Display Describes the results of a TestScript execution
Cardinality 0..*
Type DomainResource
Summary false
TestReport.identifier
Element Id TestReport.identifier
Definition

Identifier for the TestReport assigned for external purposes outside the context of FHIR.

Short Display External identifier
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..1
Type Identifier
Summary true
TestReport.name
Element Id TestReport.name
Definition

A free text natural language name identifying the executed TestReport.

Short Display Informal name of the executed TestReport
Cardinality 0..1
Type string
Summary true
Comments

Not expected to be globally unique.

TestReport.status
Element Id TestReport.status
Definition

The current state of this test report.

Short Display completed | in-progress | waiting | stopped | entered-in-error
Cardinality 1..1
Terminology Binding Test Report Status (Required)
Type code
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summary true
Comments

The status represents where the execution is currently within the test script execution life cycle.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

TestReport.testScript
Element Id TestReport.testScript
Definition

Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the TestScript.url.

Short Display Canonical URL to the version-specific TestScript that was executed to produce this TestReport
Cardinality 1..1
Type canonical(TestScript)
Summary true
TestReport.result
Element Id TestReport.result
Definition

The overall result from the execution of the TestScript.

Short Display pass | fail | pending
Cardinality 1..1
Terminology Binding Test Report Result (Required)
Type code
Summary true
Comments

The pass and fail result represents a completed test script execution. The pending result represents a test script execution that has not yet started or is currently in progress.

TestReport.score
Element Id TestReport.score
Definition

The final score (percentage of tests passed) resulting from the execution of the TestScript.

Short Display The final score (percentage of tests passed) resulting from the execution of the TestScript
Cardinality 0..1
Type decimal
Summary true
TestReport.tester
Element Id TestReport.tester
Definition

Name of the tester producing this report (Organization or individual).

Short Display Name of the tester producing this report (Organization or individual)
Cardinality 0..1
Type string
Requirements

Helps establish the "authority/credibility" of the TestReport. May also allow for contact.

Summary true
Comments

Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.

TestReport.issued
Element Id TestReport.issued
Definition

When the TestScript was executed and this TestReport was generated.

Short Display When the TestScript was executed and this TestReport was generated
Cardinality 0..1
Type dateTime
Summary true
Comments

Additional specific dates may be added as extensions.

TestReport.participant
Element Id TestReport.participant
Definition

A participant in the test execution, either the execution engine, a client, or a server.

Short Display A participant in the test execution, either the execution engine, a client, or a server
Cardinality 0..*
Summary false
TestReport.participant.type
Element Id TestReport.participant.type
Definition

The type of participant.

Short Display test-engine | client | server
Cardinality 1..1
Terminology Binding Test Report Participant Type (Required)
Type code
Summary false
TestReport.participant.uri
Element Id TestReport.participant.uri
Definition

The uri of the participant. An absolute URL is preferred.

Short Display The uri of the participant. An absolute URL is preferred
Cardinality 1..1
Type uri
Summary false
TestReport.participant.display
Element Id TestReport.participant.display
Definition

The display name of the participant.

Short Display The display name of the participant
Cardinality 0..1
Type string
Summary false
TestReport.setup
Element Id TestReport.setup
Definition

The results of the series of required setup operations before the tests were executed.

Short Display The results of the series of required setup operations before the tests were executed
Cardinality 0..1
Summary false
TestReport.setup.action
Element Id TestReport.setup.action
Definition

Action would contain either an operation or an assertion.

Short Display A setup operation or assert that was executed
Cardinality 1..*
Summary false
Comments

An action should contain either an operation or an assertion but not both. It can contain any number of variables.

Invariants
Defined on this element
inv-1Rule Setup action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
TestReport.setup.action.operation
Element Id TestReport.setup.action.operation
Definition

The operation performed.

Short Display The operation to perform
Cardinality 0..1
Summary false
Invariants
Affect this element
inv-1Rule Setup action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
inv-2Rule Test action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
TestReport.setup.action.operation.result
Element Id TestReport.setup.action.operation.result
Definition

The result of this operation.

Short Display pass | skip | fail | warning | error
Cardinality 1..1
Terminology Binding Test Report Action Result (Required)
Type code
Summary false
TestReport.setup.action.operation.message
Element Id TestReport.setup.action.operation.message
Definition

An explanatory message associated with the result.

Short Display A message associated with the result
Cardinality 0..1
Type markdown
Summary false
TestReport.setup.action.operation.detail
Element Id TestReport.setup.action.operation.detail
Definition

A link to further details on the result.

Short Display A link to further details on the result
Cardinality 0..1
Type uri
Summary false
TestReport.setup.action.assert
Element Id TestReport.setup.action.assert
Definition

The results of the assertion performed on the previous operations.

Short Display The assertion to perform
Cardinality 0..1
Summary false
Invariants
Affect this element
inv-1Rule Setup action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
inv-2Rule Test action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
TestReport.setup.action.assert.result
Element Id TestReport.setup.action.assert.result
Definition

The result of this assertion.

Short Display pass | skip | fail | warning | error
Cardinality 1..1
Terminology Binding Test Report Action Result (Required)
Type code
Summary false
TestReport.setup.action.assert.message
Element Id TestReport.setup.action.assert.message
Definition

An explanatory message associated with the result.

Short Display A message associated with the result
Cardinality 0..1
Type markdown
Summary false
TestReport.setup.action.assert.detail
Element Id TestReport.setup.action.assert.detail
Definition

A link to further details on the result.

Short Display A link to further details on the result
Cardinality 0..1
Type string
Summary false
TestReport.setup.action.assert.requirement
Element Id TestReport.setup.action.assert.requirement
Definition

Links or references providing traceability to the testing requirements for this assert.

Short Display Links or references to the testing requirements
Cardinality 0..*
Summary false
Comments

TestScript and TestReport instances are typically (and expected to be) based on known, defined test requirements and documentation. These links provide traceability from the executable/executed TestScript and TestReport tests to these requirements.

TestReport.setup.action.assert.requirement.link[x]
Element Id TestReport.setup.action.assert.requirement.link[x]
Definition

Link or reference providing traceability to the testing requirement for this test.

Short Display Link or reference to the testing requirement
Cardinality 0..1
Type uri|canonical(Requirements)
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
TestReport.test
Element Id TestReport.test
Definition

A test executed from the test script.

Short Display A test executed from the test script
Cardinality 0..*
Summary false
TestReport.test.name
Element Id TestReport.test.name
Definition

The name of this test used for tracking/logging purposes by test engines.

Short Display Tracking/logging name of this test
Cardinality 0..1
Type string
Summary false
TestReport.test.description
Element Id TestReport.test.description
Definition

A short description of the test used by test engines for tracking and reporting purposes.

Short Display Tracking/reporting short description of the test
Cardinality 0..1
Type string
Summary false
TestReport.test.action
Element Id TestReport.test.action
Definition

Action would contain either an operation or an assertion.

Short Display A test operation or assert that was performed
Cardinality 1..*
Summary false
Comments

An action should contain either an operation or an assertion but not both. It can contain any number of variables.

Invariants
Defined on this element
inv-2Rule Test action SHALL contain either an operation or assert but not both.operation.exists() xor assert.exists()
TestReport.test.action.operation
Element Id TestReport.test.action.operation
Definition

An operation would involve a REST request to a server.

Short Display The operation performed
Cardinality 0..1
Type See TestReport.setup.action.operation
Summary false
TestReport.test.action.assert
Element Id TestReport.test.action.assert
Definition

The results of the assertion performed on the previous operations.

Short Display The assertion performed
Cardinality 0..1
Type See TestReport.setup.action.assert
Summary false
TestReport.teardown
Element Id TestReport.teardown
Definition

The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).

Short Display The results of running the series of required clean up steps
Cardinality 0..1
Summary false
TestReport.teardown.action
Element Id TestReport.teardown.action
Definition

The teardown action will only contain an operation.

Short Display One or more teardown operations performed
Cardinality 1..*
Summary false
Comments

An action should contain either an operation or an assertion but not both. It can contain any number of variables.

TestReport.teardown.action.operation
Element Id TestReport.teardown.action.operation
Definition

An operation would involve a REST request to a server.

Short Display The teardown operation performed
Cardinality 1..1
Type See TestReport.setup.action.operation
Summary false