type: resource-definitionsresource: ExampleScenario

ExampleScenario Definitions

ExampleScenario

A computable description of a set of actors and the interactions between those actors

Definition: A computable description of the actors, interactions between those actors that would occur, and concrete examples of the data that would be exchanged in a specific hypothetical exchange, typically used to help demonstrate the interoperability expectations of a specification. This resource is used to illustrate a specific time-based exchange, not to define in general terms how exchanges can/should occur.

Cardinality: 0..*

Constraints: cnl-0 | warning | 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{1,254}$'); exs-3 | error | Must have actors if status is active or required | status='active' or status='retired' implies actor.exists(); exs-4 | error | Must have processes if status is active or required | status='active' or status='retired' implies process.exists(); exs-6 | error | Actor keys must be unique | actor.key.count() = actor.key.distinct().count(); exs-7 | error | Actor titles must be unique | actor.title.count() = actor.title.distinct().count(); exs-8 | error | Instance keys must be unique | instance.key.count() = instance.key.distinct().count(); exs-9 | error | Instance titles must be unique | instance.title.count() = instance.title.distinct().count(); exs-12 | error | Process titles must be unique | process.title.count() = process.title.distinct().count()

Mappings: w5=infrastructure.information

ExampleScenario.url

Canonical identifier for this example scenario, represented as a URI (globally unique)

Definition: 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 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.

Comments: 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.

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

Cardinality: 0..1

Type: uri

Summary: true

Mappings: w5=FiveWs.identifier

ExampleScenario.identifier

Additional identifier for the example scenario

Definition: 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.

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

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; objimpl=no-gen-base

ExampleScenario.version

Business version of the example scenario

Definition: 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.

Comments: 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.

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.version

ExampleScenario.versionAlgorithm[x]

How to compare versions

Definition: Indicates the mechanism used to compare versions to determine which is more current.

Comments: 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.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

ExampleScenario.name

Name for this example scenario (computer friendly)

Definition: A natural language name identifying the ExampleScenario. This name should be usable as an identifier for the resource by machine processing applications such as code generation.

Comments: It is not expected that ExampleScenarios will be used to generate code, as they are only examples and not definitional. However, this element is retained to remain compatible with the canonical resource interface. Systems are free to omit populating the element.

Conditions: cnl-0

Cardinality: 0..1

Type: string

Summary: true

ExampleScenario.title

Name for this example scenario (human friendly)

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

Comments: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Cardinality: 0..1

Type: string

Summary: true

ExampleScenario.status

draft | active | retired | unknown

Definition: The status of this example scenario. Enables tracking the life-cycle of the content.

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

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

Conditions: exs-3, exs-4, exs-5

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: This is labeled as "Is Modifier" because applications should not use a retired ExampleScenario without due consideration)

Mappings: w5=FiveWs.status

ExampleScenario.experimental

For testing only - never for real usage

Definition: A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

Comments: Allows filtering of example scenarios that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario.

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: w5=FiveWs.class

ExampleScenario.date

Date last changed

Definition: The date (and optionally time) when the example scenario was 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').

Comments: 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.

Aliases: Revision Date

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: w5=FiveWs.recorded

ExampleScenario.publisher

Name of the publisher/steward (organization or individual)

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

Comments: 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.

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

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.witness

ExampleScenario.contact

Contact details for the publisher

Definition: Contact details to assist a user in finding and communicating with the publisher.

Comments: May be a web site, an email address, a telephone number, etc.

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

Cardinality: 0..*

Type: ContactDetail

Summary: true

ExampleScenario.description

Natural language description of the ExampleScenario

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

Comments: 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.

Cardinality: 0..1

Type: markdown

Summary: true

ExampleScenario.useContext

The context that the content is intended to support

Definition: 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.

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

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

Summary: true

ExampleScenario.jurisdiction

Jurisdiction of the authority that maintains the example scenario (if applicable)

Definition: A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

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

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:jurisdiction

Summary: true

ExampleScenario.purpose

The purpose of the example, e.g. to illustrate a scenario

Definition: 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.

Comments: 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.

Cardinality: 0..1

