R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

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 IdTestReport
Definition

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

Short DisplayDescribes the results of a TestScript execution
Cardinality0..*
TypeDomainResource
Summaryfalse
TestReport.identifier
Element IdTestReport.identifier
Definition

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

Short DisplayExternal identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..1
TypeIdentifier
Summarytrue
TestReport.name
Element IdTestReport.name
Definition

A free text natural language name identifying the executed TestReport.

Short DisplayInformal name of the executed TestReport
Cardinality0..1
Typestring
Summarytrue
Comments

Not expected to be globally unique.

TestReport.status
Element IdTestReport.status
Definition

The current state of this test report.

Short Displaycompleted | in-progress | waiting | stopped | entered-in-error
Cardinality1..1
Terminology BindingTest Report Status (Required)
Typecode
Is Modifiertrue (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)
Summarytrue
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 IdTestReport.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 DisplayCanonical URL to the version-specific TestScript that was executed to produce this TestReport
Cardinality1..1
Typecanonical(TestScript)
Summarytrue
TestReport.result
Element IdTestReport.result
Definition

The overall result from the execution of the TestScript.

Short Displaypass | fail | pending
Cardinality1..1
Terminology BindingTest Report Result (Required)
Typecode
Summarytrue
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 IdTestReport.score
Definition

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

Short DisplayThe final score (percentage of tests passed) resulting from the execution of the TestScript
Cardinality0..1
Typedecimal
Summarytrue
TestReport.tester
Element IdTestReport.tester
Definition

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

Short DisplayName of the tester producing this report (Organization or individual)
Cardinality0..1
Typestring
Requirements

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

Summarytrue
Comments

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

TestReport.issued
Element IdTestReport.issued
Definition

When the TestScript was executed and this TestReport was generated.

Short DisplayWhen the TestScript was executed and this TestReport was generated
Cardinality0..1
TypedateTime
Summarytrue
Comments

Additional specific dates may be added as extensions.

TestReport.participant
Element IdTestReport.participant
Definition

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

Short DisplayA participant in the test execution, either the execution engine, a client, or a server
Cardinality0..*
Summaryfalse
TestReport.participant.type
Element IdTestReport.participant.type
Definition

The type of participant.

Short Displaytest-engine | client | server
Cardinality1..1
Terminology BindingTest Report Participant Type (Required)
Typecode
Summaryfalse
TestReport.participant.uri
Element IdTestReport.participant.uri
Definition

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

Short DisplayThe uri of the participant. An absolute URL is preferred
Cardinality1..1
Typeuri
Summaryfalse
TestReport.participant.display
Element IdTestReport.participant.display
Definition

The display name of the participant.

Short DisplayThe display name of the participant
Cardinality0..1
Typestring
Summaryfalse
TestReport.setup
Element IdTestReport.setup
Definition

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

Short DisplayThe results of the series of required setup operations before the tests were executed
Cardinality0..1
Summaryfalse
TestReport.setup.action
Element IdTestReport.setup.action
Definition

Action would contain either an operation or an assertion.

Short DisplayA setup operation or assert that was executed
Cardinality1..*
Summaryfalse
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 IdTestReport.setup.action.operation
Definition

The operation performed.

Short DisplayThe operation to perform
Cardinality0..1
Summaryfalse
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 IdTestReport.setup.action.operation.result
Definition

The result of this operation.

Short Displaypass | skip | fail | warning | error
Cardinality1..1
Terminology BindingTest Report Action Result (Required)
Typecode
Summaryfalse
TestReport.setup.action.operation.message
Element IdTestReport.setup.action.operation.message
Definition

An explanatory message associated with the result.

Short DisplayA message associated with the result
Cardinality0..1
Typemarkdown
Summaryfalse
TestReport.setup.action.operation.detail
Element IdTestReport.setup.action.operation.detail
Definition

A link to further details on the result.

Short DisplayA link to further details on the result
Cardinality0..1
Typeuri
Summaryfalse
TestReport.setup.action.assert
Element IdTestReport.setup.action.assert
Definition

The results of the assertion performed on the previous operations.

Short DisplayThe assertion to perform
Cardinality0..1
Summaryfalse
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 IdTestReport.setup.action.assert.result
Definition

The result of this assertion.

Short Displaypass | skip | fail | warning | error
Cardinality1..1
Terminology BindingTest Report Action Result (Required)
Typecode
Summaryfalse
TestReport.setup.action.assert.message
Element IdTestReport.setup.action.assert.message
Definition

An explanatory message associated with the result.

Short DisplayA message associated with the result
Cardinality0..1
Typemarkdown
Summaryfalse
TestReport.setup.action.assert.detail
Element IdTestReport.setup.action.assert.detail
Definition

A link to further details on the result.

Short DisplayA link to further details on the result
Cardinality0..1
Typestring
Summaryfalse
TestReport.setup.action.assert.requirement
Element IdTestReport.setup.action.assert.requirement
Definition

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

Short DisplayLinks or references to the testing requirements
Cardinality0..*
Summaryfalse
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 IdTestReport.setup.action.assert.requirement.link[x]
Definition

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

Short DisplayLink or reference to the testing requirement
Cardinality0..1
Typeuri|canonical(Requirements)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse
TestReport.test
Element IdTestReport.test
Definition

A test executed from the test script.

Short DisplayA test executed from the test script
Cardinality0..*
Summaryfalse
TestReport.test.name
Element IdTestReport.test.name
Definition

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

Short DisplayTracking/logging name of this test
Cardinality0..1
Typestring
Summaryfalse
TestReport.test.description
Element IdTestReport.test.description
Definition

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

Short DisplayTracking/reporting short description of the test
Cardinality0..1
Typestring
Summaryfalse
TestReport.test.action
Element IdTestReport.test.action
Definition

Action would contain either an operation or an assertion.

Short DisplayA test operation or assert that was performed
Cardinality1..*
Summaryfalse
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 IdTestReport.test.action.operation
Definition

An operation would involve a REST request to a server.

Short DisplayThe operation performed
Cardinality0..1
TypeSee TestReport.setup.action.operation
Summaryfalse
TestReport.test.action.assert
Element IdTestReport.test.action.assert
Definition

The results of the assertion performed on the previous operations.

Short DisplayThe assertion performed
Cardinality0..1
TypeSee TestReport.setup.action.assert
Summaryfalse
TestReport.teardown
Element IdTestReport.teardown
Definition

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

Short DisplayThe results of running the series of required clean up steps
Cardinality0..1
Summaryfalse
TestReport.teardown.action
Element IdTestReport.teardown.action
Definition

The teardown action will only contain an operation.

Short DisplayOne or more teardown operations performed
Cardinality1..*
Summaryfalse
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 IdTestReport.teardown.action.operation
Definition

An operation would involve a REST request to a server.

Short DisplayThe teardown operation performed
Cardinality1..1
TypeSee TestReport.setup.action.operation
Summaryfalse