Release 4 5 Preview #3
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

12.23 12.28 Resource ExampleScenario - Content

FHIR Infrastructure Work Group Maturity Level : 0   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

Example of workflow instance.

12.23.1 12.28.1 Scope and Usage

Todo

12.28.2 References

This resource is referenced by itself itself.

This resource does not implement any patterns.

12.23.2 12.28.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . ExampleScenario I TU DomainResource CanonicalResource Example of workflow instance
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright
. . . 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
. . . 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 ( Extensible )
. . . copyright purpose 0..1 markdown Use and/or publishing restrictions The purpose of the example, e.g. to illustrate a scenario
. . . purpose copyright 0..1 markdown The purpose of the example, e.g. to illustrate a scenario Use and/or publishing restrictions
. . . 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..* BackboneElement Alternate non-typical step action
. . . . . . title 1..1 string Label for alternative
. . . . . . description 0..1 markdown A human-readable description of each option
. . . . . . step 0..* see step What happens in each alternative option
. . . workflow 0..* canonical ( ExampleScenario ) Another nested workflow

doco Documentation for this format

UML Diagram ( Legend )

ExampleScenario ( DomainResource CanonicalResource ) An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers url : uri [0..1] 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 identifier : Identifier [0..*] 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 version : string [0..1] 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 name : string [0..1] The status of this example scenario. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » 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 experimental : boolean [0..1] The date (and optionally time) when the example scenario was published. The date must change 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') date : dateTime [0..1] The name of the organization or individual that published the example scenario publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances useContext : UsageContext [0..*] A legal or geographic region in which the example scenario is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » 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 copyright : markdown [0..1] What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario purpose : markdown [0..1] 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 copyright : markdown [0..1] Another nested workflow workflow : canonical [0..*] « ExampleScenario » Actor ID or acronym of actor actorId : string [1..1] The type of actor - person or system type : code [1..1] « The type of actor - system or human. (Strength=Required) ExampleScenarioActorType ! » The name of the actor as shown in the page name : string [0..1] The description of the actor description : markdown [0..1] Instance The id of the resource for referencing resourceId : string [1..1] The type of the resource resourceType : code [1..1] « The type of resource. (Strength=Required) ResourceType ! » A short name for the resource instance name : string [0..1] Human-friendly description of the resource instance description : markdown [0..1] Version The identifier of a specific version of a resource versionId : string [1..1] The description of the resource version description : markdown [1..1] ContainedInstance Each resource contained in the instance resourceId : string [1..1] A specific version of a resource contained in the instance versionId : string [0..1] Process The diagram title of the group of operations title : string [1..1] A longer description of the group of operations description : markdown [0..1] Description of initial status before the process starts preConditions : markdown [0..1] Description of final status after the process ends postConditions : markdown [0..1] Step If there is a pause in the flow pause : boolean [0..1] Operation The sequential number of the interaction, e.g. 1.2.5 number : string [1..1] The type of operation - CRUD type : string [0..1] The human-friendly name of the interaction name : string [0..1] Who starts the transaction initiator : string [0..1] Who receives the transaction receiver : string [0..1] A comment to be inserted in the diagram description : markdown [0..1] Whether the initiator is deactivated right after the transaction initiatorActive : boolean [0..1] Whether the receiver is deactivated right after the transaction receiverActive : boolean [0..1] Alternative The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked title : string [1..1] A human-readable description of the alternative explaining when the alternative should occur rather than the base step description : markdown [0..1] Actor participating in the resource actor [0..*] A specific version of the resource version [0..*] Resources contained in the instance (e.g. the observations contained in a bundle) containedInstance [0..*] Each resource and each version that is present in the workflow instance [0..*] Nested process process [0..*] Each resource instance used by the initiator request [0..1] Each resource instance used by the responder response [0..1] Each interaction or action operation [0..1] What happens in each alternative option step [0..*] Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances alternative [0..*] Each step of the process step [0..*] Each major process - a group of operations process [0..*]

XML Template 

<ExampleScenario xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from  -->

 <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>
 <

 <purpose value="[markdown]"/><!-- 0..1 The purpose of the example, e.g. to illustrate a scenario -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->

 <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..* Alternate non-typical step action -->
    <title value="[string]"/><!-- 1..1 Label for alternative -->
    <description value="[markdown]"/><!-- 0..1 A human-readable description of each option -->
    <step><!-- 0..* Content as for ExampleScenario.process.step What happens in each alternative option --></step>
   </alternative>
  </step>
 </process>
 <workflow><!-- 0..* canonical(ExampleScenario) Another nested workflow --></workflow>