Type: markdown

Mappings: w5=FiveWs.why[x]; objimpl=no-gen-base

ExampleScenario.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: A copyright statement relating to the example scenario and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the example scenario.

Comments: ...

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

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

Mappings: objimpl=no-gen-base

ExampleScenario.copyrightLabel

Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Comments: The copyright symbol and the '(c)' textual representation 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.

Requirements: Defines the content expected to be rendered in all representations of the artifact.

Cardinality: 0..1

Type: string

ExampleScenario.actor

Individual involved in exchange

Definition: A system or person who shares or receives an instance within the scenario.

Requirements: This is optional to allow for ExampleScenarios that are still draft

Conditions: exs-3, exs-6, exs-7, exs-17, exs-18

Cardinality: 0..*

Type: BackboneElement

Mappings: w5=FiveWs.who

ExampleScenario.actor.key

ID or acronym of the actor

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

Conditions: exs-6, exs-23, exs-17, exs-18, exs-19

Cardinality: 1..1

Type: string

ExampleScenario.actor.type

person | system | collective | other

Definition: The category of actor - person or system.

Conditions: exs-24

Cardinality: 0..1

Type: code

Binding: required:actordefinition-actor-type

ExampleScenario.actor.title

Label for actor when rendering

Definition: The human-readable name for the actor used when rendering the scenario.

Conditions: exs-7

Cardinality: 1..1

Type: string

ExampleScenario.actor.description

Details about actor

Definition: An explanation of who/what the actor is and its role in the scenario.

Cardinality: 0..1

Type: markdown

ExampleScenario.actor.definition

Formal definition of actor

Definition: The formal definition of the actor in the scenario.

Comments: The title and description appearing in this resource may differ from that in the formal definition. The type SHALL be the same.

Conditions: exs-24

Cardinality: 0..1

Type: canonical

ExampleScenario.instance

Data used in the scenario

Definition: A single data collection that is shared as part of the scenario.

Conditions: exs-8, exs-9, exs-14, exs-15, exs-16

Cardinality: 0..*

Type: BackboneElement

Constraints: exs-1 | error | StructureVersion is required if structureType is not FHIR (but may still be present even if FHIR) | structureType.exists() and structureType.memberOf('http://hl7.org/fhir/ValueSet/resource-types').not() implies structureVersion.exists(); exs-2 | error | instance.content is only allowed if there are no instance.versions | content.exists() implies version.empty(); exs-10 | error | Version keys must be unique within an instance | version.key.count() = version.key.distinct().count(); exs-11 | error | Version titles must be unique within an instance | version.title.count() = version.title.distinct().count(); exs-20 | warning | Instance should be referenced in at least one location | %resource.process.descendants().select(instanceReference).where($this=%context.key).exists(); exs-21 | warning | Instance version should be referenced in at least one operation | version.exists() implies version.key.intersect(%resource.process.descendants().where(instanceReference = %context.key).versionReference).exists()

Mappings: w5=FiveWs.what[x]

ExampleScenario.instance.key

ID or acronym of the instance

Definition: A unique string within the scenario that is used to reference the instance.

Conditions: exs-8, exs-14, exs-15, exs-16, exs-20, exs-21

Cardinality: 1..1

Type: string

ExampleScenario.instance.structureType

Data structure for example

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

Comments: This element may be omitted if describing a step that doesn't involve the sharing of a data structure - e.g. a human action

Conditions: exs-1

Cardinality: 1..1

Type: Coding

Binding: extensible:examplescenario-instance-type

ExampleScenario.instance.structureVersion

E.g. 4.0.1

Definition: Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.

Meaning if Missing: If the structureType is a FHIR resource, then the version is the same FHIR version this ExampleScenario is expressed in.

Conditions: exs-1

Cardinality: 0..1

Type: string

ExampleScenario.instance.structureProfile[x]

Rules instance adheres to

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

Cardinality: 0..1

Type: canonical, uri

ExampleScenario.instance.title

Label for instance

Definition: A short descriptive label the instance to be used in tables or diagrams.

Conditions: exs-9

Cardinality: 1..1

Type: string

