Skip to main content

ExampleScenario

PropertyValue
Publisher
NameExampleScenario
URLhttp://hl7.org/fhir/StructureDefinition/ExampleScenario
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
ExampleScenario0..*ExampleScenarioExample of workflow instance.
ExampleScenario.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ExampleScenario.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
ExampleScenario.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ExampleScenario.language0..1codeThe base language in which the resource is written.
ExampleScenario.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
ExampleScenario.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
ExampleScenario.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.url0..1uriAn 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.
ExampleScenario.identifier0..*IdentifierA 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.
ExampleScenario.version0..1stringThe 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.
ExampleScenario.name0..1stringA 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.
ExampleScenario.status1..1codeThe status of this example scenario. Enables tracking the life-cycle of the content.
ExampleScenario.experimental0..1booleanA 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.
ExampleScenario.date0..1dateTimeThe 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').
ExampleScenario.publisher0..1stringThe name of the organization or individual that published the example scenario.
ExampleScenario.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
ExampleScenario.useContext0..*UsageContextThe 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.
ExampleScenario.jurisdiction0..*CodeableConceptA legal or geographic region in which the example scenario is intended to be used.
ExampleScenario.copyright0..1markdownA 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.
ExampleScenario.purpose0..1markdownWhat 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.
ExampleScenario.actor0..*BackboneElementActor participating in the resource.
ExampleScenario.actor.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ExampleScenario.actor.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.actor.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.actor.actorId1..1stringID or acronym of actor.
ExampleScenario.actor.type1..1codeThe type of actor - person or system.
ExampleScenario.actor.name0..1stringThe name of the actor as shown in the page.
ExampleScenario.actor.description0..1markdownThe description of the actor.
ExampleScenario.instance0..*BackboneElementEach resource and each version that is present in the workflow.
ExampleScenario.instance.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ExampleScenario.instance.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.instance.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.instance.resourceId1..1stringThe id of the resource for referencing.
ExampleScenario.instance.resourceType1..1codeThe type of the resource.
ExampleScenario.instance.name0..1stringA short name for the resource instance.
ExampleScenario.instance.description0..1markdownHuman-friendly description of the resource instance.
ExampleScenario.instance.version0..*BackboneElementA specific version of the resource.
ExampleScenario.instance.version.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ExampleScenario.instance.version.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.instance.version.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.instance.version.versionId1..1stringThe identifier of a specific version of a resource.
ExampleScenario.instance.version.description1..1markdownThe description of the resource version.
ExampleScenario.instance.containedInstance0..*BackboneElementResources contained in the instance (e.g. the observations contained in a bundle).
ExampleScenario.instance.containedInstance.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ExampleScenario.instance.containedInstance.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.instance.containedInstance.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.instance.containedInstance.resourceId1..1stringEach resource contained in the instance.
ExampleScenario.instance.containedInstance.versionId0..1stringA specific version of a resource contained in the instance.
ExampleScenario.process0..*BackboneElementEach major process - a group of operations.
ExampleScenario.process.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ExampleScenario.process.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.process.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.process.title1..1stringThe diagram title of the group of operations.
ExampleScenario.process.description0..1markdownA longer description of the group of operations.
ExampleScenario.process.preConditions0..1markdownDescription of initial status before the process starts.
ExampleScenario.process.postConditions0..1markdownDescription of final status after the process ends.
ExampleScenario.process.step0..*BackboneElementEach step of the process.
ExampleScenario.process.step.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ExampleScenario.process.step.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.process.step.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.process.step.process0..*ExampleScenarioNested process.
ExampleScenario.process.step.pause0..1booleanIf there is a pause in the flow.
ExampleScenario.process.step.operation0..1BackboneElementEach interaction or action.
ExampleScenario.process.step.operation.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ExampleScenario.process.step.operation.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.process.step.operation.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.process.step.operation.number1..1stringThe sequential number of the interaction, e.g. 1.2.5.
ExampleScenario.process.step.operation.type0..1stringThe type of operation - CRUD.
ExampleScenario.process.step.operation.name0..1stringThe human-friendly name of the interaction.
ExampleScenario.process.step.operation.initiator0..1stringWho starts the transaction.
ExampleScenario.process.step.operation.receiver0..1stringWho receives the transaction.
ExampleScenario.process.step.operation.description0..1markdownA comment to be inserted in the diagram.
ExampleScenario.process.step.operation.initiatorActive0..1booleanWhether the initiator is deactivated right after the transaction.
ExampleScenario.process.step.operation.receiverActive0..1booleanWhether the receiver is deactivated right after the transaction.
ExampleScenario.process.step.operation.request0..1ExampleScenarioEach resource instance used by the initiator.
ExampleScenario.process.step.operation.response0..1ExampleScenarioEach resource instance used by the responder.
ExampleScenario.process.step.alternative0..*BackboneElementIndicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances.
ExampleScenario.process.step.alternative.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ExampleScenario.process.step.alternative.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ExampleScenario.process.step.alternative.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ExampleScenario.process.step.alternative.title1..1stringThe label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.
ExampleScenario.process.step.alternative.description0..1markdownA human-readable description of the alternative explaining when the alternative should occur rather than the base step.
ExampleScenario.process.step.alternative.step0..*ExampleScenarioWhat happens in each alternative option.
ExampleScenario.workflow0..*canonicalAnother nested workflow.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
contexttokenA use context assigned to the example scenario(ExampleScenario.useContext.value.ofType(CodeableConcept))
context-quantityquantityA quantity- or range-valued use context assigned to the example scenario(ExampleScenario.useContext.value.ofType(Quantity)) / (ExampleScenario.useContext.value.ofType(Range))
context-typetokenA type of use context assigned to the example scenarioExampleScenario.useContext.code
datedateThe example scenario publication dateExampleScenario.date
identifiertokenExternal identifier for the example scenarioExampleScenario.identifier
jurisdictiontokenIntended jurisdiction for the example scenarioExampleScenario.jurisdiction
namestringComputationally friendly name of the example scenarioExampleScenario.name
publisherstringName of the publisher of the example scenarioExampleScenario.publisher
statustokenThe current status of the example scenarioExampleScenario.status
urluriThe uri that identifies the example scenarioExampleScenario.url
versiontokenThe business version of the example scenarioExampleScenario.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the example scenarioExampleScenario.useContext
context-type-valuecompositeA use context type and value assigned to the example scenarioExampleScenario.useContext
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value