This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
FHIR Infrastructure Work Group | Maturity Level: 0 | Draft | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the ExampleScenario resource.
ExampleScenario | |
Definition | Example of workflow instance. |
Control | 1..1 |
ExampleScenario.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. This SHOULD be globally unique, and SHOULD be a literal address at which this example scenario is (or will be) published. |
Control | 0..1 |
Type | uri |
Requirements | Allows the example scenario to be referenced by a single globally unique identifier. |
Summary | true |
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 URL SHOULD include the major version of the example scenario. For more information see Technical and Business Versions. |
ExampleScenario.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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
Summary | true |
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this example scenario outside of FHIR, where it is not possible to use the logical URI. |
ExampleScenario.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. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
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 | |
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. |
Control | 0..1 |
Type | string |
Requirements | Support human navigation and code generation. |
Summary | true |
Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. |
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.title | |
Definition | The name of the example as showin in the title page. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
To Do | See Metadata resources inheritance: e.g.valueset. |
ExampleScenario.status | |
Definition | The status of this example scenario. Enables tracking the life-cycle of the content. |
Control | 1..1 |
Terminology Binding | PublicationStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | Allows filtering of example scenarios that are appropriate for use vs. not. |
ExampleScenario.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. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario. |
Summary | true |
Comments | Allows filtering of example scenario that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental example scenario in production. |
ExampleScenario.date | |
Definition | The date (and optionally time) when the example scenario was published. The date must change if and 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'). |
Control | 0..1 |
Type | dateTime |
Alternate Names | Revision Date |
Summary | true |
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 | |
Definition | The name of the individual or organization that published the example scenario. |
Control | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the example scenario. May also allow for contact. |
Summary | true |
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 | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
Summary | true |
Comments | May be a web site, an email address, a telephone number, etc. |
ExampleScenario.useContext | |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate example scenario instances. |
Control | 0..* |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Summary | true |
Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. |
ExampleScenario.jurisdiction | |
Definition | A legal or geographic region in which the example scenario is intended to be used. |
Control | 0..* |
Terminology Binding | Jurisdiction ValueSet (Extensible) |
Type | CodeableConcept |
Summary | true |
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 | |
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. |
Control | 0..1 |
Type | markdown |
Requirements | Consumers must be able to determine any legal restrictions on the use of the example scenario and/or its content. |
Alternate Names | License; Restrictions |
Comments | null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required. |
ExampleScenario.description | |
Definition | Description of behaviour of the workflow example. |
Control | 0..1 |
Type | markdown |
Comments | This description can be used to capture details such as why the example scenario was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the example scenario as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). |
ExampleScenario.purpose | |
Definition | What is the example scenario resource created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario. |
Control | 0..1 |
Type | markdown |
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 | |
Definition | Actor participating in the resource. |
Control | 0..* |
ExampleScenario.actor.actorId | |
Definition | ID or acronym of actor. |
Control | 1..1 |
Type | string |
Comments | should this be called ID or acronym? |
ExampleScenario.actor.type | |
Definition | The type of actor - person or system. |
Control | 1..1 |
Terminology Binding | ExampleScenarioActorType (Required) |
Type | code |
ExampleScenario.actor.name | |
Definition | The name of the actor as shown in the page. |
Control | 0..1 |
Type | string |
Comments | Cardinality: is name and description 1..1? |
ExampleScenario.actor.description | |
Definition | The description of the actor. |
Control | 0..1 |
Type | markdown |
Comments | Cardinality: is name and description 1..1? |
ExampleScenario.instance | |
Definition | Each resource and each version that is present in the workflow. |
Control | 0..* |
ExampleScenario.instance.resourceId | |
Definition | The id of the resource for referencing. |
Control | 1..1 |
Type | string |
ExampleScenario.instance.resourceType | |
Definition | The type of the resource. |
Control | 1..1 |
Terminology Binding | ResourceType (Required) |
Type | code |
ExampleScenario.instance.name | |
Definition | A short name for the resource instance. |
Control | 0..1 |
Type | string |
To Do | Should name and description be 1..1? |
ExampleScenario.instance.description | |
Definition | Human-friendly description of the resource instance. |
Control | 0..1 |
Type | markdown |
To Do | Should name and description be 1..1? |
ExampleScenario.instance.version | |
Definition | A specific version of the resource. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..* |
ExampleScenario.instance.version.versionId | |
Definition | The identifier of a specific version of a resource. |
Control | 1..1 |
Type | string |
ExampleScenario.instance.version.description | |
Definition | The description of the resource version. |
Control | 1..1 |
Type | markdown |
ExampleScenario.instance.containedInstance | |
Definition | Resources contained in the instance (e.g. the observations contained in a bundle). |
Control | 0..* |
ExampleScenario.instance.containedInstance.resourceId | |
Definition | Each resource contained in the instance. |
Control | 1..1 |
Type | string |
ExampleScenario.instance.containedInstance.versionId | |
Definition | A specific version of a resource contained in the instance. |
Control | 0..1 |
Type | string |
ExampleScenario.process | |
Definition | Each major process - a group of operations. |
Control | 1..1 |
ExampleScenario.process.title | |
Definition | The diagram title of the group of operations. |
Control | 1..1 |
Type | string |
Summary | true |
ExampleScenario.process.description | |
Definition | A longer description of the group of operations. |
Control | 0..1 |
Type | markdown |
ExampleScenario.process.preConditions | |
Definition | Description of initial status before the process starts. |
Control | 0..1 |
Type | markdown |
ExampleScenario.process.postConditions | |
Definition | Description of final status after the process ends. |
Control | 0..1 |
Type | markdown |
ExampleScenario.process.step | |
Definition | Each step of the process. |
Control | 0..* |
ExampleScenario.process.step.process | |
Definition | Nested process. |
Control | 0..* |
Type | See ExampleScenario.process |
ExampleScenario.process.step.pause | |
Definition | If there is a pause in the flow. |
Control | 0..1 |
Type | boolean |
ExampleScenario.process.step.operation | |
Definition | Each interaction or action. |
Control | 0..1 |
ExampleScenario.process.step.operation.number | |
Definition | The sequential number of the interaction. |
Control | 1..1 |
Type | string |
ExampleScenario.process.step.operation.type | |
Definition | The type of operation - CRUD. |
Control | 0..1 |
Type | string |
ExampleScenario.process.step.operation.name | |
Definition | The human-friendly name of the interaction. |
Control | 0..1 |
Type | string |
ExampleScenario.process.step.operation.initiator | |
Definition | Who starts the transaction. |
Control | 0..1 |
Type | string |
ExampleScenario.process.step.operation.receiver | |
Definition | Who receives the transaction. |
Control | 0..1 |
Type | string |
ExampleScenario.process.step.operation.description | |
Definition | A comment to be inserted in the diagram. |
Control | 0..1 |
Type | markdown |
ExampleScenario.process.step.operation.initiatorActive | |
Definition | Whether the initiator is deactivated right after the transaction. |
Control | 0..1 |
Type | boolean |
ExampleScenario.process.step.operation.receiverActive | |
Definition | Whether the receiver is deactivated right after the transaction. |
Control | 0..1 |
Type | boolean |
ExampleScenario.process.step.operation.request | |
Definition | Each resource instance used by the initiator. |
Control | 0..1 |
Type | See ExampleScenario.instance.containedInstance |
ExampleScenario.process.step.operation.response | |
Definition | Each resource instance used by the responder. |
Control | 0..1 |
Type | See ExampleScenario.instance.containedInstance |
ExampleScenario.process.step.alternative | |
Definition | Each interaction in the workflow. |
Control | 0..1 |
ExampleScenario.process.step.alternative.name | |
Definition | The name of each alternative. |
Control | 0..1 |
Type | string |
ExampleScenario.process.step.alternative.option | |
Definition | Each of the possible options in an alternative. |
Control | 1..* |
ExampleScenario.process.step.alternative.option.description | |
Definition | A human-readable description of each option. |
Control | 1..1 |
Type | markdown |
ExampleScenario.process.step.alternative.option.step | |
Definition | What happens in each alternative option. |
Control | 0..* |
Type | See ExampleScenario.process.step |
ExampleScenario.process.step.alternative.option.pause | |
Definition | If there is a pause in the flow. |
Control | 0..* |
Type | boolean |
ExampleScenario.workflow | |
Definition | Another nested workflow. |
Control | 0..* |
Type | Reference(ExampleScenario) |