ExampleScenario.instance.description

Human-friendly description of the instance

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

Cardinality: 0..1

Type: markdown

ExampleScenario.instance.content

Example instance data

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

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

Conditions: exs-2

Cardinality: 0..1

Type: Reference

ExampleScenario.instance.version

Snapshot of instance that changes

Definition: Represents the instance as it was at a specific time-point.

Comments: Not used if an instance doesn't change

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

Conditions: exs-10, exs-11, exs-15, exs-16, exs-2, exs-21

Cardinality: 0..*

Type: BackboneElement

ExampleScenario.instance.version.key

ID or acronym of the version

Definition: A unique string within the instance that is used to reference the version of the instance.

Conditions: exs-10, exs-16, exs-21

Cardinality: 1..1

Type: string

ExampleScenario.instance.version.title

Label for instance version

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

Conditions: exs-11

Cardinality: 1..1

Type: string

ExampleScenario.instance.version.description

Details about version

Definition: An explanation of what this specific version of the instance contains and represents.

Cardinality: 0..1

Type: markdown

ExampleScenario.instance.version.content

Example instance version data

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

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

Cardinality: 0..1

Type: Reference

ExampleScenario.instance.containedInstance

Resources contained in the instance

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

Requirements: An instance may contain multiple resources - for example, a search response Bundle, a document Bundle, nested contained resources, etc. In some cases it's useful to be able to talk about these contained instances distinctly, as they may appear in multiple locations in a scenario - sometimes contained, sometimes not. For example, a scenario may include the creation of an Observation (stand-alone instance) followed by a search that results in a Bundle that contains that same Observation. The ExampleScenario can highlight the fact that the 'created' instance and 'contained' instance are the same by having the Bundle refer to the same instance id.

Cardinality: 0..*

Type: BackboneElement

Constraints: exs-14 | error | InstanceReference must be a key of an instance defined in the ExampleScenario | %resource.instance.where(key=%context.instanceReference).exists(); exs-15 | error | versionReference must be specified if the referenced instance defines versions | versionReference.empty() implies %resource.instance.where(key=%context.instanceReference).version.empty(); exs-16 | error | versionReference must be a key of a version within the instance pointed to by instanceReference | versionReference.exists() implies %resource.instance.where(key=%context.instanceReference).version.where(key=%context.versionReference).exists()

ExampleScenario.instance.containedInstance.instanceReference

Key of contained instance

Definition: A reference to the key of an instance found within this one.

Conditions: exs-14, exs-15, exs-16, exs-20, exs-21

Cardinality: 1..1

Type: string

ExampleScenario.instance.containedInstance.versionReference

Key of contained instance version

Definition: A reference to the key of a specific version of an instance in this instance.

Comments: Required if the referenced instance has versions

Conditions: exs-15, exs-16, exs-21

Cardinality: 0..1

Type: string

ExampleScenario.process

Major process within scenario

Definition: A group of operations that represents a significant step within a scenario.

Comments: Some scenarios might describe only one process.

Conditions: exs-4, exs-12, exs-22, exs-20, exs-21, exs-19

Cardinality: 0..*

Type: BackboneElement

Constraints: exs-5 | error | Processes must have steps if ExampleScenario status is active or required | %resource.status='active' or %resource.status='retired' implies step.exists()

ExampleScenario.process.title

Label for procss

Definition: A short descriptive label the process to be used in tables or diagrams.

Conditions: exs-12

Cardinality: 1..1

Type: string

Summary: true

ExampleScenario.process.description

Human-friendly description of the process

Definition: An explanation of what the process represents and what it does.

Cardinality: 0..1

Type: markdown

ExampleScenario.process.preConditions

Status before process starts

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

Cardinality: 0..1

Type: markdown

ExampleScenario.process.postConditions

Status after successful completion

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

Comments: Alternate steps might not result in all post conditions holding

Cardinality: 0..1

Type: markdown

ExampleScenario.process.step

Event within of the process

Definition: A significant action that occurs as part of the process.

Conditions: exs-5

Cardinality: 0..*

Type: BackboneElement

