FHIR Testing IG
0.1.0-snapshot1 - Draft International flag

FHIR Testing IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 0.1.0-snapshot1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-testing-ig/ and changes regularly. See the Directory of published versions

Resource: Test Plan - Detailed Descriptions

Page standards status: Draft Maturity Level: 1

Definitions for the TestPlan resource

Guidance on how to interpret the contents of this table can be foundhere

0. TestPlan
Definition

A set of test specifications that are able to be executed by a TestRunner that knows how to interpret the tests and execute them.


Common Interface declaration for conformance and knowledge artifact resources.

ShortTests to be executed by a Test Runner that knows the testsCommon Interface declaration for definitional resources
Control1..1
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. TestPlan.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. TestPlan.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. TestPlan.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. TestPlan.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. TestPlan.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. TestPlan.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. TestPlan.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. TestPlan.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. 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.


An absolute URI that is used to identify this {{title}} 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 {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.

ShortCanonical identifier for this test plan, represented as a URI (globally unique)Canonical identifier for this {{title}}, represented as an absolute URI (globally unique)
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.


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.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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


Allows the {{title}} to be referenced by a single globally unique identifier.

Alternate Namesurl, authoritative-url, destination, identity
Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. 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.


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

ShortBusiness identifier for the test planAdditional identifier for the {{title}}
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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


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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. 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.


The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 without additional knowledge. (See the versionAlgorithm element.)

ShortBusiness version of the test planBusiness version of the {{title}}
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.


There may be different {{title}}s that have the same url 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 {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. TestPlan.versionAlgorithm[x]
Definition

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

ShortHow to compare versions
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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm|6.0.0-ballot3
(extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
TypeChoice of: string, Coding
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. 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.


A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource by machine processing applications such as code generation.

ShortName for this test plan (computer friendly)Name for this {{title}} (computer friendly)
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.


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

Control0..1
This element is affected by the following invariants: cnl-0
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Support code generation.


Supports code generation.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. TestPlan.title
Definition

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


A short, descriptive, user-friendly title for the {{title}}.

ShortName for this test plan (human friendly)Name for this {{title}} (human friendly)
Comments

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

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. TestPlan.status
Definition

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


The current state of this {{title}}.

Shortdraft | active | retired | unknown
Comments

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

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


A nominal state-transition diagram can be found in the Definition pattern documentation.

Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

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

If a server wishes to reflect whether a given canonical resource is 'supported' or 'enabled' on that server, this is NOT done with status. Instead, expose support for the resource using a 'feature' in the server's CapabilityStatement. (Not all supported canonical resources will necessarily be searchable on a server, and availability of a canonical resource in a search result does not imply support of the resource for any particular usage.)

Control1..1
BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot3
(required to http://hl7.org/fhir/ValueSet/publication-status)

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. TestPlan.experimental
Definition

A Boolean value to indicate that this test plan is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.


A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage

ShortFor testing only - never for real usage
Comments

Allows filtering of test plans that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.


Allows filtering of {{title}}s that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

Control0..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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


Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}.

Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. 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.


The date (and optionally time) when the {{title}} 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 {{title}} changes.

ShortDate last changed
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.


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 {{title}}. 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.

Control0..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Alternate NamesRevision Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. TestPlan.publisher
Definition

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


The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}.

ShortName of the publisher/steward (organization or individual)
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.


Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. 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 {{title}}. This item SHOULD be populated unless the information is available from context.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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


Helps establish the "authority/credibility" of the {{title}}. May also allow for contact.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. TestPlan.contact
Definition

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

ShortContact details for the publisher
Comments

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

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

Control0..*
TypeContactDetail
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. TestPlan.description
Definition

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


A free text natural language description of the {{title}} from a consumer's perspective.

ShortNatural language description of the test planNatural language description of the {{title}}
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).


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 {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.

Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. 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.


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 {{title}}s.

ShortThe context that the content is intended to support
Comments

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


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

Control0..*
TypeUsageContext
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Assist in searching for appropriate content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. TestPlan.jurisdiction
Definition

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


A legal or geographic region in which the {{title}} is intended to be used.

ShortIntended jurisdiction where the test plan applies (if applicable)Intended jurisdiction for {{title}} (if applicable)
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.)


It may be possible for the {{title}} 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.)

