Generated Narrative: StructureDefinition profile-ExampleScenario Name Flags Card. Type Description & Constraints ExampleScenario 0..* ExampleScenario(4.3.0) Example of workflow instance #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:versionAlgorithm 0..1 Coding R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) #xD; extension:title 0..1 string R5: Name for this example scenario (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title #xD; extension:description 0..1 markdown R5: Natural language description of the ExampleScenario (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description #xD; extension:copyrightLabel 0..1 string R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel #xD; instance #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:structureVersion 0..1 string R5: E.g. 4.0.1 (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureVersion #xD; extension:structureProfile 0..1 canonical(), uri R5: Rules instance adheres to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureProfile #xD; extension:content 0..1 Reference() R5: Example instance data (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content #xD; resourceType #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:structureType 0..1 Coding R5: Data structure for example additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureType Binding: R5ExamplescenarioInstanceTypeForR4B (0.1.0) (extensible): The structure that defines the instance #xD; version #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:title 1..1 string R5: Label for instance version (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title #xD; extension:content 0..1 Reference() R5: Example instance version data (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content #xD; process #xD; step #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:number 0..1 string R5: Sequential number of the step (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.number #xD; extension:workflow 0..1 canonical(Cross-version Profile for R5.ExampleScenario for use in FHIR R4B(0.1.0) | ExampleScenario) R5: Step is nested workflow (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.workflow #xD; operation #xD; type #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 0..1 Coding R5: Kind of action additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.operation.type Binding: R5TestscriptOperationCodesForR4B (0.1.0) (extensible) #xD; Documentation for this format
Cross-version Profile for R5.ExampleScenario for use in FHIR R4B
This cross-version profile allows R5 ExampleScenario content to be represented via FHIR R4B ExampleScenario resources.
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
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_]){0,254}')
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
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: `ExampleScenario.versionAlgorithm[x]` (new:Coding, string)
Element `ExampleScenario.versionAlgorithm[x]` has a context of ExampleScenario based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.versionAlgorithm[x]` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `ExampleScenario.versionAlgorithm[x]`: `http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm`. 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 example scenario (human friendly) (new)
R5: `ExampleScenario.title` (new:string)
Element `ExampleScenario.title` has a context of ExampleScenario based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.title` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `ExampleScenario.title`: `http://hl7.org/fhir/StructureDefinition/artifact-title`. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
R5: Natural language description of the ExampleScenario (new)
R5: `ExampleScenario.description` (new:markdown)
Element `ExampleScenario.description` has a context of ExampleScenario based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.description` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `ExampleScenario.description`: `http://hl7.org/fhir/StructureDefinition/artifact-description`. This description can be used to capture details such as comments about misuse. It is not a rendering of the ExampleScenario as conveyed in the 'text' field of the resource itself.
R5: `ExampleScenario.copyrightLabel` (new:string)
Element `ExampleScenario.copyrightLabel` has a context of ExampleScenario based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.copyrightLabel` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element `ExampleScenario.copyrightLabel`: `http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel`. 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.
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 manageable, 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).
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.
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](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this example scenario, represented as a URI (globally unique)
An absolute URI that is used to identify this example scenario 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 at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.
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](http://hl7.org/fhir/R4B/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](http://hl7.org/fhir/R4B/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the example scenario to be referenced by a single globally unique identifier.
Additional identifier for the example scenario
A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this example scenario outside of FHIR, where it is not possible to use the logical URI.
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Business version of the example scenario
The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario 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.
There may be different example scenario 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 example scenario with the format [url]|[version].
Name for this example scenario (computer friendly)
A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation.
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.
Support human navigation and code generation.
The status of this example scenario. Enables tracking the life-cycle of the content.
Allows filtering of example scenarios that are appropriate for use versus not.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario.
The date (and optionally time) when the example scenario was published. 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 example scenario changes. (e.g. the 'content logical definition').
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the example scenario. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Name of the publisher (organization or individual)
The name of the organization or individual that published the example scenario.
Usually an organization but may be an individual. The publisher (or steward) of the example scenario is the organization or individual primarily responsible for the maintenance and upkeep of the example scenario. 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 example scenario. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the example scenario. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
The context that the content is intended to support
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 example scenario instances.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for example scenario (if applicable)
A legal or geographic region in which the example scenario is intended to be used.
It may be possible for the example scenario to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use.
A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.
nullFrequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.
Consumers must be able to determine any legal restrictions on the use of the example scenario and/or its content.
The purpose of the example, e.g. to illustrate a scenario
What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.
This element does not describe the usage of the example scenario. 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 example scenario.
All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
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 manageable, 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.
Extensions that cannot be ignored even if unrecognized
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 manageable, 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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The name of the actor as shown in the page
The name of the actor as shown in the page.
Cardinality: is name and description 1..1?
Each resource and each version that is present in the workflow
Each resource and each version that is present in the workflow.
R5: `ExampleScenario.instance.structureVersion` (new:string)
Element `ExampleScenario.instance.structureVersion` has a context of ExampleScenario.instance based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.instance.structureVersion` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
R5: `ExampleScenario.instance.structureProfile[x]` (new:canonical, uri)
Element `ExampleScenario.instance.structureProfile[x]` has a context of ExampleScenario.instance based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.instance.structureProfile[x]` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
R5: `ExampleScenario.instance.content` (new:Reference)
Element `ExampleScenario.instance.content` has a context of ExampleScenario.instance based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.instance.content` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.
unique id for the element within a resource (for internal references)
R5: Data structure for example additional types
R5: `ExampleScenario.instance.structureType` additional types (Coding) additional types from child elements (userSelected)
Element `ExampleScenario.instance.structureType` is mapped to FHIR R4B element `ExampleScenario.instance.resourceType` as `SourceIsBroaderThanTarget`. The mappings for `ExampleScenario.instance.structureType` do not cover the following types: Coding. The mappings for `ExampleScenario.instance.structureType` do not cover the following types based on type expansion: userSelected.
Human-friendly description of the resource instance
Human-friendly description of the resource instance.
R5: `ExampleScenario.instance.version.title` (new:string)
Element `ExampleScenario.instance.version.title` has a context of ExampleScenario.instance.version based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.instance.version.title` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
R5: `ExampleScenario.instance.version.content` (new:Reference)
Element `ExampleScenario.instance.version.content` has a context of ExampleScenario.instance.version based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.instance.version.content` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.
The identifier of a specific version of a resource
The identifier of a specific version of a resource.
The description of the resource version.
Resources contained in the instance (e.g. the observations contained in a bundle).
Each resource contained in the instance.
A specific version of a resource contained in the instance
A specific version of a resource contained in the instance.
Each major process - a group of operations
Each major process - a group of operations.
The diagram title of the group of operations
The diagram title of the group of operations.
A longer description of the group of operations
A longer description of the group of operations.
Description of initial status before the process starts
Description of initial status before the process starts.
Description of final status after the process ends
Description of final status after the process ends.
R5: `ExampleScenario.process.step.number` (new:string)
Element `ExampleScenario.process.step.number` has a context of ExampleScenario.process.step based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.process.step.number` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). If step numbers are simultaneous, they will be the same. Numbers don't have to be numeric. E.g. '2c)' is a valid step number
R5: `ExampleScenario.process.step.workflow` (new:canonical(ExampleScenario))
Element `ExampleScenario.process.step.workflow` has a context of ExampleScenario.process.step based on following the parent source element upwards and mapping to `ExampleScenario`. Element `ExampleScenario.process.step.workflow` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
The sequential number of the interaction
The sequential number of the interaction, e.g. 1.2.5.
R5: `ExampleScenario.process.step.operation.type` additional types (Coding) additional types from child elements (userSelected)
Element `ExampleScenario.process.step.operation.type` is mapped to FHIR R4B element `ExampleScenario.process.step.operation.type` as `SourceIsBroaderThanTarget`. The mappings for `ExampleScenario.process.step.operation.type` do not cover the following types: Coding. The mappings for `ExampleScenario.process.step.operation.type` do not cover the following types based on type expansion: userSelected.
The human-friendly name of the interaction
The human-friendly name of the interaction.
A comment to be inserted in the diagram.
Whether the initiator is deactivated right after the transaction
Whether the initiator is deactivated right after the transaction.
Whether the receiver is deactivated right after the transaction
Whether the receiver is deactivated right after the transaction.
Each resource instance used by the initiator
Each resource instance used by the initiator.
Each resource instance used by the responder
Each resource instance used by the responder.
Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.
The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.
A human-readable description of each option
A human-readable description of the alternative explaining when the alternative should occur rather than the base step.
What happens in each alternative option.