Constraints: exs-13 | error | Alternative titles must be unique within a step | alternative.title.count() = alternative.title.distinct().count(); exs-22 | error | Can have a process, a workflow, one or more operations or none of these, but cannot have a combination | (process.exists() implies workflow.empty() and operation.empty()) and (workflow.exists() implies operation.empty())

ExampleScenario.process.step.number

Sequential number of the step

Definition: The sequence number of the step, e.g. 1.2.5.

Comments: 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. The 'number' should only contain the textual part of the step identifier, not any separating punctuation. I.e. 'number' should be '2c' not '2c.' or '2c)' or '2c - '.

Cardinality: 0..1

Type: string

ExampleScenario.process.step.process

Step is nested process

Definition: Indicates that the step is a complex sub-process with its own steps.

Cardinality: 0..1

ExampleScenario.process.step.workflow

Step is nested workflow

Definition: Indicates that the step is defined by a seaparate scenario instance.

Conditions: exs-22

Cardinality: 0..1

Type: canonical

ExampleScenario.process.step.operation

Step is simple action

Definition: The step represents a single operation invoked on receiver by sender.

Conditions: exs-19, exs-22

Cardinality: 0..1

Type: BackboneElement

Constraints: exs-17 | error | If specified, initiator must be a key of an actor within the ExampleScenario | initiator.exists() implies initiator = 'OTHER' or %resource.actor.where(key=%context.initiator).exists(); exs-18 | error | If specified, receiver must be a key of an actor within the ExampleScenario | receiver.exists() implies receiver = 'OTHER' or %resource.actor.where(key=%context.receiver).exists()

ExampleScenario.process.step.operation.type

Kind of action

Definition: The standardized type of action (FHIR or otherwise).

Cardinality: 0..1

Type: Coding

Binding: extensible:examplescenario-operation-codes

ExampleScenario.process.step.operation.title

Label for step

Definition: A short descriptive label the step to be used in tables or diagrams.

Cardinality: 1..1

Type: string

ExampleScenario.process.step.operation.initiator

Who starts the operation

Definition: The system that invokes the action/transmits the data.

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

Conditions: exs-17, exs-19

Cardinality: 0..1

Type: string

ExampleScenario.process.step.operation.receiver

Who receives the operation

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

Comments: 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

Conditions: exs-18, exs-19

Cardinality: 0..1

Type: string

ExampleScenario.process.step.operation.description

Human-friendly description of the operation

Definition: An explanation of what the operation represents and what it does.

Comments: 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

Cardinality: 0..1

Type: markdown

ExampleScenario.process.step.operation.initiatorActive

Initiator stays active?

Definition: If false, the initiator is deactivated right after the operation.

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

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

Cardinality: 0..1

Type: boolean

ExampleScenario.process.step.operation.receiverActive

Receiver stays active?

Definition: If false, the receiver is deactivated right after the operation.

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

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

Cardinality: 0..1

Type: boolean

ExampleScenario.process.step.operation.request

Instance transmitted on invocation

Definition: A reference to the instance that is transmitted from requester to receiver as part of the invocation of the operation.

Cardinality: 0..1

ExampleScenario.process.step.operation.response

Instance transmitted on invocation response

Definition: A reference to the instance that is transmitted from receiver to requester as part of the operation's synchronous response (if any).

Cardinality: 0..1

ExampleScenario.process.step.alternative

Alternate non-typical step action

Definition: Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.

Conditions: exs-13

Cardinality: 0..*

Type: BackboneElement

ExampleScenario.process.step.alternative.title

Label for alternative

Definition: The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.

Conditions: exs-13

Cardinality: 1..1

Type: string

ExampleScenario.process.step.alternative.description

Human-readable description of option

Definition: A human-readable description of the alternative explaining when the alternative should occur rather than the base step.

Cardinality: 0..1

Type: markdown

ExampleScenario.process.step.alternative.step

Alternative action(s)

Definition: Indicates the operation, sub-process or scenario that happens if the alternative option is selected.

Cardinality: 0..*

ExampleScenario.process.step.pause

Pause in the flow?

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

Cardinality: 0..1

Type: boolean