Control0..*
BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction|6.0.0-ballot3
(extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

Countries and regions within which this artifact is targeted for use.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. TestPlan.purpose
Definition

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


Explanation of why this {{title}} is needed and why it has been designed as it has.

ShortWhy this test plan is definedWhy this {{title}} is defined
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.


This element does not describe the usage of the {{title}}. 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 {{title}}.

Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. 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.


A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.

ShortUse and/or publishing restrictions
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

Control0..1
Typemarkdown
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

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


Consumers must be able to determine any legal restrictions on the use of the {{title}} and/or its content.

Alternate NamesLicense, Restrictions
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. 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').

ShortCopyright holder and year(s)
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.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. TestPlan.scope
Definition

The scope indicates what kind of systems these test cases are intended to test.

ShortThe scope - what these test cases are testing
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
54. TestPlan.scope.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeidstring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
56. TestPlan.scope.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on TestPlan.scope.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 58. TestPlan.scope.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. TestPlan.scope.reference
    Definition

    A reference to what is being tested.

    ShortA reference to what is being tested
    Control0..1
    Typecanonical(ActorDefinition, ImplementationGuide, StructureDefinition, CapabilityStatement, Requirements)
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    62. TestPlan.scope.description
    Definition

    Description of what the scope is does / what is being tested.

    ShortDescription of what the scope is exists / what is being tested
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    64. TestPlan.dependency
    Definition

    Another set of test cases that must be passed before these test cases are meaningful to execute. These test cases prove functionality that these tests require to execute.

    ShortTest cases that must be passed before these test cases are meaningful to execute
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
    66. TestPlan.dependency.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typeidstring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    68. TestPlan.dependency.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on TestPlan.dependency.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 70. TestPlan.dependency.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      72. TestPlan.dependency.reference
      Definition

      The test cases.

      ShortThe Test Cases
      Control1..1
      Typecanonical(Test Plan)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      74. TestPlan.dependency.description
      Definition

      Description of what this mode does / why it was defined. This should explain to a tester why the .

      ShortDescription of what the dependency exists / why it was defined
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      76. TestPlan.runner
      Definition

      URL of documentation that explains how a runner would read these tests, and use them to actually test out a tool.

      ShortURL Documentation for a runner that executes these tests
      Control1..1
      Typeurl
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      78. TestPlan.mode
      Definition

      A mode that can be passed to a runner running these these tests, that affects test content and influences how the tests are executed or evaulated (or even if they run).

      ShortA mode that can be passed to runner - affects test content
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
      80. TestPlan.mode.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typeidstring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      82. TestPlan.mode.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on TestPlan.mode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 84. TestPlan.mode.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        86. TestPlan.mode.code
        Definition

        The code by which the mode is identified when passed to runner. This code is used to select which suite and tests are run, and which parameters and inputs are used. Codes are entirely at the descretion of the TestPlan, but typically 'advanced' or 'general' are the kind of codes that could be used.

        ShortThe code that identifies the mode
        Comments

        The code should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Requirements

        Allows the runner to select which tests and parameters are relevant for this mode.

        88. TestPlan.mode.description
        Definition

        Description of what this mode does / why it was defined. This should explain to a tester when they should use the mode.

        ShortDescription of what this mode exists / why it was defined
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        90. TestPlan.parameter
        Definition

        A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

        ShortParameter defined for all tests
        Control0..*
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
        92. TestPlan.parameter.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        This element is affected by the following invariants: ele-1
        Typeidstring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        94. TestPlan.parameter.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on TestPlan.parameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 96. TestPlan.parameter.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          98. TestPlan.parameter.name
          Definition

          Name for the parameter as defined by the runner definition.

          ShortName per Runner Definition
          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          100. TestPlan.parameter.value[x]
          Definition

          The value of the parameter. If the value is an Expression, the definition of the runner describes what kind of expressions are allowed and the features/capabilities that they can make use of.

          ShortValue of this parameter
          Control1..1
          TypeChoice of: string, boolean, integer, decimal, dateTime, uri, Coding, Quantity, Expression
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          102. TestPlan.parameter.mode
          Definition

          If this mode is not passed to the runner, then this parameter will not be used.

          ShortA mode that must be true for this parameter to be used
          Control0..1
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Meaning if MissingIf no modes are listed, the parameter is always used, unless there is a parameter with the same name that is selected by mode
          104. TestPlan.suite
          Definition

          A suite of tests that all share a common set up, and can be executed as a group.

          ShortA suite of tests that share a common set up
          Control0..*
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
          106. TestPlan.suite.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          This element is affected by the following invariants: ele-1
          Typeidstring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          108. TestPlan.suite.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on TestPlan.suite.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 110. TestPlan.suite.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            112. TestPlan.suite.name
            Definition

            The name by which this suite is known by in the test system. The name must be unique in the amongst the suites.

            ShortThe name of this suite - unique in the TestCases resource
            Control1..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            114. TestPlan.suite.description
            Definition

            Description of what this suite does / why it was defined. This should explain to a tester what they should know when deciding which tests to run.

            ShortDescription of what this suite does / why it was defined
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            116. TestPlan.suite.mode
            Definition

            If this mode is not passed to the runner, then this suite will not be run.

            ShortMode required to run this suite
            Control0..1
            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Meaning if MissingIf no modes are listed, the suite is always executed
            118. TestPlan.suite.input
            Definition

            The resources used in the tests in this suite. How exactly they are used depends on the definition of the runner .

            ShortResources used in the tests in this suite
            Control0..*
            TypeBackboneElement
            Invariantstp-1: Either a file, or a resource, but not both (file.exists() xor resource.exists())
            ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
            120. TestPlan.suite.input.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            This element is affected by the following invariants: ele-1
            Typeidstring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            122. TestPlan.suite.input.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on TestPlan.suite.input.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 124. TestPlan.suite.input.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored even if unrecognized
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              Requirements

              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

              Alternate Namesextensions, user content, modifiers
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              126. TestPlan.suite.input.name
              Definition

              A name that identifies this resource. The runner definition defines whether there must be a name, and what names there are.

              ShortA name for this resource (per runner definition)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              128. TestPlan.suite.input.file
              Definition

              A file containing a resource used in the tests.

              ShortA file containing a resource used in the tests
              Comments

              Filename is relative to the folder/directory containing this TestCases

              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              130. TestPlan.suite.input.resource
              Definition

              An inline resource used in the tests. How exactly it is used depends on the definition of the runner.

              ShortAn inline resource used in the tests
              Control0..1
              TypeResource
              132. TestPlan.suite.input.mode
              Definition

              If this mode is not passed to the runner, then this resource will not be used.

              ShortA mode that must be true for this resource to be used
              Control0..1
              Typecode
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Meaning if MissingIf no modes are listed, the resource is always used, unless there is another entry with the same name that is selected by mode
              134. TestPlan.suite.parameter
              Definition

              A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

              ShortParameter defined by the suite
              Control0..*
              TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.parameter
              136. TestPlan.suite.test
              Definition

              An actual test in the test suite.

              ShortA test in the test suite
              Control0..*
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
              138. TestPlan.suite.test.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              This element is affected by the following invariants: ele-1
              Typeidstring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              140. TestPlan.suite.test.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on TestPlan.suite.test.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 142. TestPlan.suite.test.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                144. TestPlan.suite.test.name
                Definition

                The name by which this test is known by in the test system. The name must be unique in the suite.

                ShortThe name of this test - unique in the suite
                Control1..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                146. TestPlan.suite.test.description
                Definition

                Description of what this test does / why it was defined. This should explain to a tester what they should know when looking at failing test results.

                ShortDescription of what this test does / why it was defined
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                148. TestPlan.suite.test.operation
                Definition

                A code that identifies the operation executed for this test. One of the codes defined in the definition of the runner.

                ShortOperation that is executed during this test (per definition of runner)
                Control0..1
                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                150. TestPlan.suite.test.mode
                Definition

                If this mode is not passed to the runner, then this test will not be run.

                ShortMode required to run this test
                Control0..1
                Typecode
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Meaning if MissingIf no modes are listed, the test is always executed
                152. TestPlan.suite.test.parameter
                Definition

                A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

                ShortParameter defined by the test
                Control0..*
                TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.parameter
                154. TestPlan.suite.test.input
                Definition

                The resources used when executing this test. How exactly they are used depends on the definition of the runner.

                ShortResources used when executing this test (per runner definition)
                Control0..*
                TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite.input
                156. TestPlan.suite.test.expected
                Definition

                Resources expected as output from this test. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner. How exactly it is used depends on the definition of the runner, but the expectation is that these are the expected output, to which the actual output is compared.

                ShortResources expected as output from this test (per runner definition, often Matchetypes)
                Control0..*
                TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite.input
                158. TestPlan.suite.test.assertion
                Definition

                One or more assertions that can be executed against the output of the tests. These may be used with matchetypes to make rules about content the matchetypes leave open.

                ShortAssertions that can be executed against the output of the tests
                Control0..*
                TypeBackboneElement
                Invariantstp-2: At least an expression or a human readable rule must exist (expression.exists() or human.exists())
                ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                160. TestPlan.suite.test.assertion.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                This element is affected by the following invariants: ele-1
                Typeidstring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                162. TestPlan.suite.test.assertion.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on TestPlan.suite.test.assertion.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 164. TestPlan.suite.test.assertion.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  166. TestPlan.suite.test.assertion.focus
                  Definition

                  Resources expected as output from this test. Often, but not always, these resources are Matchetype resources.

                  ShortWhich output the assertion is tested on (by name, if there is more than one)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  168. TestPlan.suite.test.assertion.severity
                  Definition

                  Resources expected as output from this test. Only error and fatal assertions are considered to cause a test to fail. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner.

                  Shortfatal | error | warning | information | success; fatal+error = fail
                  Control0..1
                  BindingThe codes SHALL be taken from IssueSeverity .http://hl7.org/fhir/ValueSet/issue-severity|5.0.0
                  (required to http://hl7.org/fhir/ValueSet/issue-severity|5.0.0)

                  The severity of the assertion

                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  170. TestPlan.suite.test.assertion.expression
                  Definition

                  Resources expected as output from this test. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner.

                  ShortTechnical Expression of the assertion
                  Control0..1
                  TypeExpression
                  172. TestPlan.suite.test.assertion.human
                  Definition

                  A human readable description of the assertion.

                  ShortHuman readable description of the assertion
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  174. TestPlan.suite.test.assertion.mode
                  Definition

                  If this mode is not passed to the runner, then this assertion will not be used.

                  ShortA mode that must be true for this assertion to apply
                  Control0..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Meaning if MissingIf no modes are listed, the assertion is always used, unless there is another assertion with the same name that is selected by mode
                  176. TestPlan.suite.suite
                  Definition

                  A nested set of tests.

                  ShortA nested suite of tests
                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite
                  178. TestPlan.suite.plan
                  Definition

                  A nested set of test plans that run within the context of this suite. Typically, the runner must be the same in the nested test plans.

                  ShortA nested set of test plans
                  Comments

                  This is a reference to allow for direct local file references etc, but since TestPlan is a CanonicalResource, it can also be resolved as a canonical reference.

                  Control0..*
                  TypeReference(Test Plan)

                  Guidance on how to interpret the contents of this table can be foundhere

                  0. TestPlan
                  Definition

                  A set of test specifications that are able to be executed by a TestRunner that knows how to interpret the tests and execute them.

                  ShortTests to be executed by a Test Runner that knows the tests
                  Control1..1
                  Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
                  2. 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.

                  ShortCanonical identifier for this test plan, represented as a URI (globally unique)
                  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.

                  Control0..1
                  Typeuri
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Requirements

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

                  Alternate Namesurl, authoritative-url, destination, identity
                  4. 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.

                  ShortBusiness identifier for the test plan
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  TypeIdentifier
                  Requirements

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

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

                  ShortBusiness version of the test plan
                  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.

                  NoteThis is a business version Id, not a resource version Id (see discussion)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  8. TestPlan.versionAlgorithm[x]
                  Definition

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

                  ShortHow to compare versions
                  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.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
                  (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
                  TypeChoice of: string, Coding
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  10. 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.

                  ShortName for this test plan (computer friendly)
                  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.

                  Control0..1
                  This element is affected by the following invariants: cnl-0
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Requirements

                  Support code generation.

                  12. TestPlan.title
                  Definition

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

                  ShortName for this test plan (human friendly)
                  Comments

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

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  14. TestPlan.status
                  Definition

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

                  Shortdraft | active | retired | unknown
                  Comments

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

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

                  Control1..1
                  BindingThe codes SHALL be taken from PublicationStatus
                  (required to http://hl7.org/fhir/ValueSet/publication-status)

                  The lifecycle status of an artifact.

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  16. TestPlan.experimental
                  Definition

                  A Boolean value to indicate that this test plan is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

                  ShortFor testing only - never for real usage
                  Comments

                  Allows filtering of test plans that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

                  Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

                  Control0..1
                  Typeboolean
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Requirements

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

                  Meaning if MissingIf absent, this resource is treated as though it is not experimental.
                  18. 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.

                  ShortDate last changed
                  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.

                  Control0..1
                  TypedateTime
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Alternate NamesRevision Date
                  20. TestPlan.publisher
                  Definition

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

                  ShortName of the publisher/steward (organization or individual)
                  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.

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Requirements

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

                  22. TestPlan.contact
                  Definition

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

                  ShortContact details for the publisher
                  Comments

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

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

                  Control0..*
                  TypeContactDetail
                  24. TestPlan.description
                  Definition

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

                  ShortNatural language description of the test plan
                  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).

                  Control0..1
                  Typemarkdown
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  26. 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.

                  ShortThe context that the content is intended to support
                  Comments

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

                  Control0..*
                  TypeUsageContext
                  Requirements

                  Assist in searching for appropriate content.

                  28. TestPlan.jurisdiction
                  Definition

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

                  ShortIntended jurisdiction where the test plan applies (if applicable)
                  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.)

                  Control0..*
                  BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSet
                  (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

                  Countries and regions within which this artifact is targeted for use.

                  TypeCodeableConcept
                  30. TestPlan.purpose
                  Definition

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

                  ShortWhy this test plan is defined
                  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.

                  Control0..1
                  Typemarkdown
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  32. 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.

                  ShortUse and/or publishing restrictions
                  Control0..1
                  Typemarkdown
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Requirements

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

                  Alternate NamesLicense, Restrictions
                  34. 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').

                  ShortCopyright holder and year(s)
                  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.

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Requirements

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

                  36. TestPlan.scope
                  Definition

                  The scope indicates what kind of systems these test cases are intended to test.

                  ShortThe scope - what these test cases are testing
                  Control0..*
                  TypeBackboneElement
                  38. TestPlan.scope.reference
                  Definition

                  A reference to what is being tested.

                  ShortA reference to what is being tested
                  Control0..1
                  Typecanonical(ActorDefinition, ImplementationGuide, StructureDefinition, CapabilityStatement, Requirements)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  40. TestPlan.scope.description
                  Definition

                  Description of what the scope is does / what is being tested.

                  ShortDescription of what the scope is exists / what is being tested
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  42. TestPlan.dependency
                  Definition

                  Another set of test cases that must be passed before these test cases are meaningful to execute. These test cases prove functionality that these tests require to execute.

                  ShortTest cases that must be passed before these test cases are meaningful to execute
                  Control0..*
                  TypeBackboneElement
                  44. TestPlan.dependency.reference
                  Definition

                  The test cases.

                  ShortThe Test Cases
                  Control1..1
                  Typecanonical(Test Plan)
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  46. TestPlan.dependency.description
                  Definition

                  Description of what this mode does / why it was defined. This should explain to a tester why the .

                  ShortDescription of what the dependency exists / why it was defined
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  48. TestPlan.runner
                  Definition

                  URL of documentation that explains how a runner would read these tests, and use them to actually test out a tool.

                  ShortURL Documentation for a runner that executes these tests
                  Control1..1
                  Typeurl
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  50. TestPlan.mode
                  Definition

                  A mode that can be passed to a runner running these these tests, that affects test content and influences how the tests are executed or evaulated (or even if they run).

                  ShortA mode that can be passed to runner - affects test content
                  Control0..*
                  TypeBackboneElement
                  52. TestPlan.mode.code
                  Definition

                  The code by which the mode is identified when passed to runner. This code is used to select which suite and tests are run, and which parameters and inputs are used. Codes are entirely at the descretion of the TestPlan, but typically 'advanced' or 'general' are the kind of codes that could be used.

                  ShortThe code that identifies the mode
                  Comments

                  The code should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

                  Control1..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Requirements

                  Allows the runner to select which tests and parameters are relevant for this mode.

                  54. TestPlan.mode.description
                  Definition

                  Description of what this mode does / why it was defined. This should explain to a tester when they should use the mode.

                  ShortDescription of what this mode exists / why it was defined
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  56. TestPlan.parameter
                  Definition

                  A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

                  ShortParameter defined for all tests
                  Control0..*
                  TypeBackboneElement
                  58. TestPlan.parameter.name
                  Definition

                  Name for the parameter as defined by the runner definition.

                  ShortName per Runner Definition
                  Control1..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  60. TestPlan.parameter.value[x]
                  Definition

                  The value of the parameter. If the value is an Expression, the definition of the runner describes what kind of expressions are allowed and the features/capabilities that they can make use of.

                  ShortValue of this parameter
                  Control1..1
                  TypeChoice of: string, boolean, integer, decimal, dateTime, uri, Coding, Quantity, Expression
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  62. TestPlan.parameter.mode
                  Definition

                  If this mode is not passed to the runner, then this parameter will not be used.

                  ShortA mode that must be true for this parameter to be used
                  Control0..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Meaning if MissingIf no modes are listed, the parameter is always used, unless there is a parameter with the same name that is selected by mode
                  64. TestPlan.suite
                  Definition

                  A suite of tests that all share a common set up, and can be executed as a group.

                  ShortA suite of tests that share a common set up
                  Control0..*
                  TypeBackboneElement
                  66. TestPlan.suite.name
                  Definition

                  The name by which this suite is known by in the test system. The name must be unique in the amongst the suites.

                  ShortThe name of this suite - unique in the TestCases resource
                  Control1..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  68. TestPlan.suite.description
                  Definition

                  Description of what this suite does / why it was defined. This should explain to a tester what they should know when deciding which tests to run.

                  ShortDescription of what this suite does / why it was defined
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  70. TestPlan.suite.mode
                  Definition

                  If this mode is not passed to the runner, then this suite will not be run.

                  ShortMode required to run this suite
                  Control0..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Meaning if MissingIf no modes are listed, the suite is always executed
                  72. TestPlan.suite.input
                  Definition

                  The resources used in the tests in this suite. How exactly they are used depends on the definition of the runner .

                  ShortResources used in the tests in this suite
                  Control0..*
                  TypeBackboneElement
                  Invariantstp-1: Either a file, or a resource, but not both (file.exists() xor resource.exists())
                  74. TestPlan.suite.input.name
                  Definition

                  A name that identifies this resource. The runner definition defines whether there must be a name, and what names there are.

                  ShortA name for this resource (per runner definition)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  76. TestPlan.suite.input.file
                  Definition

                  A file containing a resource used in the tests.

                  ShortA file containing a resource used in the tests
                  Comments

                  Filename is relative to the folder/directory containing this TestCases

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  78. TestPlan.suite.input.resource
                  Definition

                  An inline resource used in the tests. How exactly it is used depends on the definition of the runner.

                  ShortAn inline resource used in the tests
                  Control0..1
                  TypeResource
                  80. TestPlan.suite.input.mode
                  Definition

                  If this mode is not passed to the runner, then this resource will not be used.

                  ShortA mode that must be true for this resource to be used
                  Control0..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Meaning if MissingIf no modes are listed, the resource is always used, unless there is another entry with the same name that is selected by mode
                  82. TestPlan.suite.parameter
                  Definition

                  A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

                  ShortParameter defined by the suite
                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.parameter
                  84. TestPlan.suite.test
                  Definition

                  An actual test in the test suite.

                  ShortA test in the test suite
                  Control0..*
                  TypeBackboneElement
                  86. TestPlan.suite.test.name
                  Definition

                  The name by which this test is known by in the test system. The name must be unique in the suite.

                  ShortThe name of this test - unique in the suite
                  Control1..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  88. TestPlan.suite.test.description
                  Definition

                  Description of what this test does / why it was defined. This should explain to a tester what they should know when looking at failing test results.

                  ShortDescription of what this test does / why it was defined
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  90. TestPlan.suite.test.operation
                  Definition

                  A code that identifies the operation executed for this test. One of the codes defined in the definition of the runner.

                  ShortOperation that is executed during this test (per definition of runner)
                  Control0..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  92. TestPlan.suite.test.mode
                  Definition

                  If this mode is not passed to the runner, then this test will not be run.

                  ShortMode required to run this test
                  Control0..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Meaning if MissingIf no modes are listed, the test is always executed
                  94. TestPlan.suite.test.parameter
                  Definition

                  A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

                  ShortParameter defined by the test
                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.parameter
                  96. TestPlan.suite.test.input
                  Definition

                  The resources used when executing this test. How exactly they are used depends on the definition of the runner.

                  ShortResources used when executing this test (per runner definition)
                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite.input
                  98. TestPlan.suite.test.expected
                  Definition

                  Resources expected as output from this test. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner. How exactly it is used depends on the definition of the runner, but the expectation is that these are the expected output, to which the actual output is compared.

                  ShortResources expected as output from this test (per runner definition, often Matchetypes)
                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite.input
                  100. TestPlan.suite.test.assertion
                  Definition

                  One or more assertions that can be executed against the output of the tests. These may be used with matchetypes to make rules about content the matchetypes leave open.

                  ShortAssertions that can be executed against the output of the tests
                  Control0..*
                  TypeBackboneElement
                  Invariantstp-2: At least an expression or a human readable rule must exist (expression.exists() or human.exists())
                  102. TestPlan.suite.test.assertion.focus
                  Definition

                  Resources expected as output from this test. Often, but not always, these resources are Matchetype resources.

                  ShortWhich output the assertion is tested on (by name, if there is more than one)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  104. TestPlan.suite.test.assertion.severity
                  Definition

                  Resources expected as output from this test. Only error and fatal assertions are considered to cause a test to fail. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner.

                  Shortfatal | error | warning | information | success; fatal+error = fail
                  Control0..1
                  BindingThe codes SHALL be taken from IssueSeverity .
                  (required to http://hl7.org/fhir/ValueSet/issue-severity|5.0.0)

                  The severity of the assertion

                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  106. TestPlan.suite.test.assertion.expression
                  Definition

                  Resources expected as output from this test. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner.

                  ShortTechnical Expression of the assertion
                  Control0..1
                  TypeExpression
                  108. TestPlan.suite.test.assertion.human
                  Definition

                  A human readable description of the assertion.

                  ShortHuman readable description of the assertion
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  110. TestPlan.suite.test.assertion.mode
                  Definition

                  If this mode is not passed to the runner, then this assertion will not be used.

                  ShortA mode that must be true for this assertion to apply
                  Control0..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Meaning if MissingIf no modes are listed, the assertion is always used, unless there is another assertion with the same name that is selected by mode
                  112. TestPlan.suite.suite
                  Definition

                  A nested set of tests.

                  ShortA nested suite of tests
                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite
                  114. TestPlan.suite.plan
                  Definition

                  A nested set of test plans that run within the context of this suite. Typically, the runner must be the same in the nested test plans.

                  ShortA nested set of test plans
                  Comments

                  This is a reference to allow for direct local file references etc, but since TestPlan is a CanonicalResource, it can also be resolved as a canonical reference.

                  Control0..*
                  TypeReference(Test Plan)

                  Guidance on how to interpret the contents of this table can be foundhere

                  0. TestPlan
                  Definition

                  A set of test specifications that are able to be executed by a TestRunner that knows how to interpret the tests and execute them.

                  ShortTests to be executed by a Test Runner that knows the tests
                  Control1..1
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
                  dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                  dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
                  dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                  dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                  dom-6: A resource should have narrative for robust management (text.`div`.exists())
                  2. TestPlan.id
                  Definition

                  The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                  ShortLogical id of this artifact
                  Comments

                  Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

                  Control0..1
                  Typeid
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  4. TestPlan.meta
                  Definition

                  The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                  ShortMetadata about the resource
                  Control0..1
                  TypeMeta
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  6. TestPlan.implicitRules
                  Definition

                  A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                  ShortA set of rules under which this content was created
                  Comments

                  Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

                  Control0..1
                  Typeuri
                  Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  8. TestPlan.language
                  Definition

                  The base language in which the resource is written.

                  ShortLanguage of the resource content
                  Comments

                  Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                  Control0..1
                  BindingThe codes SHALL be taken from AllLanguages
                  (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

                  IETF language tag for a human language

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  10. TestPlan.text
                  Definition

                  A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                  ShortText summary of the resource, for human interpretation
                  Comments

                  Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                  Control0..1
                  This element is affected by the following invariants: dom-6
                  TypeNarrative
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Alternate Namesnarrative, html, xhtml, display
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  12. TestPlan.contained
                  Definition

                  These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                  ShortContained, inline Resources
                  Comments

                  This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

                  Control0..*
                  This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                  TypeResource
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Alternate Namesinline resources, anonymous resources, contained resources
                  14. TestPlan.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  16. TestPlan.modifierExtension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                  ShortExtensions that cannot be ignored
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                  Must Supportfalse
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  18. 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.

                  ShortCanonical identifier for this test plan, represented as a URI (globally unique)
                  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.

                  Control0..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Requirements

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

                  Alternate Namesurl, authoritative-url, destination, identity
                  Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
                  ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  20. 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.

                  ShortBusiness identifier for the test plan
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  TypeIdentifier
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Requirements

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

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  22. 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.

                  ShortBusiness version of the test plan
                  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.

                  NoteThis is a business version Id, not a resource version Id (see discussion)
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  24. TestPlan.versionAlgorithm[x]
                  Definition

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

                  ShortHow to compare versions
                  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.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
                  (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
                  TypeChoice of: string, Coding
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  26. 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.

                  ShortName for this test plan (computer friendly)
                  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.

                  Control0..1
                  This element is affected by the following invariants: cnl-0
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Requirements

                  Support code generation.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  28. TestPlan.title
                  Definition

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

                  ShortName for this test plan (human friendly)
                  Comments

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

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  30. TestPlan.status
                  Definition

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

                  Shortdraft | active | retired | unknown
                  Comments

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

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

                  Control1..1
                  BindingThe codes SHALL be taken from PublicationStatus
                  (required to http://hl7.org/fhir/ValueSet/publication-status)

                  The lifecycle status of an artifact.

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Requirements

                  Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  32. TestPlan.experimental
                  Definition

                  A Boolean value to indicate that this test plan is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

                  ShortFor testing only - never for real usage
                  Comments

                  Allows filtering of test plans that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

                  Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

                  Control0..1
                  Typeboolean
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Requirements

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

                  Meaning if MissingIf absent, this resource is treated as though it is not experimental.
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  34. 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.

                  ShortDate last changed
                  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.

                  Control0..1
                  TypedateTime
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Alternate NamesRevision Date
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  36. TestPlan.publisher
                  Definition

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

                  ShortName of the publisher/steward (organization or individual)
                  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.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summarytrue
                  Requirements

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

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  38. TestPlan.contact
                  Definition

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

                  ShortContact details for the publisher
                  Comments

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

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

                  Control0..*
                  TypeContactDetail
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  40. TestPlan.description
                  Definition

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

                  ShortNatural language description of the test plan
                  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).

                  Control0..1
                  Typemarkdown
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  42. 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.

                  ShortThe context that the content is intended to support
                  Comments

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

                  Control0..*
                  TypeUsageContext
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Requirements

                  Assist in searching for appropriate content.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  44. TestPlan.jurisdiction
                  Definition

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

                  ShortIntended jurisdiction where the test plan applies (if applicable)
                  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.)

                  Control0..*
                  BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSet
                  (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

                  Countries and regions within which this artifact is targeted for use.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  46. TestPlan.purpose
                  Definition

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

                  ShortWhy this test plan is defined
                  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.

                  Control0..1
                  Typemarkdown
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  48. 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.

                  ShortUse and/or publishing restrictions
                  Comments

                  The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

                  Control0..1
                  Typemarkdown
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summaryfalse
                  Requirements

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

                  Alternate NamesLicense, Restrictions
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  50. 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').

                  ShortCopyright holder and year(s)
                  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.

                  Control0..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  Summaryfalse
                  Requirements

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

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  52. TestPlan.scope
                  Definition

                  The scope indicates what kind of systems these test cases are intended to test.

                  ShortThe scope - what these test cases are testing
                  Control0..*
                  TypeBackboneElement
                  Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                  54. TestPlan.scope.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  56. TestPlan.scope.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on TestPlan.scope.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 58. TestPlan.scope.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    ShortExtensions that cannot be ignored even if unrecognized
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                    Summarytrue
                    Requirements

                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                    Alternate Namesextensions, user content, modifiers
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    60. TestPlan.scope.reference
                    Definition

                    A reference to what is being tested.

                    ShortA reference to what is being tested
                    Control0..1
                    Typecanonical(ActorDefinition, ImplementationGuide, StructureDefinition, CapabilityStatement, Requirements)
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    62. TestPlan.scope.description
                    Definition

                    Description of what the scope is does / what is being tested.

                    ShortDescription of what the scope is exists / what is being tested
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    64. TestPlan.dependency
                    Definition

                    Another set of test cases that must be passed before these test cases are meaningful to execute. These test cases prove functionality that these tests require to execute.

                    ShortTest cases that must be passed before these test cases are meaningful to execute
                    Control0..*
                    TypeBackboneElement
                    Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                    66. TestPlan.dependency.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    68. TestPlan.dependency.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    SlicingThis element introduces a set of slices on TestPlan.dependency.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 70. TestPlan.dependency.modifierExtension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                      ShortExtensions that cannot be ignored even if unrecognized
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      Requirements

                      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                      Alternate Namesextensions, user content, modifiers
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      72. TestPlan.dependency.reference
                      Definition

                      The test cases.

                      ShortThe Test Cases
                      Control1..1
                      Typecanonical(Test Plan)
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      74. TestPlan.dependency.description
                      Definition

                      Description of what this mode does / why it was defined. This should explain to a tester why the .

                      ShortDescription of what the dependency exists / why it was defined
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      76. TestPlan.runner
                      Definition

                      URL of documentation that explains how a runner would read these tests, and use them to actually test out a tool.

                      ShortURL Documentation for a runner that executes these tests
                      Control1..1
                      Typeurl
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      78. TestPlan.mode
                      Definition

                      A mode that can be passed to a runner running these these tests, that affects test content and influences how the tests are executed or evaulated (or even if they run).

                      ShortA mode that can be passed to runner - affects test content
                      Control0..*
                      TypeBackboneElement
                      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                      80. TestPlan.mode.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      82. TestPlan.mode.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on TestPlan.mode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 84. TestPlan.mode.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        86. TestPlan.mode.code
                        Definition

                        The code by which the mode is identified when passed to runner. This code is used to select which suite and tests are run, and which parameters and inputs are used. Codes are entirely at the descretion of the TestPlan, but typically 'advanced' or 'general' are the kind of codes that could be used.

                        ShortThe code that identifies the mode
                        Comments

                        The code should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Requirements

                        Allows the runner to select which tests and parameters are relevant for this mode.

                        88. TestPlan.mode.description
                        Definition

                        Description of what this mode does / why it was defined. This should explain to a tester when they should use the mode.

                        ShortDescription of what this mode exists / why it was defined
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        90. TestPlan.parameter
                        Definition

                        A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

                        ShortParameter defined for all tests
                        Control0..*
                        TypeBackboneElement
                        Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                        92. TestPlan.parameter.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        Typeid
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        94. TestPlan.parameter.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on TestPlan.parameter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 96. TestPlan.parameter.modifierExtension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                          ShortExtensions that cannot be ignored even if unrecognized
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                          Summarytrue
                          Requirements

                          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                          Alternate Namesextensions, user content, modifiers
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          98. TestPlan.parameter.name
                          Definition

                          Name for the parameter as defined by the runner definition.

                          ShortName per Runner Definition
                          Control1..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          100. TestPlan.parameter.value[x]
                          Definition

                          The value of the parameter. If the value is an Expression, the definition of the runner describes what kind of expressions are allowed and the features/capabilities that they can make use of.

                          ShortValue of this parameter
                          Control1..1
                          TypeChoice of: string, boolean, integer, decimal, dateTime, uri, Coding, Quantity, Expression
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          102. TestPlan.parameter.mode
                          Definition

                          If this mode is not passed to the runner, then this parameter will not be used.

                          ShortA mode that must be true for this parameter to be used
                          Control0..1
                          Typecode
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Meaning if MissingIf no modes are listed, the parameter is always used, unless there is a parameter with the same name that is selected by mode
                          104. TestPlan.suite
                          Definition

                          A suite of tests that all share a common set up, and can be executed as a group.

                          ShortA suite of tests that share a common set up
                          Control0..*
                          TypeBackboneElement
                          Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                          106. TestPlan.suite.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          This element is affected by the following invariants: ele-1
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          108. TestPlan.suite.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          SlicingThis element introduces a set of slices on TestPlan.suite.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 110. TestPlan.suite.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored even if unrecognized
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                            Summarytrue
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content, modifiers
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            112. TestPlan.suite.name
                            Definition

                            The name by which this suite is known by in the test system. The name must be unique in the amongst the suites.

                            ShortThe name of this suite - unique in the TestCases resource
                            Control1..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            114. TestPlan.suite.description
                            Definition

                            Description of what this suite does / why it was defined. This should explain to a tester what they should know when deciding which tests to run.

                            ShortDescription of what this suite does / why it was defined
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            116. TestPlan.suite.mode
                            Definition

                            If this mode is not passed to the runner, then this suite will not be run.

                            ShortMode required to run this suite
                            Control0..1
                            Typecode
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Meaning if MissingIf no modes are listed, the suite is always executed
                            118. TestPlan.suite.input
                            Definition

                            The resources used in the tests in this suite. How exactly they are used depends on the definition of the runner .

                            ShortResources used in the tests in this suite
                            Control0..*
                            TypeBackboneElement
                            Invariantstp-1: Either a file, or a resource, but not both (file.exists() xor resource.exists())
                            ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                            120. TestPlan.suite.input.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            This element is affected by the following invariants: ele-1
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            122. TestPlan.suite.input.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            SlicingThis element introduces a set of slices on TestPlan.suite.input.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 124. TestPlan.suite.input.modifierExtension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                              ShortExtensions that cannot be ignored even if unrecognized
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                              Summarytrue
                              Requirements

                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                              Alternate Namesextensions, user content, modifiers
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              126. TestPlan.suite.input.name
                              Definition

                              A name that identifies this resource. The runner definition defines whether there must be a name, and what names there are.

                              ShortA name for this resource (per runner definition)
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              128. TestPlan.suite.input.file
                              Definition

                              A file containing a resource used in the tests.

                              ShortA file containing a resource used in the tests
                              Comments

                              Filename is relative to the folder/directory containing this TestCases

                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              130. TestPlan.suite.input.resource
                              Definition

                              An inline resource used in the tests. How exactly it is used depends on the definition of the runner.

                              ShortAn inline resource used in the tests
                              Control0..1
                              TypeResource
                              132. TestPlan.suite.input.mode
                              Definition

                              If this mode is not passed to the runner, then this resource will not be used.

                              ShortA mode that must be true for this resource to be used
                              Control0..1
                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Meaning if MissingIf no modes are listed, the resource is always used, unless there is another entry with the same name that is selected by mode
                              134. TestPlan.suite.parameter
                              Definition

                              A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

                              ShortParameter defined by the suite
                              Control0..*
                              TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.parameter
                              136. TestPlan.suite.test
                              Definition

                              An actual test in the test suite.

                              ShortA test in the test suite
                              Control0..*
                              TypeBackboneElement
                              Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                              138. TestPlan.suite.test.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..1
                              This element is affected by the following invariants: ele-1
                              Typeid
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              140. TestPlan.suite.test.extension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                              ShortAdditional content defined by implementations
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              SlicingThis element introduces a set of slices on TestPlan.suite.test.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 142. TestPlan.suite.test.modifierExtension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                ShortExtensions that cannot be ignored even if unrecognized
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                Summarytrue
                                Requirements

                                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                Alternate Namesextensions, user content, modifiers
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                144. TestPlan.suite.test.name
                                Definition

                                The name by which this test is known by in the test system. The name must be unique in the suite.

                                ShortThe name of this test - unique in the suite
                                Control1..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                146. TestPlan.suite.test.description
                                Definition

                                Description of what this test does / why it was defined. This should explain to a tester what they should know when looking at failing test results.

                                ShortDescription of what this test does / why it was defined
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                148. TestPlan.suite.test.operation
                                Definition

                                A code that identifies the operation executed for this test. One of the codes defined in the definition of the runner.

                                ShortOperation that is executed during this test (per definition of runner)
                                Control0..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                150. TestPlan.suite.test.mode
                                Definition

                                If this mode is not passed to the runner, then this test will not be run.

                                ShortMode required to run this test
                                Control0..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Meaning if MissingIf no modes are listed, the test is always executed
                                152. TestPlan.suite.test.parameter
                                Definition

                                A parameter passed to the runner when executing tests. Which parameters are valid, and how exactly the parameter is used are used depends on the definition of the runner.

                                ShortParameter defined by the test
                                Control0..*
                                TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.parameter
                                154. TestPlan.suite.test.input
                                Definition

                                The resources used when executing this test. How exactly they are used depends on the definition of the runner.

                                ShortResources used when executing this test (per runner definition)
                                Control0..*
                                TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite.input
                                156. TestPlan.suite.test.expected
                                Definition

                                Resources expected as output from this test. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner. How exactly it is used depends on the definition of the runner, but the expectation is that these are the expected output, to which the actual output is compared.

                                ShortResources expected as output from this test (per runner definition, often Matchetypes)
                                Control0..*
                                TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite.input
                                158. TestPlan.suite.test.assertion
                                Definition

                                One or more assertions that can be executed against the output of the tests. These may be used with matchetypes to make rules about content the matchetypes leave open.

                                ShortAssertions that can be executed against the output of the tests
                                Control0..*
                                TypeBackboneElement
                                Invariantstp-2: At least an expression or a human readable rule must exist (expression.exists() or human.exists())
                                ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                                160. TestPlan.suite.test.assertion.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                This element is affected by the following invariants: ele-1
                                Typeid
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                162. TestPlan.suite.test.assertion.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                SlicingThis element introduces a set of slices on TestPlan.suite.test.assertion.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 164. TestPlan.suite.test.assertion.modifierExtension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                  ShortExtensions that cannot be ignored even if unrecognized
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                  Control0..*
                                  TypeExtension
                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                  Summarytrue
                                  Requirements

                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                  Alternate Namesextensions, user content, modifiers
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  166. TestPlan.suite.test.assertion.focus
                                  Definition

                                  Resources expected as output from this test. Often, but not always, these resources are Matchetype resources.

                                  ShortWhich output the assertion is tested on (by name, if there is more than one)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  168. TestPlan.suite.test.assertion.severity
                                  Definition

                                  Resources expected as output from this test. Only error and fatal assertions are considered to cause a test to fail. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner.

                                  Shortfatal | error | warning | information | success; fatal+error = fail
                                  Control0..1
                                  BindingThe codes SHALL be taken from IssueSeverity .
                                  (required to http://hl7.org/fhir/ValueSet/issue-severity|5.0.0)

                                  The severity of the assertion

                                  Typecode
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  170. TestPlan.suite.test.assertion.expression
                                  Definition

                                  Resources expected as output from this test. Often, but not always, these resources are Matchetype resources. How exactly it is used depends on the definition of the runner.

                                  ShortTechnical Expression of the assertion
                                  Control0..1
                                  TypeExpression
                                  172. TestPlan.suite.test.assertion.human
                                  Definition

                                  A human readable description of the assertion.

                                  ShortHuman readable description of the assertion
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  174. TestPlan.suite.test.assertion.mode
                                  Definition

                                  If this mode is not passed to the runner, then this assertion will not be used.

                                  ShortA mode that must be true for this assertion to apply
                                  Control0..1
                                  Typecode
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Meaning if MissingIf no modes are listed, the assertion is always used, unless there is another assertion with the same name that is selected by mode
                                  176. TestPlan.suite.suite
                                  Definition

                                  A nested set of tests.

                                  ShortA nested suite of tests
                                  Control0..*
                                  TypeSeettp://hl7.org/fhir/StructureDefinition/TestPlan#TestPlan.suite
                                  178. TestPlan.suite.plan
                                  Definition

                                  A nested set of test plans that run within the context of this suite. Typically, the runner must be the same in the nested test plans.

                                  ShortA nested set of test plans
                                  Comments

                                  This is a reference to allow for direct local file references etc, but since TestPlan is a CanonicalResource, it can also be resolved as a canonical reference.

                                  Control0..*
                                  TypeReference(Test Plan)