{
"description": "A walkthrough of a workflow showing the interaction between systems and the instances shared, possibly including the evolution of instances over time.",
"_filename": "StructureDefinition-ExampleScenario.json",
"package_name": "hl7.fhir.r6.core",
"date": "2025-12-18T07:07:42+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2025-12-18T07:07:42.170+11:00"
},
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot4",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "ExampleScenario",
"mapping": [ {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information",
"identity": "objimpl"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "ExampleScenario",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Specialized.Definitional Artifacts"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-implements",
"valueCanonical": "http://hl7.org/fhir/StructureDefinition/CanonicalResource"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "anonymous"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "cnl-0",
"human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')"
}, {
"key": "exs-3",
"human": "Must have actors if status is active or required",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "status='active' or status='retired' implies actor.exists()"
}, {
"key": "exs-4",
"human": "Must have processes if status is active or required",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "status='active' or status='retired' implies process.exists()"
}, {
"key": "exs-6",
"human": "Actor keys must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "actor.key.count() = actor.key.distinct().count()"
}, {
"key": "exs-7",
"human": "Actor titles must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "actor.title.count() = actor.title.distinct().count()"
}, {
"key": "exs-8",
"human": "Instance keys must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "instance.key.count() = instance.key.distinct().count()"
}, {
"key": "exs-9",
"human": "Instance titles must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "instance.title.count() = instance.title.distinct().count()"
}, {
"key": "exs-12",
"human": "Process titles must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "process.title.count() = process.title.distinct().count()"
} ],
"path": "ExampleScenario",
"min": 0,
"definition": "A computable description of the actors, interactions between those actors that would occur, and concrete examples of the data that would be exchanged in a specific hypothetical exchange, typically used to help demonstrate the interoperability expectations of a specification. This resource is used to illustrate a specific time-based exchange, not to define in general terms how exchanges can/should occur.",
"isModifier": false,
"short": "A computable description of a set of actors and the interactions between those actors",
"mapping": [ {
"map": "conformance.behavior,infrastructure.information",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario"
},
"isSummary": false
}, {
"path": "ExampleScenario.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.meta",
"min": 0,
"definition": "The 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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.implicitRules",
"min": 0,
"definition": "A 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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "ExampleScenario.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.text",
"min": 0,
"definition": "A 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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "ExampleScenario.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "ExampleScenario.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "ExampleScenario.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](resource.html#additional).",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "cnl-1",
"human": "URL should not contain | or # - these characters make processing canonical references problematic",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "exists() implies matches('^[^|# ]+$')"
}, {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.url",
"requirements": "Allows the example scenario to be referenced by a single globally unique identifier.",
"min": 0,
"definition": "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 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.",
"isModifier": false,
"short": "Canonical identifier for this example scenario, represented as a URI (globally unique)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.url",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional identifier for the example scenario",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.identifier",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.version",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Business version of the example scenario",
"mapping": [ {
"map": "FiveWs.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.version",
"comment": "There may be different example scenario instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the example scenario with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"isModifier": false,
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
},
"max": "1",
"id": "ExampleScenario.versionAlgorithm[x]",
"comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.versionAlgorithm[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.name",
"min": 0,
"definition": "A natural language name identifying the ExampleScenario. This name should be usable as an identifier for the resource by machine processing applications such as code generation.",
"isModifier": false,
"short": "Name for this example scenario (computer friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.name",
"condition": [ "cnl-0" ],
"comment": "It is not expected that ExampleScenarios will be used to generate code, as they are only examples and not definitional. However, this element is retained to remain compatible with the canonical resource interface. Systems are free to omit populating the element.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the ExampleScenario.",
"isModifier": false,
"short": "Name for this example scenario (human friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.status",
"min": 1,
"definition": "The status of this example scenario. Enables tracking the life-cycle of the content.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "ExampleScenario.status",
"condition": [ "exs-3", "exs-4", "exs-5" ],
"comment": "Allows filtering of example scenarios that are appropriate for use versus not.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.status"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired ExampleScenario without due consideration",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario.",
"min": 0,
"definition": "A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.",
"isModifier": false,
"short": "For testing only - never for real usage",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"max": "1",
"id": "ExampleScenario.experimental",
"comment": "Allows filtering of example scenarios that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).\n\nExperimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.experimental"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.date",
"min": 0,
"definition": "The date (and optionally time) when the example scenario was last significantly changed. 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').",
"isModifier": false,
"short": "Date last changed",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"alias": [ "Revision Date" ],
"max": "1",
"id": "ExampleScenario.date",
"comment": "The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the example scenario. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the example scenario. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the example scenario.",
"isModifier": false,
"short": "Name of the publisher/steward (organization or individual)",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.publisher",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the example scenario is the organization or individual primarily responsible for the maintenance and upkeep of the example scenario. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the example scenario. This item SHOULD be populated unless the information is available from context.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.publisher"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"isModifier": false,
"short": "Contact details for the publisher",
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.contact"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.description",
"min": 0,
"definition": "A free text natural language description of the ExampleScenario from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the ExampleScenario",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.description",
"comment": "This description can be used to capture details such as comments about misuse. It is not a rendering of the ExampleScenario as conveyed in the 'text' field of the resource itself.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.description"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "The context that the content is intended to support",
"type": [ {
"code": "UsageContext"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.useContext"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.",
"isModifier": false,
"short": "Jurisdiction of the authority that maintains the example scenario (if applicable)",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "ExampleScenario.jurisdiction",
"comment": "It may be possible for the example scenario to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.jurisdiction"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.purpose",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "The purpose of the example, e.g. to illustrate a scenario",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.purpose",
"comment": "This element does not describe the usage of the example scenario. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this example scenario.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.purpose"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the example scenario and/or its content.",
"min": 0,
"definition": "A copyright statement relating to the example scenario and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the example scenario.",
"isModifier": false,
"short": "Notice about intellectual property ownership, can include restrictions on use",
"mapping": [ {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "ExampleScenario.copyright",
"comment": "...",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.copyright"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"definition": "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"isModifier": false,
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.copyrightLabel",
"comment": "The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.copyrightLabel"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "exs-19",
"human": "Actor should be referenced in at least one operation",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "%resource.process.descendants().select(operation).where(initiator=%context.key or receiver=%context.key).exists()"
}, {
"key": "exs-23",
"human": "actor.key canot be 'OTHER'",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "key != 'OTHER'"
}, {
"key": "exs-24",
"human": "actor SHALL have either a type or a definition but not both",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "type.exists() xor definition.exists()"
} ],
"path": "ExampleScenario.actor",
"requirements": "This is optional to allow for ExampleScenarios that are still draft",
"min": 0,
"definition": "A system or person who shares or receives an instance within the scenario.",
"isModifier": false,
"short": "Individual involved in exchange",
"mapping": [ {
"map": "FiveWs.who",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.actor",
"condition": [ "exs-3", "exs-6", "exs-7", "exs-17", "exs-18" ],
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.)",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.actor"
},
"isSummary": false
}, {
"path": "ExampleScenario.actor.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExampleScenario.actor.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.actor.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.actor.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.actor.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ExampleScenario.actor.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.actor.key",
"min": 1,
"definition": "A unique string within the scenario that is used to reference the actor.",
"isModifier": false,
"short": "ID or acronym of the actor",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.actor.key",
"condition": [ "exs-6", "exs-23", "exs-17", "exs-18", "exs-19" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.actor.key"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.actor.type",
"min": 0,
"definition": "The category of actor - person or system.",
"isModifier": false,
"short": "person | system | collective | other",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/actordefinition-actor-type|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActorDefinitionActorType"
} ],
"description": "The type of actor - system or non-system."
},
"max": "1",
"id": "ExampleScenario.actor.type",
"condition": [ "exs-24" ],
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.actor.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.actor.title",
"min": 1,
"definition": "The human-readable name for the actor used when rendering the scenario.",
"isModifier": false,
"short": "Label for actor when rendering",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.actor.title",
"condition": [ "exs-7" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.actor.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.actor.description",
"min": 0,
"definition": "An explanation of who/what the actor is and its role in the scenario.",
"isModifier": false,
"short": "Details about actor",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.actor.description",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.actor.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.actor.definition",
"min": 0,
"definition": "The formal definition of the actor in the scenario.",
"isModifier": false,
"short": "Formal definition of actor",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActorDefinition" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.actor.definition",
"condition": [ "exs-24" ],
"comment": "The title and description appearing in this resource may differ from that in the formal definition. The type SHALL be the same.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.actor.definition"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "exs-1",
"human": "StructureVersion is required if structureType is not FHIR (but may still be present even if FHIR)",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "structureType.exists() and structureType.memberOf('http://hl7.org/fhir/ValueSet/resource-types').not() implies structureVersion.exists()"
}, {
"key": "exs-2",
"human": "instance.content is only allowed if there are no instance.versions",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "content.exists() implies version.empty()"
}, {
"key": "exs-10",
"human": "Version keys must be unique within an instance",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "version.key.count() = version.key.distinct().count()"
}, {
"key": "exs-11",
"human": "Version titles must be unique within an instance",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "version.title.count() = version.title.distinct().count()"
}, {
"key": "exs-20",
"human": "Instance should be referenced in at least one location",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "%resource.process.descendants().select(instanceReference).where($this=%context.key).exists()"
}, {
"key": "exs-21",
"human": "Instance version should be referenced in at least one operation",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "version.exists() implies version.key.intersect(%resource.process.descendants().where(instanceReference = %context.key).versionReference).exists()"
} ],
"path": "ExampleScenario.instance",
"min": 0,
"definition": "A single data collection that is shared as part of the scenario.",
"isModifier": false,
"short": "Data used in the scenario",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.instance",
"condition": [ "exs-8", "exs-9", "exs-14", "exs-15", "exs-16" ],
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.instance"
},
"isSummary": false
}, {
"path": "ExampleScenario.instance.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExampleScenario.instance.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.instance.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ExampleScenario.instance.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.key",
"min": 1,
"definition": "A unique string within the scenario that is used to reference the instance.",
"isModifier": false,
"short": "ID or acronym of the instance",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.key",
"condition": [ "exs-8", "exs-14", "exs-15", "exs-16", "exs-20", "exs-21" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.instance.key"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.structureType",
"min": 1,
"definition": "A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.",
"isModifier": false,
"short": "Data structure for example",
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/examplescenario-instance-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InstanceType"
} ],
"description": "The structure that defines the instance"
},
"max": "1",
"id": "ExampleScenario.instance.structureType",
"condition": [ "exs-1" ],
"comment": "This element may be omitted if describing a step that doesn't involve the sharing of a data structure - e.g. a human action",
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.instance.structureType"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.structureVersion",
"min": 0,
"definition": "Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.",
"isModifier": false,
"short": "E.g. 4.0.1",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"meaningWhenMissing": "If the structureType is a FHIR resource, then the version is the same FHIR version this ExampleScenario is expressed in.",
"max": "1",
"id": "ExampleScenario.instance.structureVersion",
"condition": [ "exs-1" ],
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.instance.structureVersion"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.structureProfile[x]",
"min": 0,
"definition": "Refers to a profile, template or other ruleset the instance adheres to.",
"isModifier": false,
"short": "Rules instance adheres to",
"type": [ {
"code": "canonical"
}, {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.structureProfile[x]",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.instance.structureProfile[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.title",
"min": 1,
"definition": "A short descriptive label the instance to be used in tables or diagrams.",
"isModifier": false,
"short": "Label for instance",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.instance.title",
"condition": [ "exs-9" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.instance.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.description",
"min": 0,
"definition": "An explanation of what the instance contains and what it's for.",
"isModifier": false,
"short": "Human-friendly description of the instance",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.instance.description",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.instance.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.content",
"min": 0,
"definition": "Points to an instance (typically an example) that shows the data that would corespond to this instance.",
"isModifier": false,
"short": "Example instance data",
"type": [ {
"code": "Reference"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.content",
"condition": [ "exs-2" ],
"comment": "If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.instance.content"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.version",
"requirements": "Allows representing the 'same' instance as it evolves throughout the scenario.",
"min": 0,
"definition": "Represents the instance as it was at a specific time-point.",
"isModifier": false,
"short": "Snapshot of instance that changes",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.instance.version",
"condition": [ "exs-10", "exs-11", "exs-15", "exs-16", "exs-2", "exs-21" ],
"comment": "Not used if an instance doesn't change",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.instance.version"
},
"isSummary": false
}, {
"path": "ExampleScenario.instance.version.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExampleScenario.instance.version.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.version.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.instance.version.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.version.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ExampleScenario.instance.version.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.version.key",
"min": 1,
"definition": "A unique string within the instance that is used to reference the version of the instance.",
"isModifier": false,
"short": "ID or acronym of the version",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.version.key",
"condition": [ "exs-10", "exs-16", "exs-21" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.instance.version.key"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.version.title",
"min": 1,
"definition": "A short descriptive label the version to be used in tables or diagrams.",
"isModifier": false,
"short": "Label for instance version",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.version.title",
"condition": [ "exs-11" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.instance.version.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.version.description",
"min": 0,
"definition": "An explanation of what this specific version of the instance contains and represents.",
"isModifier": false,
"short": "Details about version",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.instance.version.description",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.instance.version.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.version.content",
"min": 0,
"definition": "Points to an instance (typically an example) that shows the data that would flow at this point in the scenario.",
"isModifier": false,
"short": "Example instance version data",
"type": [ {
"code": "Reference"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.version.content",
"comment": "If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.instance.version.content"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "exs-14",
"human": "InstanceReference must be a key of an instance defined in the ExampleScenario",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "%resource.instance.where(key=%context.instanceReference).exists()"
}, {
"key": "exs-15",
"human": "versionReference must be specified if the referenced instance defines versions",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "versionReference.empty() implies %resource.instance.where(key=%context.instanceReference).version.empty()"
}, {
"key": "exs-16",
"human": "versionReference must be a key of a version within the instance pointed to by instanceReference",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "versionReference.exists() implies %resource.instance.where(key=%context.instanceReference).version.where(key=%context.versionReference).exists()"
} ],
"path": "ExampleScenario.instance.containedInstance",
"requirements": "An instance may contain multiple resources - for example, a search response Bundle, a document Bundle, nested contained resources, etc. In some cases it's useful to be able to talk about these contained instances distinctly, as they may appear in multiple locations in a scenario - sometimes contained, sometimes not. For example, a scenario may include the creation of an Observation (stand-alone instance) followed by a search that results in a Bundle that contains that same Observation. The ExampleScenario can highlight the fact that the 'created' instance and 'contained' instance are the same by having the Bundle refer to the same instance id.",
"min": 0,
"definition": "References to other instances that can be found within this instance (e.g. the observations contained in a bundle).",
"isModifier": false,
"short": "Resources contained in the instance",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.instance.containedInstance",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.instance.containedInstance"
},
"isSummary": false
}, {
"path": "ExampleScenario.instance.containedInstance.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExampleScenario.instance.containedInstance.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.containedInstance.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.instance.containedInstance.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.containedInstance.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ExampleScenario.instance.containedInstance.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.containedInstance.instanceReference",
"min": 1,
"definition": "A reference to the key of an instance found within this one.",
"isModifier": false,
"short": "Key of contained instance",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.containedInstance.instanceReference",
"condition": [ "exs-14", "exs-15", "exs-16", "exs-20", "exs-21" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.instance.containedInstance.instanceReference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.instance.containedInstance.versionReference",
"min": 0,
"definition": "A reference to the key of a specific version of an instance in this instance.",
"isModifier": false,
"short": "Key of contained instance version",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.containedInstance.versionReference",
"condition": [ "exs-15", "exs-16", "exs-21" ],
"comment": "Required if the referenced instance has versions",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.instance.containedInstance.versionReference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "exs-5",
"human": "Processes must have steps if ExampleScenario status is active or required",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "%resource.status='active' or %resource.status='retired' implies step.exists()"
} ],
"path": "ExampleScenario.process",
"min": 0,
"definition": "A group of operations that represents a significant step within a scenario.",
"isModifier": false,
"short": "Major process within scenario",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.process",
"condition": [ "exs-4", "exs-12", "exs-22", "exs-20", "exs-21", "exs-19" ],
"comment": "Some scenarios might describe only one process.",
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.)",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.process"
},
"isSummary": false
}, {
"path": "ExampleScenario.process.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExampleScenario.process.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.process.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ExampleScenario.process.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.title",
"min": 1,
"definition": "A short descriptive label the process to be used in tables or diagrams.",
"isModifier": false,
"short": "Label for procss",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.title",
"condition": [ "exs-12" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.process.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.description",
"min": 0,
"definition": "An explanation of what the process represents and what it does.",
"isModifier": false,
"short": "Human-friendly description of the process",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.description",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.preConditions",
"min": 0,
"definition": "Description of the initial state of the actors, environment and data before the process starts.",
"isModifier": false,
"short": "Status before process starts",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.preConditions",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.preConditions"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.postConditions",
"min": 0,
"definition": "Description of the final state of the actors, environment and data after the process has been successfully completed.",
"isModifier": false,
"short": "Status after successful completion",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.postConditions",
"comment": "Alternate steps might not result in all post conditions holding",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.postConditions"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "exs-13",
"human": "Alternative titles must be unique within a step",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "alternative.title.count() = alternative.title.distinct().count()"
}, {
"key": "exs-22",
"human": "Can have a process, a workflow, one or more operations or none of these, but cannot have a combination",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "(process.exists() implies workflow.empty() and operation.empty()) and (workflow.exists() implies operation.empty())"
} ],
"path": "ExampleScenario.process.step",
"min": 0,
"definition": "A significant action that occurs as part of the process.",
"isModifier": false,
"short": "Event within of the process",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.process.step",
"condition": [ "exs-5" ],
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.). It also indicates the order in which the events occur.",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.process.step"
},
"isSummary": false
}, {
"path": "ExampleScenario.process.step.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExampleScenario.process.step.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.process.step.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ExampleScenario.process.step.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.number",
"min": 0,
"definition": "The sequence number of the step, e.g. 1.2.5.",
"isModifier": false,
"short": "Sequential number of the step",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.number",
"comment": "If step numbers are simultaneous, they will be the same. Numbers don't have to be numeric. E.g. '2c' is a valid step number. The 'number' should only contain the textual part of the step identifier, not any separating punctuation. I.e. 'number' should be '2c' not '2c.' or '2c)' or '2c - '.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.number"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.process",
"min": 0,
"definition": "Indicates that the step is a complex sub-process with its own steps.",
"isModifier": false,
"short": "Step is nested process",
"contentReference": "#ExampleScenario.process",
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.process",
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.)",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.process"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.workflow",
"min": 0,
"definition": "Indicates that the step is defined by a seaparate scenario instance.",
"isModifier": false,
"short": "Step is nested workflow",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ExampleScenario" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.workflow",
"condition": [ "exs-22" ],
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.workflow"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "exs-17",
"human": "If specified, initiator must be a key of an actor within the ExampleScenario",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "initiator.exists() implies initiator = 'OTHER' or %resource.actor.where(key=%context.initiator).exists()"
}, {
"key": "exs-18",
"human": "If specified, receiver must be a key of an actor within the ExampleScenario",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "receiver.exists() implies receiver = 'OTHER' or %resource.actor.where(key=%context.receiver).exists()"
} ],
"path": "ExampleScenario.process.step.operation",
"min": 0,
"definition": "The step represents a single operation invoked on receiver by sender.",
"isModifier": false,
"short": "Step is simple action",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation",
"condition": [ "exs-19", "exs-22" ],
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation"
},
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExampleScenario.process.step.operation.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.process.step.operation.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ExampleScenario.process.step.operation.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.type",
"min": 0,
"definition": "The standardized type of action (FHIR or otherwise).",
"isModifier": false,
"short": "Kind of action",
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/examplescenario-operation-codes"
},
"max": "1",
"id": "ExampleScenario.process.step.operation.type",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.title",
"min": 1,
"definition": "A short descriptive label the step to be used in tables or diagrams.",
"isModifier": false,
"short": "Label for step",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.title",
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.process.step.operation.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.initiator",
"min": 0,
"definition": "The system that invokes the action/transmits the data.",
"isModifier": false,
"short": "Who starts the operation",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.initiator",
"condition": [ "exs-17", "exs-19" ],
"comment": "This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the initiator is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.)",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation.initiator"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.receiver",
"min": 0,
"definition": "The system on which the action is invoked/receives the data.",
"isModifier": false,
"short": "Who receives the operation",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.receiver",
"condition": [ "exs-18", "exs-19" ],
"comment": "This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the receiver is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.) In some cases, receiver could be same as sender if representing a local operation",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation.receiver"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.description",
"min": 0,
"definition": "An explanation of what the operation represents and what it does.",
"isModifier": false,
"short": "Human-friendly description of the operation",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.step.operation.description",
"comment": "This should contain information not already present in the process step. It's more of a description of what the operation in general does - if not already evident from the operation.type",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.initiatorActive",
"requirements": "The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.",
"min": 0,
"definition": "If false, the initiator is deactivated right after the operation.",
"isModifier": false,
"short": "Initiator stays active?",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.initiatorActive",
"comment": "De-activation of an actor means they have no further role until such time as they are the recipient of an operation.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation.initiatorActive"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.receiverActive",
"requirements": "The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.",
"min": 0,
"definition": "If false, the receiver is deactivated right after the operation.",
"isModifier": false,
"short": "Receiver stays active?",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.receiverActive",
"comment": "De-activation of an actor means they have no further role until such time as they are the recipient of an operation.",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation.receiverActive"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.request",
"min": 0,
"definition": "A reference to the instance that is transmitted from requester to receiver as part of the invocation of the operation.",
"isModifier": false,
"short": "Instance transmitted on invocation",
"contentReference": "#ExampleScenario.instance.containedInstance",
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.request",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation.request"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.operation.response",
"min": 0,
"definition": "A reference to the instance that is transmitted from receiver to requester as part of the operation's synchronous response (if any).",
"isModifier": false,
"short": "Instance transmitted on invocation response",
"contentReference": "#ExampleScenario.instance.containedInstance",
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.response",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.operation.response"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.alternative",
"min": 0,
"definition": "Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.",
"isModifier": false,
"short": "Alternate non-typical step action",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.process.step.alternative",
"condition": [ "exs-13" ],
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.)",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.process.step.alternative"
},
"isSummary": false
}, {
"path": "ExampleScenario.process.step.alternative.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ExampleScenario.process.step.alternative.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.alternative.extension",
"min": 0,
"definition": "May 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 managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ExampleScenario.process.step.alternative.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.alternative.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May 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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ExampleScenario.process.step.alternative.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.alternative.title",
"min": 1,
"definition": "The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.",
"isModifier": false,
"short": "Label for alternative",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.step.alternative.title",
"condition": [ "exs-13" ],
"base": {
"max": "1",
"min": 1,
"path": "ExampleScenario.process.step.alternative.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.alternative.description",
"min": 0,
"definition": "A human-readable description of the alternative explaining when the alternative should occur rather than the base step.",
"isModifier": false,
"short": "Human-readable description of option",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.step.alternative.description",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.alternative.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.alternative.step",
"min": 0,
"definition": "Indicates the operation, sub-process or scenario that happens if the alternative option is selected.",
"isModifier": false,
"short": "Alternative action(s)",
"contentReference": "#ExampleScenario.process.step",
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.process.step.alternative.step",
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.). It also indicates the order in which the events occur.",
"base": {
"max": "*",
"min": 0,
"path": "ExampleScenario.process.step.alternative.step"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ExampleScenario.process.step.pause",
"min": 0,
"definition": "If true, indicates that, following this step, there is a pause in the flow and the subsequent step will occur at some later time (triggered by some event).",
"isModifier": false,
"short": "Pause in the flow?",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.pause",
"base": {
"max": "1",
"min": 0,
"path": "ExampleScenario.process.step.pause"
},
"isSummary": false
} ]
},
"status": "active",
"id": "03ea7cd9-7c04-42f3-b111-42fa85cf431b",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"version": "6.0.0-ballot4",
"differential": {
"element": [ {
"constraint": [ {
"key": "exs-4",
"human": "Must have processes if status is active or required",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "status='active' or status='retired' implies process.exists()"
}, {
"key": "exs-3",
"human": "Must have actors if status is active or required",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "status='active' or status='retired' implies actor.exists()"
}, {
"key": "cnl-0",
"human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')"
}, {
"key": "exs-12",
"human": "Process titles must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "process.title.count() = process.title.distinct().count()"
}, {
"key": "exs-9",
"human": "Instance titles must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "instance.title.count() = instance.title.distinct().count()"
}, {
"key": "exs-8",
"human": "Instance keys must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "instance.key.count() = instance.key.distinct().count()"
}, {
"key": "exs-7",
"human": "Actor titles must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "actor.title.count() = actor.title.distinct().count()"
}, {
"key": "exs-6",
"human": "Actor keys must be unique",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "actor.key.count() = actor.key.distinct().count()"
} ],
"path": "ExampleScenario",
"min": 0,
"definition": "A computable description of the actors, interactions between those actors that would occur, and concrete examples of the data that would be exchanged in a specific hypothetical exchange, typically used to help demonstrate the interoperability expectations of a specification. This resource is used to illustrate a specific time-based exchange, not to define in general terms how exchanges can/should occur.",
"isModifier": false,
"short": "A computable description of a set of actors and the interactions between those actors",
"mapping": [ {
"map": "infrastructure.information",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario"
}, {
"constraint": [ {
"key": "cnl-1",
"human": "URL should not contain | or # - these characters make processing canonical references problematic",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "exists() implies matches('^[^|# ]+$')"
} ],
"path": "ExampleScenario.url",
"requirements": "Allows the example scenario to be referenced by a single globally unique identifier.",
"min": 0,
"definition": "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 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.",
"isModifier": false,
"short": "Canonical identifier for this example scenario, represented as a URI (globally unique)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.url",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"isSummary": true
}, {
"path": "ExampleScenario.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Additional identifier for the example scenario",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.identifier",
"isSummary": true
}, {
"path": "ExampleScenario.version",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "Business version of the example scenario",
"mapping": [ {
"map": "FiveWs.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.version",
"comment": "There may be different example scenario instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the example scenario with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).",
"isSummary": true
}, {
"path": "ExampleScenario.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"isModifier": false,
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
},
"max": "1",
"id": "ExampleScenario.versionAlgorithm[x]",
"comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"isSummary": true
}, {
"path": "ExampleScenario.name",
"min": 0,
"definition": "A natural language name identifying the ExampleScenario. This name should be usable as an identifier for the resource by machine processing applications such as code generation.",
"isModifier": false,
"short": "Name for this example scenario (computer friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.name",
"condition": [ "cnl-0" ],
"comment": "It is not expected that ExampleScenarios will be used to generate code, as they are only examples and not definitional. However, this element is retained to remain compatible with the canonical resource interface. Systems are free to omit populating the element.",
"isSummary": true
}, {
"path": "ExampleScenario.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the ExampleScenario.",
"isModifier": false,
"short": "Name for this example scenario (human friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"isSummary": true
}, {
"path": "ExampleScenario.status",
"min": 1,
"definition": "The status of this example scenario. Enables tracking the life-cycle of the content.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "ExampleScenario.status",
"condition": [ "exs-3", "exs-4", "exs-5" ],
"comment": "Allows filtering of example scenarios that are appropriate for use versus not.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired ExampleScenario without due consideration",
"isSummary": true
}, {
"path": "ExampleScenario.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario.",
"min": 0,
"definition": "A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.",
"isModifier": false,
"short": "For testing only - never for real usage",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"max": "1",
"id": "ExampleScenario.experimental",
"comment": "Allows filtering of example scenarios that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).\n\nExperimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.",
"isSummary": true
}, {
"path": "ExampleScenario.date",
"min": 0,
"definition": "The date (and optionally time) when the example scenario was last significantly changed. 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').",
"isModifier": false,
"short": "Date last changed",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"alias": [ "Revision Date" ],
"max": "1",
"id": "ExampleScenario.date",
"comment": "The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the example scenario. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isSummary": true
}, {
"path": "ExampleScenario.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the example scenario. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the example scenario.",
"isModifier": false,
"short": "Name of the publisher/steward (organization or individual)",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.publisher",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the example scenario is the organization or individual primarily responsible for the maintenance and upkeep of the example scenario. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the example scenario. This item SHOULD be populated unless the information is available from context.",
"isSummary": true
}, {
"path": "ExampleScenario.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"isModifier": false,
"short": "Contact details for the publisher",
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isSummary": true
}, {
"path": "ExampleScenario.description",
"min": 0,
"definition": "A free text natural language description of the ExampleScenario from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the ExampleScenario",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.description",
"comment": "This description can be used to capture details such as comments about misuse. It is not a rendering of the ExampleScenario as conveyed in the 'text' field of the resource itself.",
"isSummary": true
}, {
"path": "ExampleScenario.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "The context that the content is intended to support",
"type": [ {
"code": "UsageContext"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"isSummary": true
}, {
"path": "ExampleScenario.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.",
"isModifier": false,
"short": "Jurisdiction of the authority that maintains the example scenario (if applicable)",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "ExampleScenario.jurisdiction",
"comment": "It may be possible for the example scenario to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)",
"isSummary": true
}, {
"path": "ExampleScenario.purpose",
"min": 0,
"definition": "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.",
"isModifier": false,
"short": "The purpose of the example, e.g. to illustrate a scenario",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.purpose",
"comment": "This element does not describe the usage of the example scenario. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this example scenario.",
"isSummary": false
}, {
"path": "ExampleScenario.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the example scenario and/or its content.",
"min": 0,
"definition": "A copyright statement relating to the example scenario and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the example scenario.",
"isModifier": false,
"short": "Notice about intellectual property ownership, can include restrictions on use",
"mapping": [ {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "ExampleScenario.copyright",
"comment": "...",
"isSummary": false
}, {
"path": "ExampleScenario.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"definition": "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"isModifier": false,
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.copyrightLabel",
"comment": "The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"isSummary": false
}, {
"constraint": [ {
"key": "exs-24",
"human": "actor SHALL have either a type or a definition but not both",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "type.exists() xor definition.exists()"
}, {
"key": "exs-23",
"human": "actor.key canot be 'OTHER'",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "key != 'OTHER'"
}, {
"key": "exs-19",
"human": "Actor should be referenced in at least one operation",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "%resource.process.descendants().select(operation).where(initiator=%context.key or receiver=%context.key).exists()"
} ],
"path": "ExampleScenario.actor",
"requirements": "This is optional to allow for ExampleScenarios that are still draft",
"min": 0,
"definition": "A system or person who shares or receives an instance within the scenario.",
"isModifier": false,
"short": "Individual involved in exchange",
"mapping": [ {
"map": "FiveWs.who",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.actor",
"condition": [ "exs-3", "exs-6", "exs-7", "exs-17", "exs-18" ],
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.)",
"isSummary": false
}, {
"path": "ExampleScenario.actor.key",
"min": 1,
"definition": "A unique string within the scenario that is used to reference the actor.",
"isModifier": false,
"short": "ID or acronym of the actor",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.actor.key",
"condition": [ "exs-6", "exs-23", "exs-17", "exs-18", "exs-19" ],
"isSummary": false
}, {
"path": "ExampleScenario.actor.type",
"min": 0,
"definition": "The category of actor - person or system.",
"isModifier": false,
"short": "person | system | collective | other",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/actordefinition-actor-type|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ActorDefinitionActorType"
} ],
"description": "The type of actor - system or non-system."
},
"max": "1",
"id": "ExampleScenario.actor.type",
"condition": [ "exs-24" ],
"isSummary": false
}, {
"path": "ExampleScenario.actor.title",
"min": 1,
"definition": "The human-readable name for the actor used when rendering the scenario.",
"isModifier": false,
"short": "Label for actor when rendering",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.actor.title",
"condition": [ "exs-7" ],
"isSummary": false
}, {
"path": "ExampleScenario.actor.description",
"min": 0,
"definition": "An explanation of who/what the actor is and its role in the scenario.",
"isModifier": false,
"short": "Details about actor",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.actor.description",
"isSummary": false
}, {
"path": "ExampleScenario.actor.definition",
"min": 0,
"definition": "The formal definition of the actor in the scenario.",
"isModifier": false,
"short": "Formal definition of actor",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ActorDefinition" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.actor.definition",
"condition": [ "exs-24" ],
"comment": "The title and description appearing in this resource may differ from that in the formal definition. The type SHALL be the same.",
"isSummary": false
}, {
"constraint": [ {
"key": "exs-2",
"human": "instance.content is only allowed if there are no instance.versions",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "content.exists() implies version.empty()"
}, {
"key": "exs-20",
"human": "Instance should be referenced in at least one location",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "%resource.process.descendants().select(instanceReference).where($this=%context.key).exists()"
}, {
"key": "exs-1",
"human": "StructureVersion is required if structureType is not FHIR (but may still be present even if FHIR)",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "structureType.exists() and structureType.memberOf('http://hl7.org/fhir/ValueSet/resource-types').not() implies structureVersion.exists()"
}, {
"key": "exs-11",
"human": "Version titles must be unique within an instance",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "version.title.count() = version.title.distinct().count()"
}, {
"key": "exs-10",
"human": "Version keys must be unique within an instance",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "version.key.count() = version.key.distinct().count()"
}, {
"key": "exs-21",
"human": "Instance version should be referenced in at least one operation",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "warning",
"expression": "version.exists() implies version.key.intersect(%resource.process.descendants().where(instanceReference = %context.key).versionReference).exists()"
} ],
"path": "ExampleScenario.instance",
"min": 0,
"definition": "A single data collection that is shared as part of the scenario.",
"isModifier": false,
"short": "Data used in the scenario",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.instance",
"condition": [ "exs-8", "exs-9", "exs-14", "exs-15", "exs-16" ],
"isSummary": false
}, {
"path": "ExampleScenario.instance.key",
"min": 1,
"definition": "A unique string within the scenario that is used to reference the instance.",
"isModifier": false,
"short": "ID or acronym of the instance",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.key",
"condition": [ "exs-8", "exs-14", "exs-15", "exs-16", "exs-20", "exs-21" ],
"isSummary": false
}, {
"path": "ExampleScenario.instance.structureType",
"min": 1,
"definition": "A code indicating the kind of data structure (FHIR resource or some other standard) this is an instance of.",
"isModifier": false,
"short": "Data structure for example",
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/examplescenario-instance-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "InstanceType"
} ],
"description": "The structure that defines the instance"
},
"max": "1",
"id": "ExampleScenario.instance.structureType",
"condition": [ "exs-1" ],
"comment": "This element may be omitted if describing a step that doesn't involve the sharing of a data structure - e.g. a human action",
"isSummary": false
}, {
"path": "ExampleScenario.instance.structureVersion",
"min": 0,
"definition": "Conveys the version of the data structure instantiated. I.e. what release of FHIR, X12, OpenEHR, etc. is instance compliant with.",
"isModifier": false,
"short": "E.g. 4.0.1",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"meaningWhenMissing": "If the structureType is a FHIR resource, then the version is the same FHIR version this ExampleScenario is expressed in.",
"max": "1",
"id": "ExampleScenario.instance.structureVersion",
"condition": [ "exs-1" ],
"isSummary": false
}, {
"path": "ExampleScenario.instance.structureProfile[x]",
"min": 0,
"definition": "Refers to a profile, template or other ruleset the instance adheres to.",
"isModifier": false,
"short": "Rules instance adheres to",
"type": [ {
"code": "canonical"
}, {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.structureProfile[x]",
"isSummary": false
}, {
"path": "ExampleScenario.instance.title",
"min": 1,
"definition": "A short descriptive label the instance to be used in tables or diagrams.",
"isModifier": false,
"short": "Label for instance",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.instance.title",
"condition": [ "exs-9" ],
"isSummary": false
}, {
"path": "ExampleScenario.instance.description",
"min": 0,
"definition": "An explanation of what the instance contains and what it's for.",
"isModifier": false,
"short": "Human-friendly description of the instance",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.instance.description",
"isSummary": false
}, {
"path": "ExampleScenario.instance.content",
"min": 0,
"definition": "Points to an instance (typically an example) that shows the data that would corespond to this instance.",
"isModifier": false,
"short": "Example instance data",
"type": [ {
"code": "Reference"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.content",
"condition": [ "exs-2" ],
"comment": "If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.",
"isSummary": false
}, {
"path": "ExampleScenario.instance.version",
"requirements": "Allows representing the 'same' instance as it evolves throughout the scenario.",
"min": 0,
"definition": "Represents the instance as it was at a specific time-point.",
"isModifier": false,
"short": "Snapshot of instance that changes",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.instance.version",
"condition": [ "exs-10", "exs-11", "exs-15", "exs-16", "exs-2", "exs-21" ],
"comment": "Not used if an instance doesn't change",
"isSummary": false
}, {
"path": "ExampleScenario.instance.version.key",
"min": 1,
"definition": "A unique string within the instance that is used to reference the version of the instance.",
"isModifier": false,
"short": "ID or acronym of the version",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.version.key",
"condition": [ "exs-10", "exs-16", "exs-21" ],
"isSummary": false
}, {
"path": "ExampleScenario.instance.version.title",
"min": 1,
"definition": "A short descriptive label the version to be used in tables or diagrams.",
"isModifier": false,
"short": "Label for instance version",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.version.title",
"condition": [ "exs-11" ],
"isSummary": false
}, {
"path": "ExampleScenario.instance.version.description",
"min": 0,
"definition": "An explanation of what this specific version of the instance contains and represents.",
"isModifier": false,
"short": "Details about version",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.instance.version.description",
"isSummary": false
}, {
"path": "ExampleScenario.instance.version.content",
"min": 0,
"definition": "Points to an instance (typically an example) that shows the data that would flow at this point in the scenario.",
"isModifier": false,
"short": "Example instance version data",
"type": [ {
"code": "Reference"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.version.content",
"comment": "If not conveying FHIR data or not using the same version of FHIR as this ExampleScenario instance, the reference must be to a Binary.",
"isSummary": false
}, {
"constraint": [ {
"key": "exs-15",
"human": "versionReference must be specified if the referenced instance defines versions",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "versionReference.empty() implies %resource.instance.where(key=%context.instanceReference).version.empty()"
}, {
"key": "exs-14",
"human": "InstanceReference must be a key of an instance defined in the ExampleScenario",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "%resource.instance.where(key=%context.instanceReference).exists()"
}, {
"key": "exs-16",
"human": "versionReference must be a key of a version within the instance pointed to by instanceReference",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "versionReference.exists() implies %resource.instance.where(key=%context.instanceReference).version.where(key=%context.versionReference).exists()"
} ],
"path": "ExampleScenario.instance.containedInstance",
"requirements": "An instance may contain multiple resources - for example, a search response Bundle, a document Bundle, nested contained resources, etc. In some cases it's useful to be able to talk about these contained instances distinctly, as they may appear in multiple locations in a scenario - sometimes contained, sometimes not. For example, a scenario may include the creation of an Observation (stand-alone instance) followed by a search that results in a Bundle that contains that same Observation. The ExampleScenario can highlight the fact that the 'created' instance and 'contained' instance are the same by having the Bundle refer to the same instance id.",
"min": 0,
"definition": "References to other instances that can be found within this instance (e.g. the observations contained in a bundle).",
"isModifier": false,
"short": "Resources contained in the instance",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.instance.containedInstance",
"isSummary": false
}, {
"path": "ExampleScenario.instance.containedInstance.instanceReference",
"min": 1,
"definition": "A reference to the key of an instance found within this one.",
"isModifier": false,
"short": "Key of contained instance",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.containedInstance.instanceReference",
"condition": [ "exs-14", "exs-15", "exs-16", "exs-20", "exs-21" ],
"isSummary": false
}, {
"path": "ExampleScenario.instance.containedInstance.versionReference",
"min": 0,
"definition": "A reference to the key of a specific version of an instance in this instance.",
"isModifier": false,
"short": "Key of contained instance version",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.instance.containedInstance.versionReference",
"condition": [ "exs-15", "exs-16", "exs-21" ],
"comment": "Required if the referenced instance has versions",
"isSummary": false
}, {
"constraint": [ {
"key": "exs-5",
"human": "Processes must have steps if ExampleScenario status is active or required",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "%resource.status='active' or %resource.status='retired' implies step.exists()"
} ],
"path": "ExampleScenario.process",
"min": 0,
"definition": "A group of operations that represents a significant step within a scenario.",
"isModifier": false,
"short": "Major process within scenario",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.process",
"condition": [ "exs-4", "exs-12", "exs-22", "exs-20", "exs-21", "exs-19" ],
"comment": "Some scenarios might describe only one process.",
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.)",
"isSummary": false
}, {
"path": "ExampleScenario.process.title",
"min": 1,
"definition": "A short descriptive label the process to be used in tables or diagrams.",
"isModifier": false,
"short": "Label for procss",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.title",
"condition": [ "exs-12" ],
"isSummary": true
}, {
"path": "ExampleScenario.process.description",
"min": 0,
"definition": "An explanation of what the process represents and what it does.",
"isModifier": false,
"short": "Human-friendly description of the process",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.description",
"isSummary": false
}, {
"path": "ExampleScenario.process.preConditions",
"min": 0,
"definition": "Description of the initial state of the actors, environment and data before the process starts.",
"isModifier": false,
"short": "Status before process starts",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.preConditions",
"isSummary": false
}, {
"path": "ExampleScenario.process.postConditions",
"min": 0,
"definition": "Description of the final state of the actors, environment and data after the process has been successfully completed.",
"isModifier": false,
"short": "Status after successful completion",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.postConditions",
"comment": "Alternate steps might not result in all post conditions holding",
"isSummary": false
}, {
"constraint": [ {
"key": "exs-22",
"human": "Can have a process, a workflow, one or more operations or none of these, but cannot have a combination",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "(process.exists() implies workflow.empty() and operation.empty()) and (workflow.exists() implies operation.empty())"
}, {
"key": "exs-13",
"human": "Alternative titles must be unique within a step",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "alternative.title.count() = alternative.title.distinct().count()"
} ],
"path": "ExampleScenario.process.step",
"min": 0,
"definition": "A significant action that occurs as part of the process.",
"isModifier": false,
"short": "Event within of the process",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.process.step",
"condition": [ "exs-5" ],
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.). It also indicates the order in which the events occur.",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.number",
"min": 0,
"definition": "The sequence number of the step, e.g. 1.2.5.",
"isModifier": false,
"short": "Sequential number of the step",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.number",
"comment": "If step numbers are simultaneous, they will be the same. Numbers don't have to be numeric. E.g. '2c' is a valid step number. The 'number' should only contain the textual part of the step identifier, not any separating punctuation. I.e. 'number' should be '2c' not '2c.' or '2c)' or '2c - '.",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.process",
"min": 0,
"definition": "Indicates that the step is a complex sub-process with its own steps.",
"isModifier": false,
"short": "Step is nested process",
"contentReference": "#ExampleScenario.process",
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.process",
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.)",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.workflow",
"min": 0,
"definition": "Indicates that the step is defined by a seaparate scenario instance.",
"isModifier": false,
"short": "Step is nested workflow",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ExampleScenario" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.workflow",
"condition": [ "exs-22" ],
"isSummary": false
}, {
"constraint": [ {
"key": "exs-17",
"human": "If specified, initiator must be a key of an actor within the ExampleScenario",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "initiator.exists() implies initiator = 'OTHER' or %resource.actor.where(key=%context.initiator).exists()"
}, {
"key": "exs-18",
"human": "If specified, receiver must be a key of an actor within the ExampleScenario",
"source": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"severity": "error",
"expression": "receiver.exists() implies receiver = 'OTHER' or %resource.actor.where(key=%context.receiver).exists()"
} ],
"path": "ExampleScenario.process.step.operation",
"min": 0,
"definition": "The step represents a single operation invoked on receiver by sender.",
"isModifier": false,
"short": "Step is simple action",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation",
"condition": [ "exs-19", "exs-22" ],
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.type",
"min": 0,
"definition": "The standardized type of action (FHIR or otherwise).",
"isModifier": false,
"short": "Kind of action",
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/examplescenario-operation-codes"
},
"max": "1",
"id": "ExampleScenario.process.step.operation.type",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.title",
"min": 1,
"definition": "A short descriptive label the step to be used in tables or diagrams.",
"isModifier": false,
"short": "Label for step",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.title",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.initiator",
"min": 0,
"definition": "The system that invokes the action/transmits the data.",
"isModifier": false,
"short": "Who starts the operation",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.initiator",
"condition": [ "exs-17", "exs-19" ],
"comment": "This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the initiator is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.)",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.receiver",
"min": 0,
"definition": "The system on which the action is invoked/receives the data.",
"isModifier": false,
"short": "Who receives the operation",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.receiver",
"condition": [ "exs-18", "exs-19" ],
"comment": "This must either be the 'key' of one of the actors defined in this scenario or the special keyword 'OTHER' if the receiver is not one of the actors defined for the scenario. (Multiple references to 'OTHER' don't necessarily indicate the same actor.) In some cases, receiver could be same as sender if representing a local operation",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.description",
"min": 0,
"definition": "An explanation of what the operation represents and what it does.",
"isModifier": false,
"short": "Human-friendly description of the operation",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.step.operation.description",
"comment": "This should contain information not already present in the process step. It's more of a description of what the operation in general does - if not already evident from the operation.type",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.initiatorActive",
"requirements": "The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.",
"min": 0,
"definition": "If false, the initiator is deactivated right after the operation.",
"isModifier": false,
"short": "Initiator stays active?",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.initiatorActive",
"comment": "De-activation of an actor means they have no further role until such time as they are the recipient of an operation.",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.receiverActive",
"requirements": "The notion of 'activation' in a flow diagram is used to indicate 'who has responsibility/is still doing work'.",
"min": 0,
"definition": "If false, the receiver is deactivated right after the operation.",
"isModifier": false,
"short": "Receiver stays active?",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.receiverActive",
"comment": "De-activation of an actor means they have no further role until such time as they are the recipient of an operation.",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.request",
"min": 0,
"definition": "A reference to the instance that is transmitted from requester to receiver as part of the invocation of the operation.",
"isModifier": false,
"short": "Instance transmitted on invocation",
"contentReference": "#ExampleScenario.instance.containedInstance",
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.request",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.operation.response",
"min": 0,
"definition": "A reference to the instance that is transmitted from receiver to requester as part of the operation's synchronous response (if any).",
"isModifier": false,
"short": "Instance transmitted on invocation response",
"contentReference": "#ExampleScenario.instance.containedInstance",
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.operation.response",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.alternative",
"min": 0,
"definition": "Indicates an alternative step that can be taken instead of the sub-process, scenario or operation. E.g. to represent non-happy-path/exceptional/atypical circumstances.",
"isModifier": false,
"short": "Alternate non-typical step action",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.process.step.alternative",
"condition": [ "exs-13" ],
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.)",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.alternative.title",
"min": 1,
"definition": "The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked.",
"isModifier": false,
"short": "Label for alternative",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.step.alternative.title",
"condition": [ "exs-13" ],
"isSummary": false
}, {
"path": "ExampleScenario.process.step.alternative.description",
"min": 0,
"definition": "A human-readable description of the alternative explaining when the alternative should occur rather than the base step.",
"isModifier": false,
"short": "Human-readable description of option",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ExampleScenario.process.step.alternative.description",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.alternative.step",
"min": 0,
"definition": "Indicates the operation, sub-process or scenario that happens if the alternative option is selected.",
"isModifier": false,
"short": "Alternative action(s)",
"contentReference": "#ExampleScenario.process.step",
"mustSupport": false,
"max": "*",
"id": "ExampleScenario.process.step.alternative.step",
"orderMeaning": "The order in which these elements appear is the order in which they are expected to be rendered (in a table, in a diagram, etc.). It also indicates the order in which the events occur.",
"isSummary": false
}, {
"path": "ExampleScenario.process.step.pause",
"min": 0,
"definition": "If true, indicates that, following this step, there is a pause in the flow and the subsequent step will occur at some later time (triggered by some event).",
"isModifier": false,
"short": "Pause in the flow?",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ExampleScenario.process.step.pause",
"isSummary": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}