PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.core@3.5.0
    http://hl7.org/fhir/StructureDefinition/ExampleScenario
description: Example of workflow instance.
package_name: hl7.fhir.core
derivation: specialization
name: ExampleScenario
type: ExampleScenario
elements:
  date: {short: Date last changed, type: dateTime, isSummary: true, index: 6}
  publisher: {short: Name of the publisher (organization or individual), type: string, isSummary: true, index: 7}
  instance:
    type: BackboneElement
    short: Each resource and each version that is present in the workflow
    array: true
    index: 18
    elements:
      resourceId: {type: string, short: The id of the resource for referencing, index: 19}
      resourceType:
        type: code
        short: The type of the resource
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/resource-types'}
        index: 20
      name: {type: string, short: A short name for the resource instance, index: 21}
      description: {type: markdown, short: Human-friendly description of the resource instance, index: 22}
      version:
        type: BackboneElement
        short: A specific version of the resource
        array: true
        index: 23
        elements:
          versionId: {type: string, short: The identifier of a specific version of a resource, index: 24}
          description: {type: markdown, short: The description of the resource version, index: 25}
        required: [versionId, description]
      containedInstance:
        type: BackboneElement
        short: Resources contained in the instance
        array: true
        index: 26
        elements:
          resourceId: {type: string, short: Each resource contained in the instance, index: 27}
          versionId: {type: string, short: A specific version of a resource contained in the instance, index: 28}
        required: [resourceId]
    required: [resourceId, resourceType]
  jurisdiction:
    short: Intended jurisdiction for example scenario (if applicable)
    type: CodeableConcept
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 10
  purpose: {short: 'The purpose of the example, e.g. to illustrate a scenario', type: markdown, index: 12}
  name: {short: Name for this example scenario (computer friendly), type: string, isSummary: true, index: 3}
  process:
    type: BackboneElement
    short: Each major process - a group of operations
    array: true
    index: 29
    elements:
      title: {type: string, short: The diagram title of the group of operations, isSummary: true, index: 30}
      description: {type: markdown, short: A longer description of the group of operations, index: 31}
      preConditions: {type: markdown, short: Description of initial status before the process starts, index: 32}
      postConditions: {type: markdown, short: Description of final status after the process ends, index: 33}
      step:
        type: BackboneElement
        short: Each step of the process
        array: true
        index: 34
        elements:
          process:
            short: Nested process
            elementReference: ['http://hl7.org/fhir/StructureDefinition/ExampleScenario', elements, process]
            array: true
            index: 35
          pause: {type: boolean, short: If there is a pause in the flow, index: 36}
          operation:
            type: BackboneElement
            short: Each interaction or action
            index: 37
            elements:
              response:
                short: Each resource instance used by the responder
                elementReference: ['http://hl7.org/fhir/StructureDefinition/ExampleScenario', elements, instance, elements, containedInstance]
                index: 47
              description: {type: markdown, short: A comment to be inserted in the diagram, index: 43}
              request:
                short: Each resource instance used by the initiator
                elementReference: ['http://hl7.org/fhir/StructureDefinition/ExampleScenario', elements, instance, elements, containedInstance]
                index: 46
              number: {type: string, short: The sequential number of the interaction, index: 38}
              name: {type: string, short: The human-friendly name of the interaction, index: 40}
              initiator: {type: string, short: Who starts the transaction, index: 41}
              type: {type: string, short: The type of operation - CRUD, index: 39}
              receiverActive: {type: boolean, short: Whether the receiver is deactivated right after the transaction, index: 45}
              initiatorActive: {type: boolean, short: Whether the initiator is deactivated right after the transaction, index: 44}
              receiver: {type: string, short: Who receives the transaction, index: 42}
            required: [number]
          alternative:
            type: BackboneElement
            short: Each interaction in the process
            index: 48
            elements:
              name: {type: string, short: The name of each alternative, index: 49}
              option:
                type: BackboneElement
                short: Each of the possible options in an alternative
                array: true
                min: 1
                index: 50
                elements:
                  description: {type: markdown, short: A human-readable description of each option, index: 51}
                  step:
                    short: What happens in each alternative option
                    elementReference: ['http://hl7.org/fhir/StructureDefinition/ExampleScenario', elements, process, elements, step]
                    array: true
                    index: 52
                  pause: {type: boolean, short: If there is a pause in the flow, array: true, index: 53}
                required: [description]
            required: [option]
    required: [title]
  useContext: {short: The context that the content is intended to support, type: UsageContext, array: true, isSummary: true, index: 9}
  copyright: {short: Use and/or publishing restrictions, type: markdown, index: 11}
  experimental: {short: 'For testing purposes, not real usage', type: boolean, isSummary: true, index: 5}
  workflow: {type: canonical, short: Another nested workflow, array: true, index: 54}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 4
  url: {short: 'Canonical identifier for this example scenario, represented as a URI (globally unique)', type: uri, isSummary: true, index: 0}
  identifier: {short: Additional identifier for the example scenario, type: Identifier, array: true, isSummary: true, index: 1}
  version: {short: Business version of the example scenario, type: string, isSummary: true, index: 2}
  contact: {short: Contact details for the publisher, type: ContactDetail, array: true, isSummary: true, index: 8}
  actor:
    type: BackboneElement
    short: Actor participating in the resource
    array: true
    index: 13
    elements:
      actorId: {type: string, short: ID or acronym of the actor, index: 14}
      type:
        type: code
        short: person | entity
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/examplescenario-actor-type'}
        index: 15
      name: {type: string, short: The name of the actor as shown in the page, index: 16}
      description: {type: markdown, short: The description of the actor, index: 17}
    required: [actorId, type]
package_version: 3.5.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ExampleScenario
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [status]