Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ExampleScenario | TU | DomainResource | Example of workflow instance + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: Must have actors if status is active or required + Rule: Must have processes if status is active or required + Rule: Actor keys must be unique + Rule: Actor titles must be unique + Rule: Instance keys must be unique + Rule: Instance titles must be unique + Rule: Process titles must be unique Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource | |
url | ΣC | 0..1 | uri | Canonical identifier for this example scenario, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier | Σ | 0..* | Identifier | Additional identifier for the example scenario |
version | Σ | 0..1 | string | Business version of the example scenario |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | ΣC | 0..1 | string | To be removed? |
title | ΣT | 0..1 | string | Name for this example scenario (human friendly) |
status | ?!ΣC | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | ΣT | 0..1 | markdown | Natural language description of the ExampleScenario |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction for example scenario (if applicable) Binding: Jurisdiction ValueSet (Extensible) |
purpose | T | 0..1 | markdown | The purpose of the example, e.g. to illustrate a scenario |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
copyrightLabel | T | 0..1 | string | Copyright holder and year(s) |
actor | C | 0..* | BackboneElement | Individual involved in exchange + Warning: Actor should be referenced in at least one operation + Rule: actor.key canot be 'OTHER' |
key | C | 1..1 | string | ID or acronym of the actor |
type | 1..1 | code | person | system Binding: Example Scenario Actor Type (Required) | |
title | TC | 1..1 | string | Label for actor when rendering |
description | T | 0..1 | markdown | Details about actor |
instance | C | 0..* | BackboneElement | Data used in the scenario + Rule: StructureVersion is required if structureType is not FHIR (but may still be present even if FHIR) + Rule: instance.content is only allowed if there are no instance.versions + Rule: Version keys must be unique within an instance + Rule: Version titles must be unique within an instance + Warning: Instance should be referenced in at least one location + Warning: Instance version should be referenced in at least one operation |
key | C | 1..1 | string | ID or acronym of the instance |
structureType | C | 1..1 | Coding | Data structure for example Binding: Example Scenario Resource Type (Extensible) |
structureVersion | C | 0..1 | string | E.g. 4.0.1 |
structureProfile[x] | 0..1 | Rules instance adheres to | ||
structureProfileCanonical | canonical() | |||
structureProfileUri | uri | |||
title | TC | 1..1 | string | Label for instance |
description | T | 0..1 | markdown | Human-friendly description of the instance |
content | C | 0..1 | Reference() | Example instance data |
version | C | 0..* | BackboneElement | Snapshot of instance that changes |
key | C | 1..1 | string | ID or acronym of the version |
title | C | 1..1 | string | Label for instance version |
description | T | 0..1 | markdown | Details about version |
content | 0..1 | Reference() | Example instance version data | |
containedInstance | C | 0..* | BackboneElement | Resources contained in the instance + Rule: InstanceReference must be a key of an instance defined in the ExampleScenario + Rule: versionReference must be specified if the referenced instance defines versions + Rule: versionReference must be a key of a version within the instance pointed to by instanceReference |
instanceReference | C | 1..1 | string | Key of contained instance |
versionReference | C | 0..1 | string | Key of contained instance version |
process | C | 0..* | BackboneElement | Major process within scenario + Rule: Processes must have steps if ExampleScenario status is active or required |
title | ΣTC | 1..1 | string | Label for procss |
description | T | 0..1 | markdown | Human-friendly description of the process |
preConditions | T | 0..1 | markdown | Status before process starts |
postConditions | T | 0..1 | markdown | Status after successful completion |
step | C | 0..* | BackboneElement | Event within of the process + Rule: Alternative titles must be unique within a step + Rule: Can have a process, a workflow, one or more operations or none of these, but cannot have a combination |
number | 0..1 | string | Sequential number of the step | |
process | 0..1 | see process | Step is nested process | |
workflow | C | 0..1 | canonical(ExampleScenario) | Step is nested workflow |
operation | C | 0..1 | BackboneElement | Step is simple action + Rule: If specified, initiator must be a key of an actor within the ExampleScenario + Rule: If specified, receiver must be a key of an actor within the ExampleScenario |
type | 0..1 | Coding | Kind of action Binding: Test Script Operation Code (Extensible) | |
title | 1..1 | string | Label for step | |
initiator | C | 0..1 | string | Who starts the operation |
receiver | C | 0..1 | string | Who receives the operation |
description | T | 0..1 | markdown | Human-friendly description of the operation |
initiatorActive | 0..1 | boolean | Initiator stays active? | |
receiverActive | 0..1 | boolean | Receiver stays active? | |
request | 0..1 | see containedInstance | Instance transmitted on invocation | |
response | 0..1 | see containedInstance | Instance transmitted on invocation response | |
alternative | C | 0..* | BackboneElement | Alternate non-typical step action |
title | TC | 1..1 | string | Label for alternative |
description | T | 0..1 | markdown | Human-readable description of option |
step | 0..* | see step | Alternative action(s) | |
pause | 0..1 | boolean | Pause in the flow? | |
Documentation for this format |