Current Build
FHIR Infrastructure Work GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ExampleScenario resource.

ExampleScenario
Element IdExampleScenario
Definition

Example of workflow instance.

Cardinality0..*
TypeDomainResource
Invariants
Defined on this element
esc-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ExampleScenario.url
Element IdExampleScenario.url
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 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.

Cardinality0..1
Typeuri
Requirements

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

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

ExampleScenario.identifier
Element IdExampleScenario.identifier
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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
Comments

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.

ExampleScenario.version
Element IdExampleScenario.version
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.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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].

ExampleScenario.name
Element IdExampleScenario.name
Definition

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.

Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

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.

Invariants
Affect this element
inv-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
To Do& A name should 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.
ExampleScenario.status
Element IdExampleScenario.status
Definition

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

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

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

ExampleScenario.experimental
Element IdExampleScenario.experimental
Definition

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.

Cardinality0..1
Typeboolean
Requirements

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

Summarytrue
Comments

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

ExampleScenario.date
Element IdExampleScenario.date
Definition

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

Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

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.

ExampleScenario.publisher
Element IdExampleScenario.publisher
Definition

The name of the organization or individual that published the example scenario.

Cardinality0..1
Typestring
Requirements

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

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

ExampleScenario.contact
Element IdExampleScenario.contact
Definition

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

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

ExampleScenario.useContext
Element IdExampleScenario.useContext
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.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

ExampleScenario.jurisdiction
Element IdExampleScenario.jurisdiction
Definition

A legal or geographic region in which the example scenario is intended to be used.

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
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.

ExampleScenario.copyright
Element IdExampleScenario.copyright
Definition

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.

Cardinality0..1
Typemarkdown
Requirements

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

Alternate NamesLicense; Restrictions
Comments

nullFrequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.

ExampleScenario.purpose
Element IdExampleScenario.purpose
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.

Cardinality0..1
Typemarkdown
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.

ExampleScenario.actor
Element IdExampleScenario.actor
Definition

Actor participating in the resource.

Cardinality0..*
ExampleScenario.actor.actorId
Element IdExampleScenario.actor.actorId
Definition

ID or acronym of actor.

Cardinality1..1
Typestring
Comments

should this be called ID or acronym?

ExampleScenario.actor.type
Element IdExampleScenario.actor.type
Definition

The type of actor - person or system.

Cardinality1..1
Terminology BindingExampleScenarioActorType (Required)
Typecode
ExampleScenario.actor.name
Element IdExampleScenario.actor.name
Definition

The name of the actor as shown in the page.

Cardinality0..1
Typestring
Comments

Cardinality: is name and description 1..1?

ExampleScenario.actor.description
Element IdExampleScenario.actor.description
Definition

The description of the actor.

Cardinality0..1
Typemarkdown
Comments

Cardinality: is name and description 1..1?

ExampleScenario.instance
Element IdExampleScenario.instance
Definition

Each resource and each version that is present in the workflow.

Cardinality0..*
ExampleScenario.instance.resourceId
Element IdExampleScenario.instance.resourceId
Definition

The id of the resource for referencing.

Cardinality1..1
Typestring
ExampleScenario.instance.resourceType
Element IdExampleScenario.instance.resourceType
Definition

The type of the resource.

Cardinality1..1
Terminology BindingResourceType (Required)
Typecode
ExampleScenario.instance.name
Element IdExampleScenario.instance.name
Definition

A short name for the resource instance.

Cardinality0..1
Typestring
To DoShould name and description be 1..1?
ExampleScenario.instance.description
Element IdExampleScenario.instance.description
Definition

Human-friendly description of the resource instance.

Cardinality0..1
Typemarkdown
To DoShould name and description be 1..1?
ExampleScenario.instance.version
Element IdExampleScenario.instance.version
Definition

A specific version of the resource.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..*
ExampleScenario.instance.version.versionId
Element IdExampleScenario.instance.version.versionId
Definition

The identifier of a specific version of a resource.

Cardinality1..1
Typestring
ExampleScenario.instance.version.description
Element IdExampleScenario.instance.version.description
Definition

The description of the resource version.

Cardinality1..1
Typemarkdown
ExampleScenario.instance.containedInstance
Element IdExampleScenario.instance.containedInstance
Definition

Resources contained in the instance (e.g. the observations contained in a bundle).

Cardinality0..*
ExampleScenario.instance.containedInstance.resourceId
Element IdExampleScenario.instance.containedInstance.resourceId
Definition

