7.3 Resource TestPlan - Content

Name	Flags	Card.	Type	Description & Constraints
TestPlan	D		DomainResource	Description of intented testing + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource
url	ΣC	0..1	uri	Canonical identifier for this test plan, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic
identifier	Σ	0..*	Identifier	Business identifier for the test plan
version	Σ	0..1	string	Business version of the test plan
versionAlgorithm[x]	Σ	0..1		How to compare versions Binding: Version Algorithm (Extensible)
versionAlgorithmString			string
versionAlgorithmCoding			Coding
name	ΣC	0..1	string	Name for this test plan (computer friendly)
title	T	0..1	string	Name for this test plan (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (Required)
experimental	Σ	0..1	boolean	For testing only - never for real usage
date	Σ	0..1	dateTime	Date last changed
publisher	ΣT	0..1	string	Name of the publisher/steward (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	T	0..1	markdown	Natural language description of the test plan
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	ΣXD	0..*	CodeableConcept	Intended jurisdiction where the test plan applies (if applicable) Binding: Jurisdiction ValueSet (Extensible)
purpose	T	0..1	markdown	Why this test plan is defined
copyright	T	0..1	markdown	Use and/or publishing restrictions
copyrightLabel	T	0..1	string	Copyright holder and year(s)
category		0..*	CodeableConcept	The category of the Test Plan - can be acceptance, unit, performance Binding: Test Script Scope Phase Type (Example)
scope		0..*	BackboneElement	What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference
artifact[x]		1..1		The specific conformance artifact, or narrative criteria, or an external reference being tested
artifactCanonical			canonical(ActivityDefinition | ActorDefinition | CapabilityStatement | ImplementationGuide | Library | Measure | MessageDefinition | OperationDefinition | PlanDefinition | Questionnaire | Requirements | StructureDefinition | SearchParameter | StructureMap | SubscriptionTopic)
artifactMarkdown			markdown
artifactUri			uri
testTools		0..1	markdown	A description of test tools to be used in the test plan - narrative for now
dependency		0..*	BackboneElement	The required criteria to execute the test plan - e.g. preconditions, previous tests
description		0..1	markdown	Description of the dependency criterium
predecessor		0..1	Reference(TestPlan)	Link to predecessor test plans
exitCriteria		0..1	markdown	The threshold or criteria for the test plan to be considered successfully executed - narrative
testCase		0..*	BackboneElement	The test cases that constitute this plan
key		1..1	id	Key that identifies this test case
description		0..1	markdown	Narrative description explaining the purpose of this test case
sequence		0..1	integer	Sequence of test case in the test plan
scope		0..*	BackboneElement	The scope or artifact covered by the case
artifact[x]		1..1		The specific conformance artifact, or narrative criteria, or an external reference covered by the case
artifactCanonical			canonical(ActivityDefinition | ActorDefinition | CapabilityStatement | ImplementationGuide | Library | Measure | MessageDefinition | OperationDefinition | PlanDefinition | Questionnaire | Requirements | StructureDefinition | SearchParameter | StructureMap | SubscriptionTopic)
artifactMarkdown			markdown
artifactUri			uri
requirement		0..*	BackboneElement	Links or references to the testing requirements
reference		1..1	canonical(Requirements)	Canonical reference to the Requirements instance
key		1..1	id	Requirements statement key identifier
dependency		0..*	BackboneElement	Required criteria to execute the test case
description		0..1	markdown	Description of the criteria
reference		0..1	canonical(TestPlan)	Canonical reference to the TestPlan dependency instance
key		0..1	id	TestPlan dependency instance testCase key identifier
testRun		0..*	BackboneElement	The actual test to be executed
narrative		0..1	markdown	The narrative description of the tests
script		0..1	BackboneElement	The test cases in a structured language
language		0..1	CodeableConcept	The structured language for the test case script Binding: TestPlanScriptLanguage (Example)
source[x]		0..1		The actual content of the script, reference to test resource (TestScript) or externally defined content
sourceString			string
sourceAttachment			Attachment
sourceReference			Reference(Any)
testData		0..*	BackboneElement	The test data used in the test case
type		1..1	Coding	The type of test data description, e.g. 'synthea'
content		0..1	Reference(Any)	The actual test resources when they exist
source[x]		0..1		Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc
sourceString			string
sourceUri			uri
sourceReference			Reference(Any)
assertion		0..*	BackboneElement	Test assertions or expectations
type		0..*	CodeableConcept	The expected outcome for this assertion Binding: TestPlanAssertionType (Example)
object		0..*	CodeableReference(Any)	The focus or object of the assertion
result		0..*	CodeableReference(Any)	The actual result assertion
testCase		0..*	see testCase	Nested test cases
Documentation for this format

See the Extensions for this resource

<TestPlan xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this test plan, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Business identifier for the test plan --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the test plan -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this test plan (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this test plan (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the test plan -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction where the test plan applies (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this test plan is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <category><!-- 0..* CodeableConcept The category of the Test Plan - can be acceptance, unit, performance --></category>
 <scope>  <!-- 0..* What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference -->
  <artifact[x]><!-- 1..1 canonical(ActivityDefinition|ActorDefinition|
    CapabilityStatement|ImplementationGuide|Library|Measure|MessageDefinition|
    OperationDefinition|PlanDefinition|Questionnaire|Requirements|
    SearchParameter|StructureDefinition|StructureMap|SubscriptionTopic)|markdown|
    uri The specific conformance artifact, or narrative criteria, or an external reference being tested --></artifact[x]>
 </scope>
 <testTools value="[markdown]"/><!-- 0..1 A description of test tools to be used in the test plan - narrative for now -->
 <dependency>  <!-- 0..* The required criteria to execute the test plan - e.g. preconditions, previous tests -->
  <description value="[markdown]"/><!-- 0..1 Description of the dependency criterium -->
  <predecessor><!-- 0..1 Reference(TestPlan) Link to predecessor test plans --></predecessor>
 </dependency>
 <exitCriteria value="[markdown]"/><!-- 0..1 The threshold or criteria for the test plan to be considered successfully executed - narrative -->
 <testCase>  <!-- 0..* The test cases that constitute this plan -->
  <key value="[id]"/><!-- 1..1 Key that identifies this test case -->
  <description value="[markdown]"/><!-- 0..1 Narrative description explaining the purpose of this test case -->
  <sequence value="[integer]"/><!-- 0..1 Sequence of test case in the test plan -->
  <scope>  <!-- 0..* The scope or artifact covered by the case -->
   <artifact[x]><!-- 1..1 canonical(ActivityDefinition|ActorDefinition|
     CapabilityStatement|ImplementationGuide|Library|Measure|MessageDefinition|
     OperationDefinition|PlanDefinition|Questionnaire|Requirements|
     SearchParameter|StructureDefinition|StructureMap|SubscriptionTopic)|
     markdown|uri The specific conformance artifact, or narrative criteria, or an external reference covered by the case --></artifact[x]>
  </scope>
  <requirement>  <!-- 0..* Links or references to the testing requirements -->
   <reference><!-- 1..1 canonical(Requirements) Canonical reference to the Requirements instance --></reference>
   <key value="[id]"/><!-- 1..1 Requirements statement key identifier -->
  </requirement>
  <dependency>  <!-- 0..* Required criteria to execute the test case -->
   <description value="[markdown]"/><!-- 0..1 Description of the criteria -->
   <reference><!-- 0..1 canonical(TestPlan) Canonical reference to the TestPlan dependency instance --></reference>
   <key value="[id]"/><!-- 0..1 TestPlan dependency instance testCase key identifier -->
  </dependency>
  <testRun>  <!-- 0..* The actual test to be executed -->
   <narrative value="[markdown]"/><!-- 0..1 The narrative description of the tests -->
   <script>  <!-- 0..1 The test cases in a structured language -->
    <language><!-- 0..1 CodeableConcept The structured language for the test case script --></language>
    <source[x]><!-- 0..1 string|Attachment|Reference(Any) The actual content of the script, reference to test resource (TestScript) or externally defined content --></source[x]>
   </script>
  </testRun>
  <testData>  <!-- 0..* The test data used in the test case -->
   <type><!-- 1..1 Coding The type of test data description, e.g. 'synthea' --></type>
   <content><!-- 0..1 Reference(Any) The actual test resources when they exist --></content>
   <source[x]><!-- 0..1 string|uri|Reference(Any) Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc --></source[x]>
  </testData>
  <assertion>  <!-- 0..* Test assertions or expectations -->
   <type><!-- 0..* CodeableConcept The expected outcome for this assertion --></type>
   <object><!-- 0..* CodeableReference(Any) The focus or object of the assertion --></object>
   <result><!-- 0..* CodeableReference(Any) The actual result assertion --></result>
  </assertion>
  <testCase><!-- 0..* Content as for TestPlan.testCase Nested test cases --></testCase>
 </testCase>
</TestPlan>

{
  "resourceType" : "TestPlan",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this test plan, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Business identifier for the test plan
  "version" : "<string>", // Business version of the test plan
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this test plan (computer friendly)
  "title" : "<string>", // Name for this test plan (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing only - never for real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the test plan
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction where the test plan applies (if applicable)
  "purpose" : "<markdown>", // Why this test plan is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "category" : [{ CodeableConcept }], // The category of the Test Plan - can be acceptance, unit, performance
  "scope" : [{ // What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference
    // artifact[x]: 
      The specific conformance artifact, or narrative criteria, or an external reference being tested. One of these 3:
    "artifactCanonical" : "<canonical(ActivityDefinition|ActorDefinition|CapabilityStatement|ImplementationGuide|Library|Measure|MessageDefinition|OperationDefinition|PlanDefinition|Questionnaire|Requirements|StructureDefinition|SearchParameter|StructureMap|SubscriptionTopic)>",
    "artifactMarkdown" : "<markdown>",
    "artifactUri" : "<uri>"
  }],
  "testTools" : "<markdown>", // A description of test tools to be used in the test plan - narrative for now
  "dependency" : [{ // The required criteria to execute the test plan - e.g. preconditions, previous tests
    "description" : "<markdown>", // Description of the dependency criterium
    "predecessor" : { Reference(TestPlan) } // Link to predecessor test plans
  }],
  "exitCriteria" : "<markdown>", // The threshold or criteria for the test plan to be considered successfully executed - narrative
  "testCase" : [{ // The test cases that constitute this plan
    "key" : "<id>", // R!  Key that identifies this test case
    "description" : "<markdown>", // Narrative description explaining the purpose of this test case
    "sequence" : <integer>, // Sequence of test case in the test plan
    "scope" : [{ // The scope or artifact covered by the case
      // artifact[x]: 
       The specific conformance artifact, or narrative criteria, or an external reference covered by the case. One of these 3:
      "artifactCanonical" : "<canonical(ActivityDefinition|ActorDefinition|CapabilityStatement|ImplementationGuide|Library|Measure|MessageDefinition|OperationDefinition|PlanDefinition|Questionnaire|Requirements|StructureDefinition|SearchParameter|StructureMap|SubscriptionTopic)>",
      "artifactMarkdown" : "<markdown>",
      "artifactUri" : "<uri>"
    }],
    "requirement" : [{ // Links or references to the testing requirements
      "reference" : "<canonical(Requirements)>", // R!  Canonical reference to the Requirements instance
      "key" : "<id>" // R!  Requirements statement key identifier
    }],
    "dependency" : [{ // Required criteria to execute the test case
      "description" : "<markdown>", // Description of the criteria
      "reference" : "<canonical(TestPlan)>", // Canonical reference to the TestPlan dependency instance
      "key" : "<id>" // TestPlan dependency instance testCase key identifier
    }],
    "testRun" : [{ // The actual test to be executed
      "narrative" : "<markdown>", // The narrative description of the tests
      "script" : { // The test cases in a structured language
        "language" : { CodeableConcept }, // The structured language for the test case script
        // source[x]: 
        The actual content of the script, reference to test resource (TestScript) or externally defined content. One of these 3:
        "sourceString" : "<string>",
        "sourceAttachment" : { Attachment },
        "sourceReference" : { Reference(Any) }
      }
    }],
    "testData" : [{ // The test data used in the test case
      "type" : { Coding }, // R!  The type of test data description, e.g. 'synthea'
      "content" : { Reference(Any) }, // The actual test resources when they exist
      // source[x]: 
       Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc. One of these 3:
      "sourceString" : "<string>",
      "sourceUri" : "<uri>",
      "sourceReference" : { Reference(Any) }
    }],
    "assertion" : [{ // Test assertions or expectations
      "type" : [{ CodeableConcept }], // The expected outcome for this assertion
      "object" : [{ CodeableReference(Any) }], // The focus or object of the assertion
      "result" : [{ CodeableReference(Any) }] // The actual result assertion
    }],
    "testCase" : [{ Content as for TestPlan.testCase }] // Nested test cases
  }]
}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:TestPlan;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this test plan, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for the test plan
  fhir:version [ string ] ; # 0..1 Business version of the test plan
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this test plan (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this test plan (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the test plan
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction where the test plan applies (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this test plan is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* The category of the Test Plan - can be acceptance, unit, performance
  fhir:scope ( [ # 0..* What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference
    # artifact[x] : 1..1 The specific conformance artifact, or narrative criteria, or an external reference being tested. One of these 3
      fhir:artifact [  a fhir:canonical ; canonical(ActivityDefinition|ActorDefinition|CapabilityStatement|ImplementationGuide|
  Library|Measure|MessageDefinition|OperationDefinition|PlanDefinition|
  Questionnaire|Requirements|SearchParameter|StructureDefinition|StructureMap|
  SubscriptionTopic) ]
      fhir:artifact [  a fhir:markdown ; markdown ]
      fhir:artifact [  a fhir:uri ; uri ]
  ] ... ) ;
  fhir:testTools [ markdown ] ; # 0..1 A description of test tools to be used in the test plan - narrative for now
  fhir:dependency ( [ # 0..* The required criteria to execute the test plan - e.g. preconditions, previous tests
    fhir:description [ markdown ] ; # 0..1 Description of the dependency criterium
    fhir:predecessor [ Reference(TestPlan) ] ; # 0..1 Link to predecessor test plans
  ] ... ) ;
  fhir:exitCriteria [ markdown ] ; # 0..1 The threshold or criteria for the test plan to be considered successfully executed - narrative
  fhir:testCase ( [ # 0..* The test cases that constitute this plan
    fhir:key [ id ] ; # 1..1 Key that identifies this test case
    fhir:description [ markdown ] ; # 0..1 Narrative description explaining the purpose of this test case
    fhir:sequence [ integer ] ; # 0..1 Sequence of test case in the test plan
    fhir:scope ( [ # 0..* The scope or artifact covered by the case
      # artifact[x] : 1..1 The specific conformance artifact, or narrative criteria, or an external reference covered by the case. One of these 3
        fhir:artifact [  a fhir:canonical ; canonical(ActivityDefinition|ActorDefinition|CapabilityStatement|ImplementationGuide|
  Library|Measure|MessageDefinition|OperationDefinition|PlanDefinition|
  Questionnaire|Requirements|SearchParameter|StructureDefinition|StructureMap|
  SubscriptionTopic) ]
        fhir:artifact [  a fhir:markdown ; markdown ]
        fhir:artifact [  a fhir:uri ; uri ]
    ] ... ) ;
    fhir:requirement ( [ # 0..* Links or references to the testing requirements
      fhir:reference [ canonical(Requirements) ] ; # 1..1 Canonical reference to the Requirements instance
      fhir:key [ id ] ; # 1..1 Requirements statement key identifier
    ] ... ) ;
    fhir:dependency ( [ # 0..* Required criteria to execute the test case
      fhir:description [ markdown ] ; # 0..1 Description of the criteria
      fhir:reference [ canonical(TestPlan) ] ; # 0..1 Canonical reference to the TestPlan dependency instance
      fhir:key [ id ] ; # 0..1 TestPlan dependency instance testCase key identifier
    ] ... ) ;
    fhir:testRun ( [ # 0..* The actual test to be executed
      fhir:narrative [ markdown ] ; # 0..1 The narrative description of the tests
      fhir:script [ # 0..1 The test cases in a structured language
        fhir:language [ CodeableConcept ] ; # 0..1 The structured language for the test case script
        # source[x] : 0..1 The actual content of the script, reference to test resource (TestScript) or externally defined content. One of these 3
          fhir:source [  a fhir:string ; string ]
          fhir:source [  a fhir:Attachment ; Attachment ]
          fhir:source [  a fhir:Reference ; Reference(Any) ]
      ] ;
    ] ... ) ;
    fhir:testData ( [ # 0..* The test data used in the test case
      fhir:type [ Coding ] ; # 1..1 The type of test data description, e.g. 'synthea'
      fhir:content [ Reference(Any) ] ; # 0..1 The actual test resources when they exist
      # source[x] : 0..1 Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc. One of these 3
        fhir:source [  a fhir:string ; string ]
        fhir:source [  a fhir:uri ; uri ]
        fhir:source [  a fhir:Reference ; Reference(Any) ]
    ] ... ) ;
    fhir:assertion ( [ # 0..* Test assertions or expectations
      fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* The expected outcome for this assertion
      fhir:object  ( [ CodeableReference(Any) ] ... ) ; # 0..* The focus or object of the assertion
      fhir:result  ( [ CodeableReference(Any) ] ... ) ; # 0..* The actual result assertion
    ] ... ) ;
    fhir:testCase  ( [ See TestPlan.testCase ] ... ) ; # 0..* Nested test cases
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Name	Flags	Card.	Type	Description & Constraints
TestPlan	D		DomainResource	Description of intented testing + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource
url	ΣC	0..1	uri	Canonical identifier for this test plan, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic
identifier	Σ	0..*	Identifier	Business identifier for the test plan
version	Σ	0..1	string	Business version of the test plan
versionAlgorithm[x]	Σ	0..1		How to compare versions Binding: Version Algorithm (Extensible)
versionAlgorithmString			string
versionAlgorithmCoding			Coding
name	ΣC	0..1	string	Name for this test plan (computer friendly)
title	T	0..1	string	Name for this test plan (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (Required)
experimental	Σ	0..1	boolean	For testing only - never for real usage
date	Σ	0..1	dateTime	Date last changed
publisher	ΣT	0..1	string	Name of the publisher/steward (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	T	0..1	markdown	Natural language description of the test plan
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	ΣXD	0..*	CodeableConcept	Intended jurisdiction where the test plan applies (if applicable) Binding: Jurisdiction ValueSet (Extensible)
purpose	T	0..1	markdown	Why this test plan is defined
copyright	T	0..1	markdown	Use and/or publishing restrictions
copyrightLabel	T	0..1	string	Copyright holder and year(s)
category		0..*	CodeableConcept	The category of the Test Plan - can be acceptance, unit, performance Binding: Test Script Scope Phase Type (Example)
scope		0..*	BackboneElement	What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference
artifact[x]		1..1		The specific conformance artifact, or narrative criteria, or an external reference being tested
artifactCanonical			canonical(ActivityDefinition | ActorDefinition | CapabilityStatement | ImplementationGuide | Library | Measure | MessageDefinition | OperationDefinition | PlanDefinition | Questionnaire | Requirements | StructureDefinition | SearchParameter | StructureMap | SubscriptionTopic)
artifactMarkdown			markdown
artifactUri			uri
testTools		0..1	markdown	A description of test tools to be used in the test plan - narrative for now
dependency		0..*	BackboneElement	The required criteria to execute the test plan - e.g. preconditions, previous tests
description		0..1	markdown	Description of the dependency criterium
predecessor		0..1	Reference(TestPlan)	Link to predecessor test plans
exitCriteria		0..1	markdown	The threshold or criteria for the test plan to be considered successfully executed - narrative
testCase		0..*	BackboneElement	The test cases that constitute this plan
key		1..1	id	Key that identifies this test case
description		0..1	markdown	Narrative description explaining the purpose of this test case
sequence		0..1	integer	Sequence of test case in the test plan
scope		0..*	BackboneElement	The scope or artifact covered by the case
artifact[x]		1..1		The specific conformance artifact, or narrative criteria, or an external reference covered by the case
artifactCanonical			canonical(ActivityDefinition | ActorDefinition | CapabilityStatement | ImplementationGuide | Library | Measure | MessageDefinition | OperationDefinition | PlanDefinition | Questionnaire | Requirements | StructureDefinition | SearchParameter | StructureMap | SubscriptionTopic)
artifactMarkdown			markdown
artifactUri			uri
requirement		0..*	BackboneElement	Links or references to the testing requirements
reference		1..1	canonical(Requirements)	Canonical reference to the Requirements instance
key		1..1	id	Requirements statement key identifier
dependency		0..*	BackboneElement	Required criteria to execute the test case
description		0..1	markdown	Description of the criteria
reference		0..1	canonical(TestPlan)	Canonical reference to the TestPlan dependency instance
key		0..1	id	TestPlan dependency instance testCase key identifier
testRun		0..*	BackboneElement	The actual test to be executed
narrative		0..1	markdown	The narrative description of the tests
script		0..1	BackboneElement	The test cases in a structured language
language		0..1	CodeableConcept	The structured language for the test case script Binding: TestPlanScriptLanguage (Example)
source[x]		0..1		The actual content of the script, reference to test resource (TestScript) or externally defined content
sourceString			string
sourceAttachment			Attachment
sourceReference			Reference(Any)
testData		0..*	BackboneElement	The test data used in the test case
type		1..1	Coding	The type of test data description, e.g. 'synthea'
content		0..1	Reference(Any)	The actual test resources when they exist
source[x]		0..1		Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc
sourceString			string
sourceUri			uri
sourceReference			Reference(Any)
assertion		0..*	BackboneElement	Test assertions or expectations
type		0..*	CodeableConcept	The expected outcome for this assertion Binding: TestPlanAssertionType (Example)
object		0..*	CodeableReference(Any)	The focus or object of the assertion
result		0..*	CodeableReference(Any)	The actual result assertion
testCase		0..*	see testCase	Nested test cases
Documentation for this format

See the Extensions for this resource

<TestPlan xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this test plan, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Business identifier for the test plan --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the test plan -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this test plan (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this test plan (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the test plan -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction where the test plan applies (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this test plan is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <category><!-- 0..* CodeableConcept The category of the Test Plan - can be acceptance, unit, performance --></category>
 <scope>  <!-- 0..* What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference -->
  <artifact[x]><!-- 1..1 canonical(ActivityDefinition|ActorDefinition|
    CapabilityStatement|ImplementationGuide|Library|Measure|MessageDefinition|
    OperationDefinition|PlanDefinition|Questionnaire|Requirements|
    SearchParameter|StructureDefinition|StructureMap|SubscriptionTopic)|markdown|
    uri The specific conformance artifact, or narrative criteria, or an external reference being tested --></artifact[x]>
 </scope>
 <testTools value="[markdown]"/><!-- 0..1 A description of test tools to be used in the test plan - narrative for now -->
 <dependency>  <!-- 0..* The required criteria to execute the test plan - e.g. preconditions, previous tests -->
  <description value="[markdown]"/><!-- 0..1 Description of the dependency criterium -->
  <predecessor><!-- 0..1 Reference(TestPlan) Link to predecessor test plans --></predecessor>
 </dependency>
 <exitCriteria value="[markdown]"/><!-- 0..1 The threshold or criteria for the test plan to be considered successfully executed - narrative -->
 <testCase>  <!-- 0..* The test cases that constitute this plan -->
  <key value="[id]"/><!-- 1..1 Key that identifies this test case -->
  <description value="[markdown]"/><!-- 0..1 Narrative description explaining the purpose of this test case -->
  <sequence value="[integer]"/><!-- 0..1 Sequence of test case in the test plan -->
  <scope>  <!-- 0..* The scope or artifact covered by the case -->
   <artifact[x]><!-- 1..1 canonical(ActivityDefinition|ActorDefinition|
     CapabilityStatement|ImplementationGuide|Library|Measure|MessageDefinition|
     OperationDefinition|PlanDefinition|Questionnaire|Requirements|
     SearchParameter|StructureDefinition|StructureMap|SubscriptionTopic)|
     markdown|uri The specific conformance artifact, or narrative criteria, or an external reference covered by the case --></artifact[x]>
  </scope>
  <requirement>  <!-- 0..* Links or references to the testing requirements -->
   <reference><!-- 1..1 canonical(Requirements) Canonical reference to the Requirements instance --></reference>
   <key value="[id]"/><!-- 1..1 Requirements statement key identifier -->
  </requirement>
  <dependency>  <!-- 0..* Required criteria to execute the test case -->
   <description value="[markdown]"/><!-- 0..1 Description of the criteria -->
   <reference><!-- 0..1 canonical(TestPlan) Canonical reference to the TestPlan dependency instance --></reference>
   <key value="[id]"/><!-- 0..1 TestPlan dependency instance testCase key identifier -->
  </dependency>
  <testRun>  <!-- 0..* The actual test to be executed -->
   <narrative value="[markdown]"/><!-- 0..1 The narrative description of the tests -->
   <script>  <!-- 0..1 The test cases in a structured language -->
    <language><!-- 0..1 CodeableConcept The structured language for the test case script --></language>
    <source[x]><!-- 0..1 string|Attachment|Reference(Any) The actual content of the script, reference to test resource (TestScript) or externally defined content --></source[x]>
   </script>
  </testRun>
  <testData>  <!-- 0..* The test data used in the test case -->
   <type><!-- 1..1 Coding The type of test data description, e.g. 'synthea' --></type>
   <content><!-- 0..1 Reference(Any) The actual test resources when they exist --></content>
   <source[x]><!-- 0..1 string|uri|Reference(Any) Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc --></source[x]>
  </testData>
  <assertion>  <!-- 0..* Test assertions or expectations -->
   <type><!-- 0..* CodeableConcept The expected outcome for this assertion --></type>
   <object><!-- 0..* CodeableReference(Any) The focus or object of the assertion --></object>
   <result><!-- 0..* CodeableReference(Any) The actual result assertion --></result>
  </assertion>
  <testCase><!-- 0..* Content as for TestPlan.testCase Nested test cases --></testCase>
 </testCase>
</TestPlan>

{
  "resourceType" : "TestPlan",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this test plan, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Business identifier for the test plan
  "version" : "<string>", // Business version of the test plan
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this test plan (computer friendly)
  "title" : "<string>", // Name for this test plan (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing only - never for real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the test plan
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction where the test plan applies (if applicable)
  "purpose" : "<markdown>", // Why this test plan is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "category" : [{ CodeableConcept }], // The category of the Test Plan - can be acceptance, unit, performance
  "scope" : [{ // What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference
    // artifact[x]: 
      The specific conformance artifact, or narrative criteria, or an external reference being tested. One of these 3:
    "artifactCanonical" : "<canonical(ActivityDefinition|ActorDefinition|CapabilityStatement|ImplementationGuide|Library|Measure|MessageDefinition|OperationDefinition|PlanDefinition|Questionnaire|Requirements|StructureDefinition|SearchParameter|StructureMap|SubscriptionTopic)>",
    "artifactMarkdown" : "<markdown>",
    "artifactUri" : "<uri>"
  }],
  "testTools" : "<markdown>", // A description of test tools to be used in the test plan - narrative for now
  "dependency" : [{ // The required criteria to execute the test plan - e.g. preconditions, previous tests
    "description" : "<markdown>", // Description of the dependency criterium
    "predecessor" : { Reference(TestPlan) } // Link to predecessor test plans
  }],
  "exitCriteria" : "<markdown>", // The threshold or criteria for the test plan to be considered successfully executed - narrative
  "testCase" : [{ // The test cases that constitute this plan
    "key" : "<id>", // R!  Key that identifies this test case
    "description" : "<markdown>", // Narrative description explaining the purpose of this test case
    "sequence" : <integer>, // Sequence of test case in the test plan
    "scope" : [{ // The scope or artifact covered by the case
      // artifact[x]: 
       The specific conformance artifact, or narrative criteria, or an external reference covered by the case. One of these 3:
      "artifactCanonical" : "<canonical(ActivityDefinition|ActorDefinition|CapabilityStatement|ImplementationGuide|Library|Measure|MessageDefinition|OperationDefinition|PlanDefinition|Questionnaire|Requirements|StructureDefinition|SearchParameter|StructureMap|SubscriptionTopic)>",
      "artifactMarkdown" : "<markdown>",
      "artifactUri" : "<uri>"
    }],
    "requirement" : [{ // Links or references to the testing requirements
      "reference" : "<canonical(Requirements)>", // R!  Canonical reference to the Requirements instance
      "key" : "<id>" // R!  Requirements statement key identifier
    }],
    "dependency" : [{ // Required criteria to execute the test case
      "description" : "<markdown>", // Description of the criteria
      "reference" : "<canonical(TestPlan)>", // Canonical reference to the TestPlan dependency instance
      "key" : "<id>" // TestPlan dependency instance testCase key identifier
    }],
    "testRun" : [{ // The actual test to be executed
      "narrative" : "<markdown>", // The narrative description of the tests
      "script" : { // The test cases in a structured language
        "language" : { CodeableConcept }, // The structured language for the test case script
        // source[x]: 
        The actual content of the script, reference to test resource (TestScript) or externally defined content. One of these 3:
        "sourceString" : "<string>",
        "sourceAttachment" : { Attachment },
        "sourceReference" : { Reference(Any) }
      }
    }],
    "testData" : [{ // The test data used in the test case
      "type" : { Coding }, // R!  The type of test data description, e.g. 'synthea'
      "content" : { Reference(Any) }, // The actual test resources when they exist
      // source[x]: 
       Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc. One of these 3:
      "sourceString" : "<string>",
      "sourceUri" : "<uri>",
      "sourceReference" : { Reference(Any) }
    }],
    "assertion" : [{ // Test assertions or expectations
      "type" : [{ CodeableConcept }], // The expected outcome for this assertion
      "object" : [{ CodeableReference(Any) }], // The focus or object of the assertion
      "result" : [{ CodeableReference(Any) }] // The actual result assertion
    }],
    "testCase" : [{ Content as for TestPlan.testCase }] // Nested test cases
  }]
}

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:TestPlan;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this test plan, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for the test plan
  fhir:version [ string ] ; # 0..1 Business version of the test plan
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this test plan (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this test plan (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the test plan
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction where the test plan applies (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this test plan is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* The category of the Test Plan - can be acceptance, unit, performance
  fhir:scope ( [ # 0..* What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference
    # artifact[x] : 1..1 The specific conformance artifact, or narrative criteria, or an external reference being tested. One of these 3
      fhir:artifact [  a fhir:canonical ; canonical(ActivityDefinition|ActorDefinition|CapabilityStatement|ImplementationGuide|
  Library|Measure|MessageDefinition|OperationDefinition|PlanDefinition|
  Questionnaire|Requirements|SearchParameter|StructureDefinition|StructureMap|
  SubscriptionTopic) ]
      fhir:artifact [  a fhir:markdown ; markdown ]
      fhir:artifact [  a fhir:uri ; uri ]
  ] ... ) ;
  fhir:testTools [ markdown ] ; # 0..1 A description of test tools to be used in the test plan - narrative for now
  fhir:dependency ( [ # 0..* The required criteria to execute the test plan - e.g. preconditions, previous tests
    fhir:description [ markdown ] ; # 0..1 Description of the dependency criterium
    fhir:predecessor [ Reference(TestPlan) ] ; # 0..1 Link to predecessor test plans
  ] ... ) ;
  fhir:exitCriteria [ markdown ] ; # 0..1 The threshold or criteria for the test plan to be considered successfully executed - narrative
  fhir:testCase ( [ # 0..* The test cases that constitute this plan
    fhir:key [ id ] ; # 1..1 Key that identifies this test case
    fhir:description [ markdown ] ; # 0..1 Narrative description explaining the purpose of this test case
    fhir:sequence [ integer ] ; # 0..1 Sequence of test case in the test plan
    fhir:scope ( [ # 0..* The scope or artifact covered by the case
      # artifact[x] : 1..1 The specific conformance artifact, or narrative criteria, or an external reference covered by the case. One of these 3
        fhir:artifact [  a fhir:canonical ; canonical(ActivityDefinition|ActorDefinition|CapabilityStatement|ImplementationGuide|
  Library|Measure|MessageDefinition|OperationDefinition|PlanDefinition|
  Questionnaire|Requirements|SearchParameter|StructureDefinition|StructureMap|
  SubscriptionTopic) ]
        fhir:artifact [  a fhir:markdown ; markdown ]
        fhir:artifact [  a fhir:uri ; uri ]
    ] ... ) ;
    fhir:requirement ( [ # 0..* Links or references to the testing requirements
      fhir:reference [ canonical(Requirements) ] ; # 1..1 Canonical reference to the Requirements instance
      fhir:key [ id ] ; # 1..1 Requirements statement key identifier
    ] ... ) ;
    fhir:dependency ( [ # 0..* Required criteria to execute the test case
      fhir:description [ markdown ] ; # 0..1 Description of the criteria
      fhir:reference [ canonical(TestPlan) ] ; # 0..1 Canonical reference to the TestPlan dependency instance
      fhir:key [ id ] ; # 0..1 TestPlan dependency instance testCase key identifier
    ] ... ) ;
    fhir:testRun ( [ # 0..* The actual test to be executed
      fhir:narrative [ markdown ] ; # 0..1 The narrative description of the tests
      fhir:script [ # 0..1 The test cases in a structured language
        fhir:language [ CodeableConcept ] ; # 0..1 The structured language for the test case script
        # source[x] : 0..1 The actual content of the script, reference to test resource (TestScript) or externally defined content. One of these 3
          fhir:source [  a fhir:string ; string ]
          fhir:source [  a fhir:Attachment ; Attachment ]
          fhir:source [  a fhir:Reference ; Reference(Any) ]
      ] ;
    ] ... ) ;
    fhir:testData ( [ # 0..* The test data used in the test case
      fhir:type [ Coding ] ; # 1..1 The type of test data description, e.g. 'synthea'
      fhir:content [ Reference(Any) ] ; # 0..1 The actual test resources when they exist
      # source[x] : 0..1 Pointer to a definition of test resources - narrative or structured e.g. synthetic data generation, etc. One of these 3
        fhir:source [  a fhir:string ; string ]
        fhir:source [  a fhir:uri ; uri ]
        fhir:source [  a fhir:Reference ; Reference(Any) ]
    ] ... ) ;
    fhir:assertion ( [ # 0..* Test assertions or expectations
      fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* The expected outcome for this assertion
      fhir:object  ( [ CodeableReference(Any) ] ... ) ; # 0..* The focus or object of the assertion
      fhir:result  ( [ CodeableReference(Any) ] ... ) ; # 0..* The actual result assertion
    ] ... ) ;
    fhir:testCase  ( [ See TestPlan.testCase ] ... ) ; # 0..* Nested test cases
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.