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