English Generated Narrative: StructureDefinition TestCases Name Flags Card. Type Description & Constraints TestCases 0..* Resource Elements defined in Ancestors:id, meta, implicitRules, language Test Suite - set of tests executed by a runner #xD; url ΣC 0..1 uri Canonical identifier for these tests, represented as a URI (globally unique) Constraints: cnl-1 #xD; version Σ 0..1 string Business version of the test set (semver) #xD; name Σ 0..1 string Name for these tests #xD; description Σ 0..1 markdown General Description of these tests #xD; scope 0..* Base The scope - what these test cases are testing #xD; reference 0..1 canonical(ActorDefinition | ImplementationGuide | StructureDefinition) A reference to what is being tested #xD; description 0..1 string Description of what the scope is exists / what is being tested #xD; dependency 0..* Base Test cases that must be passed before these test cases are meaningful to execute #xD; reference 1..1 canonical(Test Cases) The Test Cases #xD; description 0..1 string Description of what the dependency exists / why it was defined #xD; runner 1..1 url URL Documentation for a runner that executes these tests #xD; mode 0..* Base A mode that can be passed to runner - affects test content #xD; code 1..1 string The code that identifies the mode #xD; description 0..1 string Description of what this mode exists / why it was defined #xD; parameter 0..* Base Parameter passed to the runner #xD; name 1..1 string Name of parameter #xD; value[x] 1..1 Value of this parameter #xD; valueString string #xD; valueBoolean boolean #xD; valueInteger integer #xD; valueDecimal decimal #xD; valueDateTime dateTime #xD; valueUri uri #xD; valueCoding Coding #xD; valueQuantity Quantity #xD; valueExpression Expression #xD; mode 0..1 code A mode that must be true for this parameter to be used #xD; suite 0..* Base A suite of tests that share a common set up #xD; name 1..1 string The name of this suite - unique in the TestCases resource #xD; description 0..1 string Description of what this suite does / why it was defined #xD; mode 0..1 code mode required to run this suite #xD; data C 0..* Base Resources used in the tests in this suite Constraints: ts-2 #xD; name 0..1 string A name for this resource (per runner definition) #xD; file 0..1 string A file containing a resource used in the tests #xD; resource 0..1 Resource An inline resource used in the tests #xD; mode 0..1 code A mode that must be true for this resource to be used #xD; parameter 0..* See parameter Parameter passed to the runner #xD; test 0..* Base A test in the test suite #xD; name 1..1 string The name of this test - unique in the suite #xD; description 0..1 string Description of what this test does / why it was defined #xD; operation 0..1 code Operation that is executed during this test (per definition of runner) #xD; mode 0..1 string mode required to run this test #xD; parameter 0..* See parameter #xD; input 0..* See data Resources used when executing this test (per runner definition) #xD; <a href="StructureDefinition-TestCases-definitions.html#TestCases.suite.test.output" title="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">output 0..* See data Resources expected as output from this test (per runner definition, often Matchetypes) #xD; assertion 0..* Base Assertions that can be executed against the output of the tests #xD; focus 0..1 string Which output the assertion is tested on (by name, if there is more than one) #xD; severity 0..1 code Error | Warning | Information; only errors are considered to cause a test to fail Binding: IssueSeverity (required): The severity of the assertion #xD; expression 0..1 Expression Technical Expression of the assertion #xD; human 0..1 string Human readable description of the assertion #xD; mode 0..1 code A mode that must be true for this assertion to apply #xD; suite 0..* See suite A nested suite of tests #xD; cases 0..* Reference(Test Cases), canonical(Test Cases) A nested set of test cases #xD; Documentation for this format Spanish Generated Narrative: StructureDefinition TestCases Name Flags Card. Type Description & Constraints TestCases 0..* Resource Elements defined in Ancestors:id, meta, implicitRules, language Test Suite - set of tests executed by a runner #xD; url ΣC 0..1 uri Canonical identifier for these tests, represented as a URI (globally unique) Constraints: cnl-1 #xD; version Σ 0..1 string Business version of the test set (semver) #xD; name Σ 0..1 string Name for these tests #xD; description Σ 0..1 markdown General Description of these tests #xD; scope 0..* Base The scope - what these test cases are testing #xD; reference 0..1 canonical(ActorDefinition | ImplementationGuide | StructureDefinition) A reference to what is being tested #xD; description 0..1 string Description of what the scope is exists / what is being tested #xD; dependency 0..* Base Test cases that must be passed before these test cases are meaningful to execute #xD; reference 1..1 canonical(Test Cases) The Test Cases #xD; description 0..1 string Description of what the dependency exists / why it was defined #xD; runner 1..1 url URL Documentation for a runner that executes these tests #xD; mode 0..* Base A mode that can be passed to runner - affects test content #xD; code 1..1 string The code that identifies the mode #xD; description 0..1 string Description of what this mode exists / why it was defined #xD; parameter 0..* Base Parameter passed to the runner #xD; name 1..1 string Name of parameter #xD; value[x] 1..1 Value of this parameter #xD; valueString string #xD; valueBoolean boolean #xD; valueInteger integer #xD; valueDecimal decimal #xD; valueDateTime dateTime #xD; valueUri uri #xD; valueCoding Coding #xD; valueQuantity Quantity #xD; valueExpression Expression #xD; mode 0..1 code A mode that must be true for this parameter to be used #xD; suite 0..* Base A suite of tests that share a common set up #xD; name 1..1 string The name of this suite - unique in the TestCases resource #xD; description 0..1 string Description of what this suite does / why it was defined #xD; mode 0..1 code mode required to run this suite #xD; data C 0..* Base Resources used in the tests in this suite Constraints: ts-2 #xD; name 0..1 string A name for this resource (per runner definition) #xD; file 0..1 string A file containing a resource used in the tests #xD; resource 0..1 Resource An inline resource used in the tests #xD; mode 0..1 code A mode that must be true for this resource to be used #xD; parameter 0..* See parameter Parameter passed to the runner #xD; test 0..* Base A test in the test suite #xD; name 1..1 string The name of this test - unique in the suite #xD; description 0..1 string Description of what this test does / why it was defined #xD; operation 0..1 code Operation that is executed during this test (per definition of runner) #xD; mode 0..1 string mode required to run this test #xD; parameter 0..* See parameter #xD; input 0..* See data Resources used when executing this test (per runner definition) #xD; <a href="StructureDefinition-TestCases-definitions.html#TestCases.suite.test.output" title="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">output 0..* See data Resources expected as output from this test (per runner definition, often Matchetypes) #xD; assertion 0..* Base Assertions that can be executed against the output of the tests #xD; focus 0..1 string Which output the assertion is tested on (by name, if there is more than one) #xD; severity 0..1 code Error | Warning | Information; only errors are considered to cause a test to fail Binding: IssueSeverity (required): The severity of the assertion #xD; expression 0..1 Expression Technical Expression of the assertion #xD; human 0..1 string Human readable description of the assertion #xD; mode 0..1 code A mode that must be true for this assertion to apply #xD; suite 0..* See suite A nested suite of tests #xD; cases 0..* Reference(Test Cases), canonical(Test Cases) A nested set of test cases #xD; Documentation for this format
A standard format for test cases used throughout the FHIR ecosystem
Test Suite - set of tests executed by a runner
A set of tests that are executed by some runner to test the functionality of a tool in the FHIR ecosystem
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
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).
Canonical identifier for these tests, represented as a URI (globally unique)
An absolute URI that is used to identify test tests.
URL should not contain | or # - these characters make processing canonical references problematic
Business version of the test set (semver)
The identifier that is used to identify this version of these tests. Version must use SemVer
A natural language name identifying the tests. This name should be usable as an identifier for the module by machine processing applications such as code generation.
The scope - what these test cases are testing
The scope indicates what kind of systems these test cases are intended to test
Description of what the scope is exists / what is being tested
Description of what the scope is does / what is being tested
Test cases that must be passed before these test cases are meaningful to execute
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
Description of what the dependency exists / why it was defined
Description of what this mode does / why it was defined. This should explain to a tester why the
URL Documentation for a runner that executes these tests
URL of documentation that explains how a runner would read these tests, and use them to actually test out a tool.
A mode that can be passed to runner - affects test content
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)
The code by which the mode is identified when passed to runner
Description of what this mode exists / why it was defined
Description of what this mode does / why it was defined. This should explain to a tester when they should use the mode
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
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
A mode that must be true for this parameter to be used
If this mode is not passed to the runner, then this parameter will not be used
If no modes are listed, the parameter is always used, unless there is a parameter with the same name that is selected by mode
A suite of tests that share a common set up
A suite of tests that all share a common set up, and can be executed as a group
The name of this suite - unique in the TestCases resource
The name by which this suite is known by in the test system. The name must be unique in the amongst the suites
Description of what this suite does / why it was defined
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
If this mode is not passed to the runner, then this suite will not be run
If no modes are listed, the suite is always executed
Resources used in the tests in this suite
The resources used in the tests in this suite. How exactly they are used depends on the definition of the runner
Either a file, or a resource, but not both
A name for this resource (per runner definition)
A name that identifies this resource. The runner definition defines whether there must be a name, and what names there are
A file containing a resource used in the tests
Filename is relative to the folder/directory containing this TestCases
An inline resource used in the tests. How exactly it is used depends on the definition of the runner.
A mode that must be true for this resource to be used
If this mode is not passed to the runner, then this resource will not be used
If no modes are listed, the resource is always used, unless there is another entry with the same name that is selected by mode
The name of this test - unique in the suite
The name by which this test is known by in the test system. The name must be unique in the suite
Description of what this test does / why it was defined
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
Operation that is executed during this test (per definition of runner)
A code that identifies the operation executed for this test. One of the codes defined in the definition of the runner
If this mode is not passed to the runner, then this test will not be run
If no modes are listed, the test is always executed
Resources used when executing this test (per runner definition)
The resources used when executing this test. How exactly they are used depends on the definition of the runner.
Resources expected as output from this test (per runner definition, often Matchetypes)
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
Assertions that can be executed against the output of the tests
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
Which output the assertion is tested on (by name, if there is more than one)
Resources expected as output from this test. Often, but not always, these resources are Matchetype resources
Error | Warning | Information; only errors are considered to cause a test to fail
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
Human readable description of the assertion
A human readable description of the assertion.
A mode that must be true for this assertion to apply
If this mode is not passed to the runner, then this assertion will not be used
If no modes are listed, the assertion is always used, unless there is another assertion with the same name that is selected by mode
A nested set of test cases. Typically, the runner must be the same in the nested test cases