ExampleScenario
Example of workflow instance.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 11 of 13 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
urlΣ | 0..1 | uri | Canonical identifier for this example scenario, represented as a URI (globally unique) |
identifierΣ | 0..* | Identifier | Additional identifier for the example scenario |
versionΣ | 0..1 | string | Business version of the example scenario |
nameΣ | 0..1 | string | Name for this example scenario (computer friendly) |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
dateΣ | 0..1 | dateTime | Date last changed |
publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
contactΣ | 0..* | ContactDetail | Contact details for the publisher |
useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for example scenario (if applicable)Binding (extensible): jurisdiction |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
purpose | 0..1 | markdown | The purpose of the example, e.g. to illustrate a scenario |
actor | 0..* | BackboneElement | Actor participating in the resource |
actorIdRequired | 1..1 | string | ID or acronym of the actor |
typeRequired | 1..1 | code | person | entityBinding (required): examplescenario-actor-type |
name | 0..1 | string | The name of the actor as shown in the page |
description | 0..1 | markdown | The description of the actor |
instance | 0..* | BackboneElement | Each resource and each version that is present in the workflow |
resourceIdRequired | 1..1 | string | The id of the resource for referencing |
resourceTypeRequired | 1..1 | code | The type of the resourceBinding (required): resource-types |
name | 0..1 | string | A short name for the resource instance |
description | 0..1 | markdown | Human-friendly description of the resource instance |
version | 0..* | BackboneElement | A specific version of the resource |
versionIdRequired | 1..1 | string | The identifier of a specific version of a resource |
descriptionRequired | 1..1 | markdown | The description of the resource version |
containedInstance | 0..* | BackboneElement | Resources contained in the instance |
resourceIdRequired | 1..1 | string | Each resource contained in the instance |
versionId | 0..1 | string | A specific version of a resource contained in the instance |
process | 0..* | BackboneElement | Each major process - a group of operations |
titleRequiredΣ | 1..1 | string | The diagram title of the group of operations |
description | 0..1 | markdown | A longer description of the group of operations |
preConditions | 0..1 | markdown | Description of initial status before the process starts |
postConditions | 0..1 | markdown | Description of final status after the process ends |
step | 0..* | BackboneElement | Each step of the process |
process | 0..* | Same as ExampleScenario.process | Nested process |
pause | 0..1 | boolean | If there is a pause in the flow |
operation | 0..1 | BackboneElement | Each interaction or action |
numberRequired | 1..1 | string | The sequential number of the interaction |
type | 0..1 | string | The type of operation - CRUD |
name | 0..1 | string | The human-friendly name of the interaction |
initiator | 0..1 | string | Who starts the transaction |
receiver | 0..1 | string | Who receives the transaction |
description | 0..1 | markdown | A comment to be inserted in the diagram |
initiatorActive | 0..1 | boolean | Whether the initiator is deactivated right after the transaction |
receiverActive | 0..1 | boolean | Whether the receiver is deactivated right after the transaction |
request | 0..1 | Same as ExampleScenario.instance.containedInstance | Each resource instance used by the initiator |
response | 0..1 | Same as ExampleScenario.instance.containedInstance | Each resource instance used by the responder |
alternative | 0..* | BackboneElement | Alternate non-typical step action |
titleRequired | 1..1 | string | Label for alternative |
description | 0..1 | markdown | A human-readable description of each option |
step | 0..* | Same as ExampleScenario.process.step | What happens in each alternative option |
workflow | 0..* | canonical(ExampleScenario) | Another nested workflow |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/ExampleScenario?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
context | token | A use context assigned to the example scenario (ExampleScenario.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the example scenario (ExampleScenario.useContext.value.ofType(Quantity)) | (ExampleScenario.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the example scenario ExampleScenario.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the example scenario ExampleScenario.useContext | ||
context-type-value | composite | A use context type and value assigned to the example scenario ExampleScenario.useContext | ||
date | date | The example scenario publication date ExampleScenario.date | ||
identifier | token | External identifier for the example scenario ExampleScenario.identifier | ||
jurisdiction | token | Intended jurisdiction for the example scenario ExampleScenario.jurisdiction | ||
name | string | Computationally friendly name of the example scenario ExampleScenario.name | ||
publisher | string | Name of the publisher of the example scenario ExampleScenario.publisher | ||
status | token | The current status of the example scenario ExampleScenario.status | ||
url | uri | The uri that identifies the example scenario ExampleScenario.url | ||
version | token | The business version of the example scenario ExampleScenario.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken