Generated Narrative: StructureDefinition profile-TestPlan Name Flags Card. Type Description & Constraints Basic 0..* Basic(4.3.0) Resource for non-supported content #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:url 0..1 uri R5: Canonical identifier for this test plan, represented as a URI (globally unique) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.url #xD; extension:version 0..1 string R5: Business version of the test plan (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.version #xD; extension:versionAlgorithm 0..1 string, Coding R5: How to compare versions (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.versionAlgorithm Binding: R5VersionAlgorithmForR4B (0.1.0) (extensible) #xD; extension:name 0..1 string R5: Name for this test plan (computer friendly) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.name #xD; extension:title 0..1 string R5: Name for this test plan (human friendly) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.title #xD; extension:experimental 0..1 boolean R5: For testing purposes, not real usage (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.experimental #xD; extension:date 0..1 dateTime R5: Date last changed (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.date #xD; extension:publisher 0..1 string R5: Name of the publisher/steward (organization or individual) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.publisher #xD; extension:contact 0..* ContactDetail R5: Contact details for the publisher (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.contact #xD; extension:description 0..1 markdown R5: Natural language description of the test plan (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.description #xD; extension:useContext 0..* UsageContext R5: The context that the content is intended to support (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.useContext #xD; extension:jurisdiction 0..* CodeableConcept R5: Intended jurisdiction where the test plan applies (if applicable) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.jurisdiction #xD; extension:purpose 0..1 markdown R5: Why this test plan is defined (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.purpose #xD; extension:copyright 0..1 markdown R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.copyright #xD; extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.copyrightLabel #xD; extension:category 0..* CodeableConcept R5: The category of the Test Plan - can be acceptance, unit, performance (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.category Binding: R5TestscriptScopePhaseCodesForR4B (0.1.0) (example): The high-level category for this plan. #xD; extension:scope 0..* Reference() R5: What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.scope #xD; extension:testTools 0..1 markdown R5: A description of test tools to be used in the test plan - narrative for now (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.testTools #xD; extension:dependency 0..* (Complex) R5: The required criteria to execute the test plan - e.g. preconditions, previous tests (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.dependency #xD; extension:exitCriteria 0..1 markdown R5: The threshold or criteria for the test plan to be considered successfully executed - narrative (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.exitCriteria #xD; extension:testCase 0..* (Complex) R5: The test cases that constitute this plan (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.testCase #xD; Slices for modifierExtension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; modifierExtension:status 1..1 code R5: draft | active | retired | unknown (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-TestPlan.status Binding: PublicationStatus (required): The lifecycle status of an artifact. #xD; Documentation for this format
Cross-version Profile for R5.TestPlan for use in FHIR R4B
This cross-version profile allows R5 TestPlan content to be represented via FHIR R4B Basic resources.
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $contained in f:contained return $contained[not(exists(parent::*/descendant::f:reference/@value=concat('#', $contained/*/f:id/@value)) or exists(descendant::f:reference[@value='#']))]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
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 it's 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 it's 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).
Text summary of the resource, for human interpretation
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.
Contained resources do not have 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.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
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.
Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
not(f:Citation|f:Evidence|f:EvidenceReport|f:EvidenceVariable|f:MedicinalProductDefinition|f:PackagedProductDefinition|f:AdministrableProductDefinition|f:Ingredient|f:ClinicalUseDefinition|f:RegulatedAuthorization|f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic) or not(parent::f:Citation|parent::f:Evidence|parent::f:EvidenceReport|parent::f:EvidenceVariable|parent::f:MedicinalProductDefinition|parent::f:PackagedProductDefinition|parent::f:AdministrableProductDefinition|parent::f:Ingredient|parent::f:ClinicalUseDefinition|parent::f:RegulatedAuthorization|parent::f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic)
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
R5: Canonical identifier for this test plan, represented as a URI (globally unique) (new)
Element `TestPlan.url` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.url` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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](https://hl7.org/fhir/resource..html#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](https://hl7.org/fhir/resou.html#meta) element to indicate where the current master source of the resource can be found.
All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
R5: Business version of the test plan (new)
Element `TestPlan.version` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.version` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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](https://hl7.org/fhir/resource.h.html#bv-format).
R5: `TestPlan.versionAlgorithm[x]` (new:Coding, string)
Element `TestPlan.versionAlgorithm[x]` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.versionAlgorithm[x]` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
R5: Name for this test plan (computer friendly) (new)
Element `TestPlan.name` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.name` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
R5: Name for this test plan (human friendly) (new)
Element `TestPlan.title` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.title` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
R5: For testing purposes, not real usage (new)
R5: `TestPlan.experimental` (new:boolean)
Element `TestPlan.experimental` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.experimental` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Allows filtering of test plans that are appropriate for use versus not.
Element `TestPlan.date` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.date` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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](https://hl7.org/fhir/canonicalreso.html#localization).
R5: Name of the publisher/steward (organization or individual) (new)
Element `TestPlan.publisher` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.publisher` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
R5: Contact details for the publisher (new)
R5: `TestPlan.contact` (new:ContactDetail)
Element `TestPlan.contact` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.contact` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).
R5: Natural language description of the test plan (new)
R5: `TestPlan.description` (new:markdown)
Element `TestPlan.description` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.description` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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).
R5: The context that the content is intended to support (new)
R5: `TestPlan.useContext` (new:UsageContext)
Element `TestPlan.useContext` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.useContext` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
R5: Intended jurisdiction where the test plan applies (if applicable) (new)
R5: `TestPlan.jurisdiction` (new:CodeableConcept)
Element `TestPlan.jurisdiction` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.jurisdiction` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Element `TestPlan.jurisdiction` has been flagged as deprecated. 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.)
Element `TestPlan.purpose` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.purpose` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
R5: Use and/or publishing restrictions (new)
Element `TestPlan.copyright` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.copyright` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
R5: `TestPlan.copyrightLabel` (new:string)
Element `TestPlan.copyrightLabel` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.copyrightLabel` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
R5: The category of the Test Plan - can be acceptance, unit, performance (new)
R5: `TestPlan.category` (new:CodeableConcept)
Element `TestPlan.category` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.category` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
R5: What is being tested with this Test Plan - a conformance resource, or narrative criteria, or an external reference (new)
Element `TestPlan.scope` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.scope` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
R5: A description of test tools to be used in the test plan - narrative for now (new)
Element `TestPlan.testTools` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.testTools` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
R5: The required criteria to execute the test plan - e.g. preconditions, previous tests (new)
R5: `TestPlan.dependency` (new:BackboneElement)
Element `TestPlan.dependency` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.dependency` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
R5: The threshold or criteria for the test plan to be considered successfully executed - narrative (new)
R5: `TestPlan.exitCriteria` (new:markdown)
Element `TestPlan.exitCriteria` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.exitCriteria` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
R5: The test cases that constitute this plan (new)
R5: `TestPlan.testCase` (new:BackboneElement)
Element `TestPlan.testCase` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.testCase` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
R5: draft | active | retired | unknown (new)
Element `TestPlan.status` is not mapped to FHIR R4B, since FHIR R5 `TestPlan` is not mapped. Element `TestPlan.status` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Allows filtering of test plans that are appropriate for use versus not. See guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Identifier assigned to the resource for business purposes, outside the context of FHIR.
Identifies the 'type' of resource - equivalent to the resource name for other resources.
Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.
Must be able to distinguish different types of Basic resources.
This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
HL7-maintained set of codes for "Basic" resources
Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.
Needed for partitioning the resource by Patient.
./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)
Identifies when the resource was first created.
Allows ordering resource instances by time.
./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)
Indicates who was responsible for creating the resource instance.
./participation[typeCode='SUB'] (possibly through a ControlAct and Role)