R6 Ballot (2nd Draft)

Publish-box (todo)

FHIR Infrastructure icon Work GroupMaturity Level: 0 DraftSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the TestPlan resource.

TestPlan
Element Id TestPlan
Definition

A plan for executing testing on an artifact or specifications.

Short Display Description of intented testing
Cardinality 0..*
Type CanonicalResource
Summary false
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
TestPlan.url
Element Id TestPlan.url
Definition

An absolute URI that is used to identify this test plan when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this test plan is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test plan is stored on different servers.

Short Display Canonical identifier for this test plan, represented as a URI (globally unique)
Cardinality 0..1
Type uri
Requirements

Allows the test plan to be referenced by a single globally unique identifier.

Alternate Names url; authoritative-url; destination; identity
Summary true
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
TestPlan.identifier
Element Id TestPlan.identifier
Definition

A formal identifier that is used to identify this test plan when it is represented in other formats, or referenced in a specification, model, design or an instance.

Short Display Business identifier identifier for the test plan
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summary true
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this test plan outside of FHIR, where it is not possible to use the logical URI.

TestPlan.version
Element Id TestPlan.version
Definition

The identifier that is used to identify this version of the test plan when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test plan author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Short Display Business version of the test plan
Note This is a business versionId, not a resource version id (see discussion)
Cardinality 0..1
Type string
Summary true
Comments

There may be different test plan instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the test plan with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

TestPlan.versionAlgorithm[x]
Element Id TestPlan.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short Display How to compare versions
Cardinality 0..1
Terminology Binding Version Algorithm (Extensible)
Type string|Coding
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

TestPlan.name
Element Id TestPlan.name
Definition

A natural language name identifying the test plan. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Short Display Name for this test plan (computer friendly)
Cardinality 0..1
Type string
Requirements

Support code generation.

Summary true
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
TestPlan.title
Element Id TestPlan.title
Definition

A short, descriptive, user-friendly title for the test plan.

Short Display Name for this test plan (human friendly)
Cardinality 0..1
Type string
Summary false
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

TestPlan.status
Element Id TestPlan.status
Definition

The status of this test plan. Enables tracking the life-cycle of the content.

Short Display draft | active | retired | unknown
Cardinality 1..1
Terminology Binding PublicationStatus (Required)
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summary true
Comments

Allows filtering of test plans that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

TestPlan.experimental
Element Id TestPlan.experimental
Definition

A Boolean value to indicate that this test plan is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Short Display For testing purposes, not real usage
Cardinality 0..1
Type boolean
Meaning if Missing If absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level test plan.

Summary true
Comments

Allows filtering of test plans that are appropriate for use versus not.

TestPlan.date
Element Id TestPlan.date
Definition

The date (and optionally time) when the test plan was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test plan changes.

Short Display Date last changed
Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
Comments

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the test plan. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

TestPlan.publisher
Element Id TestPlan.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the test plan.

Short Display Name of the publisher/steward (organization or individual)
Cardinality 0..1
Type string
Requirements

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

Summary true
Comments

Usually an organization but may be an individual. The publisher (or steward) of the test plan is the organization or individual primarily responsible for the maintenance and upkeep of the test plan. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the test plan. This item SHOULD be populated unless the information is available from context.

TestPlan.contact
Element Id TestPlan.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short Display Contact details for the publisher
Cardinality 0..*
Type ContactDetail
Summary true
Comments

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

TestPlan.description
Element Id TestPlan.description
Definition

A free text natural language description of the test plan from a consumer's perspective.

Short Display Natural language description of the test plan
Cardinality 0..1
Type markdown
Summary false
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the test plan as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the test plan is presumed to be the predominant language in the place the test plan was created).

TestPlan.useContext
Element Id TestPlan.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test plan instances.

Short Display The context that the content is intended to support
Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

TestPlan.jurisdiction
Standards Status This element has a standards status of "Deprecated" which is different from the status of the whole resource
Element Id TestPlan.jurisdiction
Definition

A legal or geographic region in which the test plan is intended to be used.

Short Display Intended jurisdiction where the test plan applies (if applicable)
Cardinality 0..*
Terminology Binding Jurisdiction ValueSet (Extensible)
Type CodeableConcept
Summary true
Comments

It may be possible for the test plan to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

