This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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

12.25 Resource ExampleScenario - Content

FHIR Infrastructure

Work Group

Maturity Level: 0

Draft

Compartments: Not linked to any defined compartments

Example of workflow instance.

12.25.1 Scope and Usage

Todo

Structure

Name	Flags	Card.	Type	Description & Constraints
ExampleScenario	D		DomainResource	Example of workflow instance Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
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)
status	?!Σ	1..1	code	draft \| active \| retired \| unknown PublicationStatus (Required)
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) Jurisdiction ValueSet (Extensible)
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
actorId		1..1	string	ID or acronym of the actor
type		1..1	code	person \| entity ExampleScenarioActorType (Required)
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
resourceId		1..1	string	The id of the resource for referencing
resourceType		1..1	code	The type of the resource ResourceType (Required)
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
versionId		1..1	string	The identifier of a specific version of a resource
description		1..1	markdown	The description of the resource version
containedInstance		0..*	BackboneElement	Resources contained in the instance
resourceId		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
title	Σ	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..*	see process	Nested process
pause		0..1	boolean	If there is a pause in the flow
operation		0..1	BackboneElement	Each interaction or action
number		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	see containedInstance	Each resource instance used by the initiator
response		0..1	see containedInstance	Each resource instance used by the responder
alternative		0..1	BackboneElement	Each interaction in the process
name		0..1	string	The name of each alternative
option		1..*	BackboneElement	Each of the possible options in an alternative
description		1..1	markdown	A human-readable description of each option
step		0..*	see step	What happens in each alternative option
pause		0..*	boolean	If there is a pause in the flow
workflow		0..*	canonical	Another nested workflow
Documentation for this format

UML Diagram (Legend)

XML Template