</ExampleScenario>

JSON Template 

{doco
  "resourceType" : "ExampleScenario",
  // from Resource: id, meta, implicitRules, and language
  // from 

  "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>", // C? 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)
  "

  "purpose" : "<markdown>", // The purpose of the example, e.g. to illustrate a scenario
  "copyright" : "<markdown>", // Use and/or publishing restrictions

  "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" : [{ // Alternate non-typical step action
        "title" : "<string>", // R!  Label for alternative
        "description" : "<markdown>", // A human-readable description of each option
        "step" : [{ Content as for ExampleScenario.process.step }] // What happens in each alternative option
      }]
    }]
  }],
  "workflow" : [{ canonical(ExampleScenario) }] // Another nested workflow
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:ExampleScenario;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from 

  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:

  fhir:ExampleScenario.purpose [ markdown ]; # 0..1 The purpose of the example, e.g. to illustrate a scenario
  fhir:ExampleScenario.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions

  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..* Alternate non-typical step action
        fhir:ExampleScenario.process.step.alternative.title [ string ]; # 1..1 Label for alternative
        fhir:ExampleScenario.process.step.alternative.description [ markdown ]; # 0..1 A human-readable description of each option
        fhir:ExampleScenario.process.step.alternative.step [ See ExampleScenario.process.step ], ... ; # 0..* What happens in each alternative option
      ], ...;
    ], ...;
  ], ...;
  fhir:ExampleScenario.workflow [ canonical(ExampleScenario) ], ... ; # 0..* Another nested workflow
]

Changes since R3

ExampleScenario
ExampleScenario.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.5.0
ExampleScenario.actor.type
  • Change value set from http://hl7.org/fhir/ValueSet/examplescenario-actor-type|4.0.0 to http://hl7.org/fhir/ValueSet/examplescenario-actor-type|4.5.0
ExampleScenario.instance.resourceType
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/resource-types|4.5.0

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

Name Flags Card. Type Description & Constraints doco
. . ExampleScenario I TU DomainResource CanonicalResource Example of workflow instance
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright
. . . 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
. . . 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 ( Extensible )
. . . copyright purpose 0..1 markdown Use and/or publishing restrictions The purpose of the example, e.g. to illustrate a scenario
. . . purpose copyright 0..1 markdown The purpose of the example, e.g. to illustrate a scenario Use and/or publishing restrictions
. . . 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..* BackboneElement Alternate non-typical step action
. . . . . . title 1..1 string Label for alternative
. . . . . . description 0..1 markdown A human-readable description of each option
. . . . . . step 0..* see step What happens in each alternative option
. . . workflow 0..* canonical ( ExampleScenario ) Another nested workflow

doco Documentation for this format

UML Diagram ( Legend )

ExampleScenario ( DomainResource CanonicalResource ) An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers url : uri [0..1] 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 identifier : Identifier [0..*] 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 version : string [0..1] 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 name : string [0..1] The status of this example scenario. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » 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 experimental : boolean [0..1] The date (and optionally time) when the example scenario was published. The date must change 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') date : dateTime [0..1] The name of the organization or individual that published the example scenario publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances useContext : UsageContext [0..*] A legal or geographic region in which the example scenario is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » 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 copyright : markdown [0..1] What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario purpose : markdown [0..1] 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 copyright : markdown [0..1] Another nested workflow workflow : canonical [0..*] « ExampleScenario » Actor ID or acronym of actor actorId : string [1..1] The type of actor - person or system type : code [1..1] « The type of actor - system or human. (Strength=Required) ExampleScenarioActorType ! » The name of the actor as shown in the page name : string [0..1] The description of the actor description : markdown [0..1] Instance The id of the resource for referencing resourceId : string [1..1] The type of the resource resourceType : code [1..1] « The type of resource. (Strength=Required) ResourceType ! » A short name for the resource instance name : string [0..1] Human-friendly description of the resource instance description : markdown [0..1] Version The identifier of a specific version of a resource versionId : string [1..1] The description of the resource version description : markdown [1..1] ContainedInstance Each resource contained in the instance resourceId : string [1..1] A specific version of a resource contained in the instance versionId : string [0..1] Process The diagram title of the group of operations title : string [1..1] A longer description of the group of operations description : markdown [0..1] Description of initial status before the process starts preConditions : markdown [0..1] Description of final status after the process ends postConditions : markdown [0..1] Step If there is a pause in the flow pause : boolean [0..1] Operation The sequential number of the interaction, e.g. 1.2.5 number : string [1..1] The type of operation - CRUD type : string [0..1] The human-friendly name of the interaction name : string [0..1] Who starts the transaction initiator : string [0..1] Who receives the transaction receiver : string [0..1] A comment to be inserted in the diagram description : markdown [0..1] Whether the initiator is deactivated right after the transaction initiatorActive : boolean [0..1] Whether the receiver is deactivated right after the transaction receiverActive : boolean [0..1] Alternative The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked title : string [1..1] A human-readable description of the alternative explaining when the alternative should occur rather than the base step description : markdown [0..1] Actor participating in the resource actor [0..*] A specific version of the resource version [0..*] Resources contained in the instance (e.g. the observations contained in a bundle) containedInstance [0..*] Each resource and each version that is present in the workflow instance [0..*] Nested process process [0..*] Each resource instance used by the initiator request [0..1] Each resource instance used by the responder response [0..1] Each interaction or action operation [0..1] What happens in each alternative option step [0..*] Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances alternative [0..*] Each step of the process step [0..*] Each major process - a group of operations process [0..*]