TestPlan.purpose
Element Id TestPlan.purpose
Definition

Explanation of why this test plan is needed and why it has been designed as it has.

Short Display Why this test plan is defined
Cardinality 0..1
Type markdown
Summary false
Comments

This element does not describe the usage of the test plan Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this test plan.

TestPlan.copyright
Element Id TestPlan.copyright
Definition

A copyright statement relating to the test plan and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test plan. The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

Short Display Use and/or publishing restrictions
Cardinality 0..1
Type markdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the test plan and/or its content.

Alternate Names License; Restrictions
Summary false
TestPlan.copyrightLabel
Element Id TestPlan.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short Display Copyright holder and year(s)
Cardinality 0..1
Type string
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summary false
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

TestPlan.category
Element Id TestPlan.category
Definition

The category of the Test Plan - can be acceptance, unit, performance, etc.

Short Display The category of the Test Plan - can be acceptance, unit, performance
Cardinality 0..*
Terminology Binding Test Script Scope Phase Type (Example)
Type CodeableConcept
Summary false
TestPlan.scope
Element Id TestPlan.scope
Definition

What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference...

Short Display What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference
Cardinality 0..*
Type Reference(Any)
Summary false
TestPlan.testTools
Element Id TestPlan.testTools
Definition

A description of test tools to be used in the test plan.

Short Display A description of test tools to be used in the test plan - narrative for now
Cardinality 0..1
Type markdown
Summary false
TestPlan.dependency
Element Id TestPlan.dependency
Definition

The required criteria to execute the test plan - e.g. preconditions, previous tests...

Short Display The required criteria to execute the test plan - e.g. preconditions, previous tests
Cardinality 0..*
Summary false
TestPlan.dependency.description
Element Id TestPlan.dependency.description
Definition

A textual description of the criterium - what is needed for the dependency to be considered met.

Short Display Description of the dependency criterium
Cardinality 0..1
Type markdown
Summary false
TestPlan.dependency.predecessor
Element Id TestPlan.dependency.predecessor
Definition

Predecessor test plans - those that are expected to be successfully performed as a dependency for the execution of this test plan.

Short Display Link to predecessor test plans
Cardinality 0..1
Type Reference(TestPlan)
Summary false
TestPlan.exitCriteria
Element Id TestPlan.exitCriteria
Definition

The threshold or criteria for the test plan to be considered successfully executed - narrative.

Short Display The threshold or criteria for the test plan to be considered successfully executed - narrative
Cardinality 0..1
Type markdown
Summary false
TestPlan.testCase
Element Id TestPlan.testCase
Definition

The individual test cases that are part of this plan, when they they are made explicit.

Short Display The test cases that constitute this plan
Cardinality 0..*
Summary false
TestPlan.testCase.key
Element Id TestPlan.testCase.key
Definition

Key that identifies this test case (unique within this resource).

Short Display Key that identifies this test case
Cardinality 1..1
Type id
Summary false
TestPlan.testCase.description
Element Id TestPlan.testCase.description
Definition

Narrative description using markdown content to explain the purpose of this test case.

Short Display Narrative description explaining the purpose of this test case
Cardinality 0..1
Type markdown
Summary false
TestPlan.testCase.sequence
Element Id TestPlan.testCase.sequence
Definition

Sequence of test case - an ordinal number that indicates the order for the present test case in the test plan.

Short Display Sequence of test case in the test plan
Cardinality 0..1
Type integer
Summary false
TestPlan.testCase.scope
Element Id TestPlan.testCase.scope
Definition

The scope or artifact covered by the case, when the individual test case is associated with a testable artifact.

Short Display The scope or artifact covered by the case
Cardinality 0..*
Type Reference(Any)
Summary false
TestPlan.testCase.requirement
Element Id TestPlan.testCase.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

TestPlan 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.

TestPlan.testCase.requirement.reference
Element Id TestPlan.testCase.requirement.reference
Definition

Canonical reference providing traceability to the testing requirement for this test case.

Short Display Canonical reference to the Requirements instance
Cardinality 1..1
Type canonical(Requirements)
Summary false
TestPlan.testCase.requirement.key
Element Id TestPlan.testCase.requirement.key
Definition

Requirements.statement.key that identifies the statement that this test case satisfies.