<ExampleScenario xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this example scenario, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the example scenario --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the example scenario -->
 <name value="[string]"/><!-- 0..1 Name for this example scenario (computer friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for example scenario (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <purpose value="[markdown]"/><!-- 0..1 The purpose of the example, e.g. to illustrate a scenario -->
 <actor>  <!-- 0..* Actor participating in the resource -->
  <actorId value="[string]"/><!-- 1..1 ID or acronym of the actor -->
  <type value="[code]"/><!-- 1..1 person | entity -->
  <name value="[string]"/><!-- 0..1 The name of the actor as shown in the page -->
  <description value="[markdown]"/><!-- 0..1 The description of the actor -->
 </actor>
 <instance>  <!-- 0..* Each resource and each version that is present in the workflow -->
  <resourceId value="[string]"/><!-- 1..1 The id of the resource for referencing -->
  <resourceType value="[code]"/><!-- 1..1 The type of the resource -->
  <name value="[string]"/><!-- 0..1 A short name for the resource instance -->
  <description value="[markdown]"/><!-- 0..1 Human-friendly description of the resource instance -->
  <version>  <!-- 0..* A specific version of the resource -->
   <versionId value="[string]"/><!-- 1..1 The identifier of a specific version of a resource -->
   <description value="[markdown]"/><!-- 1..1 The description of the resource version -->
  </version>
  <containedInstance>  <!-- 0..* Resources contained in the instance -->
   <resourceId value="[string]"/><!-- 1..1 Each resource contained in the instance -->
   <versionId value="[string]"/><!-- 0..1 A specific version of a resource contained in the instance -->
  </containedInstance>
 </instance>
 <process>  <!-- 0..* Each major process - a group of operations -->
  <title value="[string]"/><!-- 1..1 The diagram title of the group of operations -->
  <description value="[markdown]"/><!-- 0..1 A longer description of the group of operations -->
  <preConditions value="[markdown]"/><!-- 0..1 Description of initial status before the process starts -->
  <postConditions value="[markdown]"/><!-- 0..1 Description of final status after the process ends -->
  <step>  <!-- 0..* Each step of the process -->
   <process><!-- 0..* Content as for ExampleScenario.process Nested process --></process>
   <pause value="[boolean]"/><!-- 0..1 If there is a pause in the flow -->
   <operation>  <!-- 0..1 Each interaction or action -->
    <number value="[string]"/><!-- 1..1 The sequential number of the interaction -->
    <type value="[string]"/><!-- 0..1 The type of operation - CRUD -->
    <name value="[string]"/><!-- 0..1 The human-friendly name of the interaction -->
    <initiator value="[string]"/><!-- 0..1 Who starts the transaction -->
    <receiver value="[string]"/><!-- 0..1 Who receives the transaction -->
    <description value="[markdown]"/><!-- 0..1 A comment to be inserted in the diagram -->
    <initiatorActive value="[boolean]"/><!-- 0..1 Whether the initiator is deactivated right after the transaction -->
    <receiverActive value="[boolean]"/><!-- 0..1 Whether the receiver is deactivated right after the transaction -->
    <request><!-- 0..1 Content as for ExampleScenario.instance.containedInstance Each resource instance used by the initiator --></request>
    <response><!-- 0..1 Content as for ExampleScenario.instance.containedInstance Each resource instance used by the responder --></response>
   </operation>
   <alternative>  <!-- 0..1 Each interaction in the process -->
    <name value="[string]"/><!-- 0..1 The name of each alternative -->
    <option>  <!-- 1..* Each of the possible options in an alternative -->
     <description value="[markdown]"/><!-- 1..1 A human-readable description of each option -->
     <step><!-- 0..* Content as for ExampleScenario.process.step What happens in each alternative option --></step>
     <pause value="[boolean]"/><!-- 0..* If there is a pause in the flow -->
    </option>
   </alternative>
  </step>
 </process>
 <workflow><!-- 0..* canonical(ExampleScenario) Another nested workflow --></workflow>
</ExampleScenario>

JSON Template

{
  "resourceType" : "ExampleScenario",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this example scenario, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the example scenario
  "version" : "<string>", // Business version of the example scenario
  "name" : "<string>", // Name for this example scenario (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for example scenario (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "purpose" : "<markdown>", // The purpose of the example, e.g. to illustrate a scenario
  "actor" : [{ // Actor participating in the resource
    "actorId" : "<string>", // R!  ID or acronym of the actor
    "type" : "<code>", // R!  person | entity
    "name" : "<string>", // The name of the actor as shown in the page
    "description" : "<markdown>" // The description of the actor
  }],
  "instance" : [{ // Each resource and each version that is present in the workflow
    "resourceId" : "<string>", // R!  The id of the resource for referencing
    "resourceType" : "<code>", // R!  The type of the resource
    "name" : "<string>", // A short name for the resource instance
    "description" : "<markdown>", // Human-friendly description of the resource instance
    "version" : [{ // A specific version of the resource
      "versionId" : "<string>", // R!  The identifier of a specific version of a resource
      "description" : "<markdown>" // R!  The description of the resource version
    }],
    "containedInstance" : [{ // Resources contained in the instance
      "resourceId" : "<string>", // R!  Each resource contained in the instance
      "versionId" : "<string>" // A specific version of a resource contained in the instance
    }]
  }],
  "process" : [{ // Each major process - a group of operations
    "title" : "<string>", // R!  The diagram title of the group of operations
    "description" : "<markdown>", // A longer description of the group of operations
    "preConditions" : "<markdown>", // Description of initial status before the process starts
    "postConditions" : "<markdown>", // Description of final status after the process ends
    "step" : [{ // Each step of the process
      "process" : [{ Content as for ExampleScenario.process }], // Nested process
      "pause" : <boolean>, // If there is a pause in the flow
      "operation" : { // Each interaction or action
        "number" : "<string>", // R!  The sequential number of the interaction
        "type" : "<string>", // The type of operation - CRUD
        "name" : "<string>", // The human-friendly name of the interaction
        "initiator" : "<string>", // Who starts the transaction
        "receiver" : "<string>", // Who receives the transaction
        "description" : "<markdown>", // A comment to be inserted in the diagram
        "initiatorActive" : <boolean>, // Whether the initiator is deactivated right after the transaction
        "receiverActive" : <boolean>, // Whether the receiver is deactivated right after the transaction
        "request" : { Content as for ExampleScenario.instance.containedInstance }, // Each resource instance used by the initiator
        "response" : { Content as for ExampleScenario.instance.containedInstance } // Each resource instance used by the responder
      },
      "alternative" : { // Each interaction in the process
        "name" : "<string>", // The name of each alternative
        "option" : [{ // R!  Each of the possible options in an alternative
          "description" : "<markdown>", // R!  A human-readable description of each option
          "step" : [{ Content as for ExampleScenario.process.step }], // What happens in each alternative option
          "pause" : [<boolean>] // If there is a pause in the flow
        }]
      }
    }]
  }],
  "workflow" : ["<canonical>"] // Another nested workflow
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:ExampleScenario;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ExampleScenario.url [ uri ]; # 0..1 Canonical identifier for this example scenario, represented as a URI (globally unique)
  fhir:ExampleScenario.identifier [ Identifier ], ... ; # 0..* Additional identifier for the example scenario
  fhir:ExampleScenario.version [ string ]; # 0..1 Business version of the example scenario
  fhir:ExampleScenario.name [ string ]; # 0..1 Name for this example scenario (computer friendly)
  fhir:ExampleScenario.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ExampleScenario.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ExampleScenario.date [ dateTime ]; # 0..1 Date last changed
  fhir:ExampleScenario.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ExampleScenario.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ExampleScenario.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ExampleScenario.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for example scenario (if applicable)
  fhir:ExampleScenario.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ExampleScenario.purpose [ markdown ]; # 0..1 The purpose of the example, e.g. to illustrate a scenario
  fhir:ExampleScenario.actor [ # 0..* Actor participating in the resource
    fhir:ExampleScenario.actor.actorId [ string ]; # 1..1 ID or acronym of the actor
    fhir:ExampleScenario.actor.type [ code ]; # 1..1 person | entity
    fhir:ExampleScenario.actor.name [ string ]; # 0..1 The name of the actor as shown in the page
    fhir:ExampleScenario.actor.description [ markdown ]; # 0..1 The description of the actor
  ], ...;
  fhir:ExampleScenario.instance [ # 0..* Each resource and each version that is present in the workflow
    fhir:ExampleScenario.instance.resourceId [ string ]; # 1..1 The id of the resource for referencing
    fhir:ExampleScenario.instance.resourceType [ code ]; # 1..1 The type of the resource
    fhir:ExampleScenario.instance.name [ string ]; # 0..1 A short name for the resource instance
    fhir:ExampleScenario.instance.description [ markdown ]; # 0..1 Human-friendly description of the resource instance
    fhir:ExampleScenario.instance.version [ # 0..* A specific version of the resource
      fhir:ExampleScenario.instance.version.versionId [ string ]; # 1..1 The identifier of a specific version of a resource
      fhir:ExampleScenario.instance.version.description [ markdown ]; # 1..1 The description of the resource version
    ], ...;
    fhir:ExampleScenario.instance.containedInstance [ # 0..* Resources contained in the instance
      fhir:ExampleScenario.instance.containedInstance.resourceId [ string ]; # 1..1 Each resource contained in the instance
      fhir:ExampleScenario.instance.containedInstance.versionId [ string ]; # 0..1 A specific version of a resource contained in the instance
    ], ...;
  ], ...;
  fhir:ExampleScenario.process [ # 0..* Each major process - a group of operations
    fhir:ExampleScenario.process.title [ string ]; # 1..1 The diagram title of the group of operations
    fhir:ExampleScenario.process.description [ markdown ]; # 0..1 A longer description of the group of operations
    fhir:ExampleScenario.process.preConditions [ markdown ]; # 0..1 Description of initial status before the process starts
    fhir:ExampleScenario.process.postConditions [ markdown ]; # 0..1 Description of final status after the process ends
    fhir:ExampleScenario.process.step [ # 0..* Each step of the process
      fhir:ExampleScenario.process.step.process [ See ExampleScenario.process ], ... ; # 0..* Nested process
      fhir:ExampleScenario.process.step.pause [ boolean ]; # 0..1 If there is a pause in the flow
      fhir:ExampleScenario.process.step.operation [ # 0..1 Each interaction or action
        fhir:ExampleScenario.process.step.operation.number [ string ]; # 1..1 The sequential number of the interaction
        fhir:ExampleScenario.process.step.operation.type [ string ]; # 0..1 The type of operation - CRUD
        fhir:ExampleScenario.process.step.operation.name [ string ]; # 0..1 The human-friendly name of the interaction
        fhir:ExampleScenario.process.step.operation.initiator [ string ]; # 0..1 Who starts the transaction
        fhir:ExampleScenario.process.step.operation.receiver [ string ]; # 0..1 Who receives the transaction
        fhir:ExampleScenario.process.step.operation.description [ markdown ]; # 0..1 A comment to be inserted in the diagram
        fhir:ExampleScenario.process.step.operation.initiatorActive [ boolean ]; # 0..1 Whether the initiator is deactivated right after the transaction
        fhir:ExampleScenario.process.step.operation.receiverActive [ boolean ]; # 0..1 Whether the receiver is deactivated right after the transaction
        fhir:ExampleScenario.process.step.operation.request [ See ExampleScenario.instance.containedInstance ]; # 0..1 Each resource instance used by the initiator
        fhir:ExampleScenario.process.step.operation.response [ See ExampleScenario.instance.containedInstance ]; # 0..1 Each resource instance used by the responder
      ];
      fhir:ExampleScenario.process.step.alternative [ # 0..1 Each interaction in the process
        fhir:ExampleScenario.process.step.alternative.name [ string ]; # 0..1 The name of each alternative
        fhir:ExampleScenario.process.step.alternative.option [ # 1..* Each of the possible options in an alternative
          fhir:ExampleScenario.process.step.alternative.option.description [ markdown ]; # 1..1 A human-readable description of each option
          fhir:ExampleScenario.process.step.alternative.option.step [ See ExampleScenario.process.step ], ... ; # 0..* What happens in each alternative option
          fhir:ExampleScenario.process.step.alternative.option.pause [ boolean ], ... ; # 0..* If there is a pause in the flow
        ], ...;
      ];
    ], ...;
  ], ...;
  fhir:ExampleScenario.workflow [ canonical(ExampleScenario) ], ... ; # 0..* Another nested workflow
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
ExampleScenario	D		DomainResource	Example of workflow instance Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
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)
status	?!Σ	1..1	code	draft \| active \| retired \| unknown PublicationStatus (Required)
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) Jurisdiction ValueSet (Extensible)
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
actorId		1..1	string	ID or acronym of the actor
type		1..1	code	person \| entity ExampleScenarioActorType (Required)
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
resourceId		1..1	string	The id of the resource for referencing
resourceType		1..1	code	The type of the resource ResourceType (Required)
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
versionId		1..1	string	The identifier of a specific version of a resource
description		1..1	markdown	The description of the resource version
containedInstance		0..*	BackboneElement	Resources contained in the instance
resourceId		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
title	Σ	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..*	see process	Nested process
pause		0..1	boolean	If there is a pause in the flow
operation		0..1	BackboneElement	Each interaction or action
number		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	see containedInstance	Each resource instance used by the initiator
response		0..1	see containedInstance	Each resource instance used by the responder
alternative		0..1	BackboneElement	Each interaction in the process
name		0..1	string	The name of each alternative
option		1..*	BackboneElement	Each of the possible options in an alternative
description		1..1	markdown	A human-readable description of each option
step		0..*	see step	What happens in each alternative option
pause		0..*	boolean	If there is a pause in the flow
workflow		0..*	canonical	Another nested workflow
Documentation for this format

UML Diagram (Legend)

XML Template

<ExampleScenario xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this example scenario, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the example scenario --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the example scenario -->
 <name value="[string]"/><!-- 0..1 Name for this example scenario (computer friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for example scenario (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <purpose value="[markdown]"/><!-- 0..1 The purpose of the example, e.g. to illustrate a scenario -->
 <actor>  <!-- 0..* Actor participating in the resource -->
  <actorId value="[string]"/><!-- 1..1 ID or acronym of the actor -->
  <type value="[code]"/><!-- 1..1 person | entity -->
  <name value="[string]"/><!-- 0..1 The name of the actor as shown in the page -->
  <description value="[markdown]"/><!-- 0..1 The description of the actor -->
 </actor>
 <instance>  <!-- 0..* Each resource and each version that is present in the workflow -->
  <resourceId value="[string]"/><!-- 1..1 The id of the resource for referencing -->
  <resourceType value="[code]"/><!-- 1..1 The type of the resource -->
  <name value="[string]"/><!-- 0..1 A short name for the resource instance -->
  <description value="[markdown]"/><!-- 0..1 Human-friendly description of the resource instance -->
  <version>  <!-- 0..* A specific version of the resource -->
   <versionId value="[string]"/><!-- 1..1 The identifier of a specific version of a resource -->
   <description value="[markdown]"/><!-- 1..1 The description of the resource version -->
  </version>
  <containedInstance>  <!-- 0..* Resources contained in the instance -->
   <resourceId value="[string]"/><!-- 1..1 Each resource contained in the instance -->
   <versionId value="[string]"/><!-- 0..1 A specific version of a resource contained in the instance -->
  </containedInstance>
 </instance>
 <process>  <!-- 0..* Each major process - a group of operations -->
  <title value="[string]"/><!-- 1..1 The diagram title of the group of operations -->
  <description value="[markdown]"/><!-- 0..1 A longer description of the group of operations -->
  <preConditions value="[markdown]"/><!-- 0..1 Description of initial status before the process starts -->
  <postConditions value="[markdown]"/><!-- 0..1 Description of final status after the process ends -->
  <step>  <!-- 0..* Each step of the process -->
   <process><!-- 0..* Content as for ExampleScenario.process Nested process --></process>
   <pause value="[boolean]"/><!-- 0..1 If there is a pause in the flow -->
   <operation>  <!-- 0..1 Each interaction or action -->
    <number value="[string]"/><!-- 1..1 The sequential number of the interaction -->
    <type value="[string]"/><!-- 0..1 The type of operation - CRUD -->
    <name value="[string]"/><!-- 0..1 The human-friendly name of the interaction -->
    <initiator value="[string]"/><!-- 0..1 Who starts the transaction -->
    <receiver value="[string]"/><!-- 0..1 Who receives the transaction -->
    <description value="[markdown]"/><!-- 0..1 A comment to be inserted in the diagram -->
    <initiatorActive value="[boolean]"/><!-- 0..1 Whether the initiator is deactivated right after the transaction -->
    <receiverActive value="[boolean]"/><!-- 0..1 Whether the receiver is deactivated right after the transaction -->
    <request><!-- 0..1 Content as for ExampleScenario.instance.containedInstance Each resource instance used by the initiator --></request>
    <response><!-- 0..1 Content as for ExampleScenario.instance.containedInstance Each resource instance used by the responder --></response>
   </operation>
   <alternative>  <!-- 0..1 Each interaction in the process -->
    <name value="[string]"/><!-- 0..1 The name of each alternative -->
    <option>  <!-- 1..* Each of the possible options in an alternative -->
     <description value="[markdown]"/><!-- 1..1 A human-readable description of each option -->
     <step><!-- 0..* Content as for ExampleScenario.process.step What happens in each alternative option --></step>
     <pause value="[boolean]"/><!-- 0..* If there is a pause in the flow -->
    </option>
   </alternative>
  </step>
 </process>
 <workflow><!-- 0..* canonical(ExampleScenario) Another nested workflow --></workflow>
</ExampleScenario>

JSON Template

{
  "resourceType" : "ExampleScenario",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this example scenario, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the example scenario
  "version" : "<string>", // Business version of the example scenario
  "name" : "<string>", // Name for this example scenario (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for example scenario (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "purpose" : "<markdown>", // The purpose of the example, e.g. to illustrate a scenario
  "actor" : [{ // Actor participating in the resource
    "actorId" : "<string>", // R!  ID or acronym of the actor
    "type" : "<code>", // R!  person | entity
    "name" : "<string>", // The name of the actor as shown in the page
    "description" : "<markdown>" // The description of the actor
  }],
  "instance" : [{ // Each resource and each version that is present in the workflow
    "resourceId" : "<string>", // R!  The id of the resource for referencing
    "resourceType" : "<code>", // R!  The type of the resource
    "name" : "<string>", // A short name for the resource instance
    "description" : "<markdown>", // Human-friendly description of the resource instance
    "version" : [{ // A specific version of the resource
      "versionId" : "<string>", // R!  The identifier of a specific version of a resource
      "description" : "<markdown>" // R!  The description of the resource version
    }],
    "containedInstance" : [{ // Resources contained in the instance
      "resourceId" : "<string>", // R!  Each resource contained in the instance
      "versionId" : "<string>" // A specific version of a resource contained in the instance
    }]
  }],
  "process" : [{ // Each major process - a group of operations
    "title" : "<string>", // R!  The diagram title of the group of operations
    "description" : "<markdown>", // A longer description of the group of operations
    "preConditions" : "<markdown>", // Description of initial status before the process starts
    "postConditions" : "<markdown>", // Description of final status after the process ends
    "step" : [{ // Each step of the process
      "process" : [{ Content as for ExampleScenario.process }], // Nested process
      "pause" : <boolean>, // If there is a pause in the flow
      "operation" : { // Each interaction or action
        "number" : "<string>", // R!  The sequential number of the interaction
        "type" : "<string>", // The type of operation - CRUD
        "name" : "<string>", // The human-friendly name of the interaction
        "initiator" : "<string>", // Who starts the transaction
        "receiver" : "<string>", // Who receives the transaction
        "description" : "<markdown>", // A comment to be inserted in the diagram
        "initiatorActive" : <boolean>, // Whether the initiator is deactivated right after the transaction
        "receiverActive" : <boolean>, // Whether the receiver is deactivated right after the transaction
        "request" : { Content as for ExampleScenario.instance.containedInstance }, // Each resource instance used by the initiator
        "response" : { Content as for ExampleScenario.instance.containedInstance } // Each resource instance used by the responder
      },
      "alternative" : { // Each interaction in the process
        "name" : "<string>", // The name of each alternative
        "option" : [{ // R!  Each of the possible options in an alternative
          "description" : "<markdown>", // R!  A human-readable description of each option
          "step" : [{ Content as for ExampleScenario.process.step }], // What happens in each alternative option
          "pause" : [<boolean>] // If there is a pause in the flow
        }]
      }
    }]
  }],
  "workflow" : ["<canonical>"] // Another nested workflow
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:ExampleScenario;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ExampleScenario.url [ uri ]; # 0..1 Canonical identifier for this example scenario, represented as a URI (globally unique)
  fhir:ExampleScenario.identifier [ Identifier ], ... ; # 0..* Additional identifier for the example scenario
  fhir:ExampleScenario.version [ string ]; # 0..1 Business version of the example scenario
  fhir:ExampleScenario.name [ string ]; # 0..1 Name for this example scenario (computer friendly)
  fhir:ExampleScenario.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ExampleScenario.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ExampleScenario.date [ dateTime ]; # 0..1 Date last changed
  fhir:ExampleScenario.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ExampleScenario.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ExampleScenario.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ExampleScenario.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for example scenario (if applicable)
  fhir:ExampleScenario.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ExampleScenario.purpose [ markdown ]; # 0..1 The purpose of the example, e.g. to illustrate a scenario
  fhir:ExampleScenario.actor [ # 0..* Actor participating in the resource
    fhir:ExampleScenario.actor.actorId [ string ]; # 1..1 ID or acronym of the actor
    fhir:ExampleScenario.actor.type [ code ]; # 1..1 person | entity
    fhir:ExampleScenario.actor.name [ string ]; # 0..1 The name of the actor as shown in the page
    fhir:ExampleScenario.actor.description [ markdown ]; # 0..1 The description of the actor
  ], ...;
  fhir:ExampleScenario.instance [ # 0..* Each resource and each version that is present in the workflow
    fhir:ExampleScenario.instance.resourceId [ string ]; # 1..1 The id of the resource for referencing
    fhir:ExampleScenario.instance.resourceType [ code ]; # 1..1 The type of the resource
    fhir:ExampleScenario.instance.name [ string ]; # 0..1 A short name for the resource instance
    fhir:ExampleScenario.instance.description [ markdown ]; # 0..1 Human-friendly description of the resource instance
    fhir:ExampleScenario.instance.version [ # 0..* A specific version of the resource
      fhir:ExampleScenario.instance.version.versionId [ string ]; # 1..1 The identifier of a specific version of a resource
      fhir:ExampleScenario.instance.version.description [ markdown ]; # 1..1 The description of the resource version
    ], ...;
    fhir:ExampleScenario.instance.containedInstance [ # 0..* Resources contained in the instance
      fhir:ExampleScenario.instance.containedInstance.resourceId [ string ]; # 1..1 Each resource contained in the instance
      fhir:ExampleScenario.instance.containedInstance.versionId [ string ]; # 0..1 A specific version of a resource contained in the instance
    ], ...;
  ], ...;
  fhir:ExampleScenario.process [ # 0..* Each major process - a group of operations
    fhir:ExampleScenario.process.title [ string ]; # 1..1 The diagram title of the group of operations
    fhir:ExampleScenario.process.description [ markdown ]; # 0..1 A longer description of the group of operations
    fhir:ExampleScenario.process.preConditions [ markdown ]; # 0..1 Description of initial status before the process starts
    fhir:ExampleScenario.process.postConditions [ markdown ]; # 0..1 Description of final status after the process ends
    fhir:ExampleScenario.process.step [ # 0..* Each step of the process
      fhir:ExampleScenario.process.step.process [ See ExampleScenario.process ], ... ; # 0..* Nested process
      fhir:ExampleScenario.process.step.pause [ boolean ]; # 0..1 If there is a pause in the flow
      fhir:ExampleScenario.process.step.operation [ # 0..1 Each interaction or action
        fhir:ExampleScenario.process.step.operation.number [ string ]; # 1..1 The sequential number of the interaction
        fhir:ExampleScenario.process.step.operation.type [ string ]; # 0..1 The type of operation - CRUD
        fhir:ExampleScenario.process.step.operation.name [ string ]; # 0..1 The human-friendly name of the interaction
        fhir:ExampleScenario.process.step.operation.initiator [ string ]; # 0..1 Who starts the transaction
        fhir:ExampleScenario.process.step.operation.receiver [ string ]; # 0..1 Who receives the transaction
        fhir:ExampleScenario.process.step.operation.description [ markdown ]; # 0..1 A comment to be inserted in the diagram
        fhir:ExampleScenario.process.step.operation.initiatorActive [ boolean ]; # 0..1 Whether the initiator is deactivated right after the transaction
        fhir:ExampleScenario.process.step.operation.receiverActive [ boolean ]; # 0..1 Whether the receiver is deactivated right after the transaction
        fhir:ExampleScenario.process.step.operation.request [ See ExampleScenario.instance.containedInstance ]; # 0..1 Each resource instance used by the initiator
        fhir:ExampleScenario.process.step.operation.response [ See ExampleScenario.instance.containedInstance ]; # 0..1 Each resource instance used by the responder
      ];
      fhir:ExampleScenario.process.step.alternative [ # 0..1 Each interaction in the process
        fhir:ExampleScenario.process.step.alternative.name [ string ]; # 0..1 The name of each alternative
        fhir:ExampleScenario.process.step.alternative.option [ # 1..* Each of the possible options in an alternative
          fhir:ExampleScenario.process.step.alternative.option.description [ markdown ]; # 1..1 A human-readable description of each option
          fhir:ExampleScenario.process.step.alternative.option.step [ See ExampleScenario.process.step ], ... ; # 0..* What happens in each alternative option
          fhir:ExampleScenario.process.step.alternative.option.pause [ boolean ], ... ; # 0..* If there is a pause in the flow
        ], ...;
      ];
    ], ...;
  ], ...;
  fhir:ExampleScenario.workflow [ canonical(ExampleScenario) ], ... ; # 0..* Another nested workflow
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

12.25.2.1 Terminology Bindings

Path	Definition	Type	Reference
ExampleScenario.status	The lifecycle status of an artifact.	Required	PublicationStatus
ExampleScenario.jurisdiction	Countries and regions within which this artifact is targeted for use	Extensible	Jurisdiction ValueSet
ExampleScenario.actor.type	The type of actor - system or human	Required	ExampleScenarioActorType
ExampleScenario.instance.resourceType	The type of resource	Required	ResourceType

Path

Definition

Type

Reference

ExampleScenario.status

The lifecycle status of an artifact.

Required

PublicationStatus

ExampleScenario.jurisdiction

Countries and regions within which this artifact is targeted for use

Extensible

Jurisdiction ValueSet

ExampleScenario.actor.type

The type of actor - system or human

Required

ExampleScenarioActorType

ExampleScenario.instance.resourceType

The type of resource

Required

ResourceType

12.25.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
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