Each resource contained in the instance.

Cardinality1..1
Typestring
ExampleScenario.instance.containedInstance.versionId
Element IdExampleScenario.instance.containedInstance.versionId
Definition

A specific version of a resource contained in the instance.

Cardinality0..1
Typestring
ExampleScenario.process
Element IdExampleScenario.process
Definition

Each major process - a group of operations.

Cardinality0..*
ExampleScenario.process.title
Element IdExampleScenario.process.title
Definition

The diagram title of the group of operations.

Cardinality1..1
Typestring
Summarytrue
ExampleScenario.process.description
Element IdExampleScenario.process.description
Definition

A longer description of the group of operations.

Cardinality0..1
Typemarkdown
ExampleScenario.process.preConditions
Element IdExampleScenario.process.preConditions
Definition

Description of initial status before the process starts.

Cardinality0..1
Typemarkdown
ExampleScenario.process.postConditions
Element IdExampleScenario.process.postConditions
Definition

Description of final status after the process ends.

Cardinality0..1
Typemarkdown
ExampleScenario.process.step
Element IdExampleScenario.process.step
Definition

Each step of the process.

Cardinality0..*
ExampleScenario.process.step.process
Element IdExampleScenario.process.step.process
Definition

Nested process.

Cardinality0..*
TypeSee ExampleScenario.process
ExampleScenario.process.step.pause
Element IdExampleScenario.process.step.pause
Definition

If there is a pause in the flow.

Cardinality0..1
Typeboolean
ExampleScenario.process.step.operation
Element IdExampleScenario.process.step.operation
Definition

Each interaction or action.

Cardinality0..1
ExampleScenario.process.step.operation.number
Element IdExampleScenario.process.step.operation.number
Definition

The sequential number of the interaction, e.g. 1.2.5.

Cardinality1..1
Typestring
ExampleScenario.process.step.operation.type
Element IdExampleScenario.process.step.operation.type
Definition

The type of operation - CRUD.

Cardinality0..1
Typestring
ExampleScenario.process.step.operation.name
Element IdExampleScenario.process.step.operation.name
Definition

The human-friendly name of the interaction.

Cardinality0..1
Typestring
ExampleScenario.process.step.operation.initiator
Element IdExampleScenario.process.step.operation.initiator
Definition

Who starts the transaction.

Cardinality0..1
Typestring
ExampleScenario.process.step.operation.receiver
Element IdExampleScenario.process.step.operation.receiver
Definition

Who receives the transaction.

Cardinality0..1
Typestring
ExampleScenario.process.step.operation.description
Element IdExampleScenario.process.step.operation.description
Definition

A comment to be inserted in the diagram.

Cardinality0..1
Typemarkdown
ExampleScenario.process.step.operation.initiatorActive
Element IdExampleScenario.process.step.operation.initiatorActive
Definition

Whether the initiator is deactivated right after the transaction.

Cardinality0..1
Typeboolean
ExampleScenario.process.step.operation.receiverActive
Element IdExampleScenario.process.step.operation.receiverActive
Definition

Whether the receiver is deactivated right after the transaction.

Cardinality0..1
Typeboolean
ExampleScenario.process.step.operation.request
Element IdExampleScenario.process.step.operation.request
Definition

Each resource instance used by the initiator.

Cardinality0..1
TypeSee ExampleScenario.instance.containedInstance
ExampleScenario.process.step.operation.response
Element IdExampleScenario.process.step.operation.response
Definition

Each resource instance used by the responder.

Cardinality0..1
TypeSee ExampleScenario.instance.containedInstance
ExampleScenario.process.step.alternative
Element IdExampleScenario.process.step.alternative
Definition

Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.

Cardinality0..*
ExampleScenario.process.step.alternative.title
Element IdExampleScenario.process.step.alternative.title
Definition

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

Cardinality1..1
Typestring
ExampleScenario.process.step.alternative.description
Element IdExampleScenario.process.step.alternative.description
Definition

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

Cardinality0..1
Typemarkdown
ExampleScenario.process.step.alternative.step
Element IdExampleScenario.process.step.alternative.step
Definition

What happens in each alternative option.

Cardinality0..*
TypeSee ExampleScenario.process.step
ExampleScenario.workflow
Element IdExampleScenario.workflow
Definition

Another nested workflow.

Cardinality0..*
Typecanonical(ExampleScenario)