Short Display Requirements statement key identifier
Cardinality 1..1
Type id
Summary false
TestPlan.testCase.dependency
Element Id TestPlan.testCase.dependency
Definition

The required criteria to execute the test case - e.g. preconditions, previous tests.

Short Display Required criteria to execute the test case
Cardinality 0..*
Summary false
TestPlan.testCase.dependency.description
Element Id TestPlan.testCase.dependency.description
Definition

Description of the criteria.

Short Display Description of the criteria
Cardinality 0..1
Type markdown
Summary false
TestPlan.testCase.dependency.reference
Element Id TestPlan.testCase.dependency.reference
Definition

Canonical reference providing traceability to the TestPlan dependency instance for this test case.

Short Display Canonical reference to the TestPlan dependency instance
Cardinality 0..1
Type canonical(TestPlan)
Summary false
TestPlan.testCase.dependency.key
Element Id TestPlan.testCase.dependency.key
Definition

TestPlan.testCase.key that identifies the testCase in the TestPlan dependency instance.

Short Display TestPlan dependency instance testCase key identifier
Cardinality 0..1
Type id
Summary false
TestPlan.testCase.testRun
Element Id TestPlan.testCase.testRun
Definition

The actual test to be executed.

Short Display The actual test to be executed
Cardinality 0..*
Summary false
TestPlan.testCase.testRun.narrative
Element Id TestPlan.testCase.testRun.narrative
Definition

The narrative description of the tests.

Short Display The narrative description of the tests
Cardinality 0..1
Type markdown
Summary false
TestPlan.testCase.testRun.script
Element Id TestPlan.testCase.testRun.script
Definition

The test cases in a structured language e.g. gherkin, Postman, or FHIR TestScript.

Short Display The test cases in a structured language e.g. gherkin, Postman, or FHIR TestScript
Cardinality 0..1
Summary false
TestPlan.testCase.testRun.script.language
Element Id TestPlan.testCase.testRun.script.language
Definition

The language for the test cases e.g. 'gherkin', 'testscript'.

Short Display The language for the test cases e.g. 'gherkin', 'testscript'
Cardinality 0..1
Type CodeableConcept
Summary false
TestPlan.testCase.testRun.script.source[x]
Element Id TestPlan.testCase.testRun.script.source[x]
Definition

The actual content of the cases - references to TestScripts or externally defined content.

Short Display The actual content of the cases - references to TestScripts or externally defined content
Cardinality 0..1
Type string|Reference(Any)
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
TestPlan.testCase.testData
Element Id TestPlan.testCase.testData
Definition

The test data used in the test case.

Short Display The test data used in the test case
Cardinality 0..*
Summary false
TestPlan.testCase.testData.type
Element Id TestPlan.testCase.testData.type
Definition

The type of test data description, e.g. 'synthea'.

Short Display The type of test data description, e.g. 'synthea'
Cardinality 1..1
Type Coding
Summary false
TestPlan.testCase.testData.content
Element Id TestPlan.testCase.testData.content
Definition

The actual test resources when they exist.

Short Display The actual test resources when they exist
Cardinality 0..1
Type Reference(Any)
Summary false
TestPlan.testCase.testData.source[x]
Element Id TestPlan.testCase.testData.source[x]
Definition

Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc.

Short Display Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc
Cardinality 0..1
Type string|Reference(Any)
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
TestPlan.testCase.assertion
Element Id TestPlan.testCase.assertion
Definition

The test assertions - the expectations of test results from the execution of the test case.

Short Display Test assertions or expectations
Cardinality 0..*
Summary false
TestPlan.testCase.assertion.type
Element Id TestPlan.testCase.assertion.type
Definition

The test assertion type - this can be used to group assertions as 'required' or 'optional', or can be used for other classification of the assertion.

Short Display Assertion type - for example 'informative' or 'required'
Cardinality 0..*
Type CodeableConcept
Summary false
TestPlan.testCase.assertion.object
Element Id TestPlan.testCase.assertion.object
Definition

The focus or object of the assertion i.e. a resource.

Short Display The focus or object of the assertion
Cardinality 0..*
Type CodeableReference
Summary false
TestPlan.testCase.assertion.result
Element Id TestPlan.testCase.assertion.result
Definition

The test assertion - the expected outcome from the test case execution.

Short Display The actual result assertion
Cardinality 0..*
Type CodeableReference
Summary false