Example of workflow instance.

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.

Allows the example scenario to be referenced by a single globally unique identifier.

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions .

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

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.

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

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.

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]. The version SHOULD NOT contain a '#' - see Business Version .

A natural language name identifying the example scenario. This name should be usable as an identifier for Indicates the module by machine processing applications such as code generation. mechanism used to compare versions to determine which is more current.

Support human navigation If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and code generation. %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.

Temporarily retained for tooling purposes.

The name is not expected to be globally unique. The name should Not needed as code will never be a simple alphanumeric type name to ensure that it is machine-processing friendly. generated from one of these

A short, descriptive, user-friendly title for the ExampleScenario.

This name should does not need to be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name. machine-processing friendly and may contain punctuation, white-space, etc.

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.

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

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.

Allows filtering of example scenarios that are appropriate for use versus not.

The date (and optionally time) when the example scenario was published. last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').

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 example scenario. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

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

The name of the organization or individual that published responsible for the release and ongoing maintenance of the example scenario.

Helps establish the "authority/credibility" of the example scenario. May also allow for contact.

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.

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.

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

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

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.

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.

Assist in searching for appropriate content.

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

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.

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

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.

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.

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

...

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 short string (<50 characters), suitable for inclusion in a scenario. page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

This element does not describe the usage of Defines the example scenario. Instead, it provides traceability content expected to be rendered in all representations of ''why'' the resource is either needed or ''why'' it is defined as it is. This may artifact.

The (c) symbol should NOT be used to point to source materials or specifications that drove the structure of included in this example scenario. 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.

Actor participating in A system or person who shares or receives an instance within the resource. scenario.

This is optional to allow for ExampleScenarios that are still draft

A unique string within the scenario that is used to reference the actor.

The type category of actor - person or system.

The human-readable name of for the actor as shown in used when rendering the page. scenario.

The description An explanation of who/what the actor. actor is and its role in the scenario.

Each resource and each version A single data collection that is present in shared as part of the workflow. scenario.

The id of A unique string within the resource for referencing. scenario that is used to reference the instance.

The type of A code indicating the resource. kind of data structure (FHIR resource or some other standard) this is an instance of.

A short name for Conveys the resource instance. version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.

Refers to a profile, template or other ruleset the instance adheres to.

A short descriptive label the instance to be 1..1? used in tables or diagrams.

An explanation of what the instance contains and what it's for.

Points to an instance (typically an example) that shows the data that would corespond to this instance.

If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be 1..1? to a Binary.

A specific version of Represents the resource. instance as it was at a specific time-point.

Allows representing the 'same' instance as it evolves throughout the scenario.

Not used if an instance doesn't change

The identifier A unique string within the instance that is used to reference the version of a specific the instance.

A short descriptive label the version to be used in tables or diagrams.

The description An explanation of what this specific version of the resource version. instance contains and represents.

Points to an instance (typically an example) that shows the data that would flow at this point in the scenario.

If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.

Resources contained in the References to other instances that can be found within this instance (e.g. the observations contained in a bundle).

Each resource contained in A reference to the instance. key of an instance found within this one.

A reference to the key of a specific version of a resource contained an instance in the this instance.

Required if the referenced instance has versions

Each major process - a A group of operations. operations that represents a significant step within a scenario.

Some scenarios might describe only one process.

The diagram title of A short descriptive label the group of operations. process to be used in tables or diagrams.

A longer description An explanation of what the group of operations. process represents and what it does.

Description of the initial status state of the actors, environment and data before the process starts.

Description of the final status state of the actors, environment and data after the process ends. has been successfully completed.

Alternate steps might not result in all post conditions holding

Each step A significant action that occurs as part of the process.

Nested process. The sequential number of the step, e.g. 1.2.5.

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

If there Indicates that the step is a pause in the flow. complex sub-process with its own steps.

Each interaction or action. Indicates that the step is defined by a seaparate scenario instance.

The sequential number of the interaction, e.g. 1.2.5. step represents a single operation invoked on receiver by sender.

The standardized type of operation - CRUD. action (FHIR or otherwise).

The human-friendly name of A short descriptive label the interaction. step to be used in tables or diagrams.

The system that invokes the action/transmits the data.

This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the initiator is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.)

The system on which the action is invoked/receives the data.

This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the receiver is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.) In some cases, receiver could be same as sender if representing a local operation

A comment to be inserted in An explanation of what the diagram. operation represents and what it does.

This should contain information not already present in the process step. It's more of a description of what the operation in general does - if not already evident from the operation.type

Whether If false, the initiator is deactivated right after the transaction. operation.

The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.

De-activation of an actor means they have no further role until such time as they are the recipient of an operation.

Whether If false, the receiver is deactivated right after the transaction. operation.

The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.

De-activation of an actor means they have no further role until such time as they are the recipient of an operation.

Each resource A reference to the instance used by that is transmitted from requester to receiver as part of the initiator. invocation of the operation.

Each resource A reference to the instance used by that is transmitted from receiver to requester as part of the responder. operation's synchronous response (if any).

Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical sub-process, scenario or operation. E.g. to represent non-happy-path/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 the alternative explaining when the alternative should occur rather than the base step.

What Indicates the operation, sub-process or scenario that happens in each if the alternative option. option is selected.

Another nested workflow. If true, indicates that, following this step, there is a pause in the flow and the subsequent step will occur at some later time (triggered by some event).