ExampleScenario
Example of workflow instance.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/ExampleScenario/[id] |
| Vread | GET | /fhir/R4/ExampleScenario/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/ExampleScenario/[id] |
| Patch | PATCH | /fhir/R4/ExampleScenario/[id] |
| Delete | DELETE | /fhir/R4/ExampleScenario/[id] |
| Create | POST | /fhir/R4/ExampleScenario |
| Search | GET | /fhir/R4/ExampleScenario |
| History | GET | /fhir/R4/ExampleScenario/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
url | uri | 0..1 | Canonical identifier for this example scenario, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the example scenario |
version | string | 0..1 | Business version of the example scenario |
name | string | 0..1 | Name for this example scenario (computer friendly) |
status | code | 1..1 | draft | active | retired | unknown |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for example scenario (if applicable) |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
purpose | markdown | 0..1 | The purpose of the example, e.g. to illustrate a scenario |
actor | BackboneElement | 0..* | Actor participating in the resource |
instance | BackboneElement | 0..* | Each resource and each version that is present in the workflow |
process | BackboneElement | 0..* | Each major process - a group of operations |
workflow | canonical | 0..* | Another nested workflow |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
context | token | A use context assigned to the example scenario |
context-quantity | quantity | A quantity- or range-valued use context assigned to the example scenario |
context-type | token | A type of use context assigned to the example scenario |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the example scenario |
context-type-value | composite | A use context type and value assigned to the example scenario |
date | date | The example scenario publication date |
identifier | token | External identifier for the example scenario |
jurisdiction | token | Intended jurisdiction for the example scenario |
name | string | Computationally friendly name of the example scenario |
publisher | string | Name of the publisher of the example scenario |
status | token | The current status of the example scenario |
url | uri | The uri that identifies the example scenario |
version | token | The business version of the example scenario |
Reference
Official FHIR R4 spec: ExampleScenario.
Maturity: Draft (FMM 0).