XML Template 

<ExampleScenario xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from  -->

 <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>
 <

 <purpose value="[markdown]"/><!-- 0..1 The purpose of the example, e.g. to illustrate a scenario -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->

 <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..* Alternate non-typical step action -->
    <title value="[string]"/><!-- 1..1 Label for alternative -->
    <description value="[markdown]"/><!-- 0..1 A human-readable description of each option -->
    <step><!-- 0..* Content as for ExampleScenario.process.step What happens in each alternative option --></step>
   </alternative>
  </step>
 </process>
 <workflow><!-- 0..* canonical(ExampleScenario) Another nested workflow --></workflow>
</ExampleScenario>

JSON Template 

{doco
  "resourceType" : "ExampleScenario",
  // from Resource: id, meta, implicitRules, and language
  // from 

  "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>", // C? 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)
  "

  "purpose" : "<markdown>", // The purpose of the example, e.g. to illustrate a scenario
  "copyright" : "<markdown>", // Use and/or publishing restrictions

  "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" : [{ // Alternate non-typical step action
        "title" : "<string>", // R!  Label for alternative
        "description" : "<markdown>", // A human-readable description of each option
        "step" : [{ Content as for ExampleScenario.process.step }] // What happens in each alternative option
      }]
    }]
  }],
  "workflow" : [{ canonical(ExampleScenario) }] // Another nested workflow
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:ExampleScenario;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from 

  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:

  fhir:ExampleScenario.purpose [ markdown ]; # 0..1 The purpose of the example, e.g. to illustrate a scenario
  fhir:ExampleScenario.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions

  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..* Alternate non-typical step action
        fhir:ExampleScenario.process.step.alternative.title [ string ]; # 1..1 Label for alternative
        fhir:ExampleScenario.process.step.alternative.description [ markdown ]; # 0..1 A human-readable description of each option
        fhir:ExampleScenario.process.step.alternative.step [ See ExampleScenario.process.step ], ... ; # 0..* What happens in each alternative option
      ], ...;
    ], ...;
  ], ...;
  fhir:ExampleScenario.workflow [ canonical(ExampleScenario) ], ... ; # 0..* Another nested workflow
]

Changes since Release 3

ExampleScenario
ExampleScenario.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.5.0
ExampleScenario.actor.type
  • Change value set from http://hl7.org/fhir/ValueSet/examplescenario-actor-type|4.0.0 to http://hl7.org/fhir/ValueSet/examplescenario-actor-type|4.5.0
ExampleScenario.instance.resourceType
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/resource-types|4.5.0

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see , the extensions spreadsheet version & the dependency analysis a

12.23.2.1 12.28.3.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

12.23.2.2 12.28.3.2 Constraints

id Level Location Description Expression
esc-0 cnl-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

12.23.3 12.28.4 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
context token A use context assigned to the example scenario (ExampleScenario.useContext.value as CodeableConcept)
context-quantity quantity A quantity- or range-valued use context assigned to the example scenario (ExampleScenario.useContext.value as Quantity) | (ExampleScenario.useContext.value as 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 On ExampleScenario.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-value composite A use context type and value assigned to the example scenario On ExampleScenario.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date N 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 N string Computationally friendly name of the example scenario ExampleScenario.name
publisher N string Name of the publisher of the example scenario ExampleScenario.publisher
status N token The current status of the example scenario ExampleScenario.status
url N uri The uri that identifies the example scenario ExampleScenario.url
version N token The business version of the example scenario ExampleScenario.version