R4 Ballot #1 (Mixed Normative/Trial use)
WorkflowThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for examplescenario
{
"resourceType": "StructureDefinition",
"id": "ExampleScenario",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Draft"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ExampleScenario",
"name": "ExampleScenario",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"description": "Example of workflow instance.",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "ExampleScenario",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ExampleScenario",
"path": "ExampleScenario",
"short": "Example of workflow instance",
"definition": "Example of workflow instance.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
}
]
},
{
"id": "ExampleScenario.id",
"path": "ExampleScenario.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExampleScenario.meta",
"path": "ExampleScenario.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExampleScenario.implicitRules",
"path": "ExampleScenario.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"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 it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "ExampleScenario.language",
"path": "ExampleScenario.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "ExampleScenario.text",
"path": "ExampleScenario.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comment": "Contained resources do not have 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 in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ExampleScenario.contained",
"path": "ExampleScenario.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.extension",
"path": "ExampleScenario.extension",
"short": "Additional Content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.modifierExtension",
"path": "ExampleScenario.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.url",
"path": "ExampleScenario.url",
"short": "Canonical identifier for this example scenario, represented as a URI (globally unique)",
"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 this example scenario is (or will be) published.",
"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 URL SHOULD include the major version of the example scenario. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the example scenario to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "ExampleScenario.identifier",
"path": "ExampleScenario.identifier",
"short": "Additional identifier for the example scenario",
"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.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this example scenario outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ExampleScenario.version",
"path": "ExampleScenario.version",
"short": "Business version of the example scenario",
"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.",
"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].",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
}
]
},
{
"id": "ExampleScenario.name",
"path": "ExampleScenario.name",
"short": "Name for this example scenario (computer friendly)",
"definition": "A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExampleScenario.status",
"path": "ExampleScenario.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this example scenario. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of example scenarios that are appropriate for use versus not.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "ExampleScenario.experimental",
"path": "ExampleScenario.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of example scenarios that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.experimental",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "ExampleScenario.date",
"path": "ExampleScenario.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the example scenario was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').",
"comment": "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.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "ExampleScenario.publisher",
"path": "ExampleScenario.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the example scenario.",
"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.",
"requirements": "Helps establish the \"authority/credibility\" of the example scenario. May also allow for contact.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.publisher",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
}
]
},
{
"id": "ExampleScenario.contact",
"path": "ExampleScenario.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.contact",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactDetail"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "ExampleScenario.useContext",
"path": "ExampleScenario.useContext",
"short": "The context that the content is intended to support",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate example scenario instances.",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.useContext",
"min": 0,
"max": "*"
},
"type": [
{
"code": "UsageContext"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "ExampleScenario.jurisdiction",
"path": "ExampleScenario.jurisdiction",
"short": "Intended jurisdiction for example scenario (if applicable)",
"definition": "A legal or geographic region in which the example scenario is intended to be used.",
"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.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.jurisdiction",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "ExampleScenario.copyright",
"path": "ExampleScenario.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.",
"comment": "null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the example scenario and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.copyright",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.copyright"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ExampleScenario.purpose",
"path": "ExampleScenario.purpose",
"short": "The purpose of the example, e.g. to illustrate a scenario",
"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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.purpose",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ExampleScenario.actor",
"path": "ExampleScenario.actor",
"short": "Actor participating in the resource",
"definition": "Actor participating in the resource.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.actor",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.actor.id",
"path": "ExampleScenario.actor.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.actor.extension",
"path": "ExampleScenario.actor.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.actor.modifierExtension",
"path": "ExampleScenario.actor.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.actor.actorId",
"path": "ExampleScenario.actor.actorId",
"short": "ID or acronym of the actor",
"definition": "ID or acronym of actor.",
"comment": "should this be called ID or acronym?",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.actor.actorId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.actor.type",
"path": "ExampleScenario.actor.type",
"short": "person | entity",
"definition": "The type of actor - person or system.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.actor.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ExampleScenarioActorType"
}
],
"strength": "required",
"description": "The type of actor - system or human",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/examplescenario-actor-type"
}
},
{
"id": "ExampleScenario.actor.name",
"path": "ExampleScenario.actor.name",
"short": "The name of the actor as shown in the page",
"definition": "The name of the actor as shown in the page.",
"comment": "Cardinality: is name and description 1..1?",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.actor.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.actor.description",
"path": "ExampleScenario.actor.description",
"short": "The description of the actor",
"definition": "The description of the actor.",
"comment": "Cardinality: is name and description 1..1?",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.actor.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance",
"path": "ExampleScenario.instance",
"short": "Each resource and each version that is present in the workflow",
"definition": "Each resource and each version that is present in the workflow.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.instance",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.id",
"path": "ExampleScenario.instance.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.instance.extension",
"path": "ExampleScenario.instance.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.instance.modifierExtension",
"path": "ExampleScenario.instance.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.instance.resourceId",
"path": "ExampleScenario.instance.resourceId",
"short": "The id of the resource for referencing",
"definition": "The id of the resource for referencing.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.instance.resourceId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.resourceType",
"path": "ExampleScenario.instance.resourceType",
"short": "The type of the resource",
"definition": "The type of the resource.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.instance.resourceType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceType"
}
],
"strength": "required",
"description": "The type of resource",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/resource-types"
}
},
{
"id": "ExampleScenario.instance.name",
"path": "ExampleScenario.instance.name",
"short": "A short name for the resource instance",
"definition": "A short name for the resource instance.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.instance.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.description",
"path": "ExampleScenario.instance.description",
"short": "Human-friendly description of the resource instance",
"definition": "Human-friendly description of the resource instance.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.instance.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.version",
"path": "ExampleScenario.instance.version",
"short": "A specific version of the resource",
"definition": "A specific version of the resource.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.instance.version",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.version.id",
"path": "ExampleScenario.instance.version.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.instance.version.extension",
"path": "ExampleScenario.instance.version.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.instance.version.modifierExtension",
"path": "ExampleScenario.instance.version.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.instance.version.versionId",
"path": "ExampleScenario.instance.version.versionId",
"short": "The identifier of a specific version of a resource",
"definition": "The identifier of a specific version of a resource.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.instance.version.versionId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.version.description",
"path": "ExampleScenario.instance.version.description",
"short": "The description of the resource version",
"definition": "The description of the resource version.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.instance.version.description",
"min": 1,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.containedInstance",
"path": "ExampleScenario.instance.containedInstance",
"short": "Resources contained in the instance",
"definition": "Resources contained in the instance (e.g. the observations contained in a bundle).",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.instance.containedInstance",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.containedInstance.id",
"path": "ExampleScenario.instance.containedInstance.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.instance.containedInstance.extension",
"path": "ExampleScenario.instance.containedInstance.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.instance.containedInstance.modifierExtension",
"path": "ExampleScenario.instance.containedInstance.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.instance.containedInstance.resourceId",
"path": "ExampleScenario.instance.containedInstance.resourceId",
"short": "Each resource contained in the instance",
"definition": "Each resource contained in the instance.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.instance.containedInstance.resourceId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.instance.containedInstance.versionId",
"path": "ExampleScenario.instance.containedInstance.versionId",
"short": "A specific version of a resource contained in the instance",
"definition": "A specific version of a resource contained in the instance.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.instance.containedInstance.versionId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process",
"path": "ExampleScenario.process",
"short": "Each major process - a group of operations",
"definition": "Each major process - a group of operations.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.process",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.id",
"path": "ExampleScenario.process.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.extension",
"path": "ExampleScenario.process.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.modifierExtension",
"path": "ExampleScenario.process.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.process.title",
"path": "ExampleScenario.process.title",
"short": "The diagram title of the group of operations",
"definition": "The diagram title of the group of operations.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.process.title",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExampleScenario.process.description",
"path": "ExampleScenario.process.description",
"short": "A longer description of the group of operations",
"definition": "A longer description of the group of operations.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.preConditions",
"path": "ExampleScenario.process.preConditions",
"short": "Description of initial status before the process starts",
"definition": "Description of initial status before the process starts.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.preConditions",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.postConditions",
"path": "ExampleScenario.process.postConditions",
"short": "Description of final status after the process ends",
"definition": "Description of final status after the process ends.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.postConditions",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step",
"path": "ExampleScenario.process.step",
"short": "Each step of the process",
"definition": "Each step of the process.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.process.step",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.id",
"path": "ExampleScenario.process.step.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.step.extension",
"path": "ExampleScenario.process.step.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.step.modifierExtension",
"path": "ExampleScenario.process.step.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.process.step.process",
"path": "ExampleScenario.process.step.process",
"short": "Nested process",
"definition": "Nested process.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.process.step.process",
"min": 0,
"max": "*"
},
"contentReference": "#ExampleScenario.process",
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.pause",
"path": "ExampleScenario.process.step.pause",
"short": "If there is a pause in the flow",
"definition": "If there is a pause in the flow.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.pause",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation",
"path": "ExampleScenario.process.step.operation",
"short": "Each interaction or action",
"definition": "Each interaction or action.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.id",
"path": "ExampleScenario.process.step.operation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.step.operation.extension",
"path": "ExampleScenario.process.step.operation.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.step.operation.modifierExtension",
"path": "ExampleScenario.process.step.operation.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.process.step.operation.number",
"path": "ExampleScenario.process.step.operation.number",
"short": "The sequential number of the interaction",
"definition": "The sequential number of the interaction.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.number",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.type",
"path": "ExampleScenario.process.step.operation.type",
"short": "The type of operation - CRUD",
"definition": "The type of operation - CRUD.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.name",
"path": "ExampleScenario.process.step.operation.name",
"short": "The human-friendly name of the interaction",
"definition": "The human-friendly name of the interaction.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.initiator",
"path": "ExampleScenario.process.step.operation.initiator",
"short": "Who starts the transaction",
"definition": "Who starts the transaction.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.initiator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.receiver",
"path": "ExampleScenario.process.step.operation.receiver",
"short": "Who receives the transaction",
"definition": "Who receives the transaction.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.receiver",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.description",
"path": "ExampleScenario.process.step.operation.description",
"short": "A comment to be inserted in the diagram",
"definition": "A comment to be inserted in the diagram.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.initiatorActive",
"path": "ExampleScenario.process.step.operation.initiatorActive",
"short": "Whether the initiator is deactivated right after the transaction",
"definition": "Whether the initiator is deactivated right after the transaction.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.initiatorActive",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.receiverActive",
"path": "ExampleScenario.process.step.operation.receiverActive",
"short": "Whether the receiver is deactivated right after the transaction",
"definition": "Whether the receiver is deactivated right after the transaction.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.receiverActive",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.request",
"path": "ExampleScenario.process.step.operation.request",
"short": "Each resource instance used by the initiator",
"definition": "Each resource instance used by the initiator.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.request",
"min": 0,
"max": "1"
},
"contentReference": "#ExampleScenario.instance.containedInstance",
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.operation.response",
"path": "ExampleScenario.process.step.operation.response",
"short": "Each resource instance used by the responder",
"definition": "Each resource instance used by the responder.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.operation.response",
"min": 0,
"max": "1"
},
"contentReference": "#ExampleScenario.instance.containedInstance",
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.alternative",
"path": "ExampleScenario.process.step.alternative",
"short": "Each interaction in the process",
"definition": "Each interaction in the workflow.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.alternative",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.alternative.id",
"path": "ExampleScenario.process.step.alternative.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.extension",
"path": "ExampleScenario.process.step.alternative.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.modifierExtension",
"path": "ExampleScenario.process.step.alternative.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.name",
"path": "ExampleScenario.process.step.alternative.name",
"short": "The name of each alternative",
"definition": "The name of each alternative.",
"min": 0,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.alternative.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.alternative.option",
"path": "ExampleScenario.process.step.alternative.option",
"short": "Each of the possible options in an alternative",
"definition": "Each of the possible options in an alternative.",
"min": 1,
"max": "*",
"base": {
"path": "ExampleScenario.process.step.alternative.option",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.alternative.option.id",
"path": "ExampleScenario.process.step.alternative.option.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.option.extension",
"path": "ExampleScenario.process.step.alternative.option.extension",
"short": "Additional content defined by implementations",
"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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.option.modifierExtension",
"path": "ExampleScenario.process.step.alternative.option.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.option.description",
"path": "ExampleScenario.process.step.alternative.option.description",
"short": "A human-readable description of each option",
"definition": "A human-readable description of each option.",
"min": 1,
"max": "1",
"base": {
"path": "ExampleScenario.process.step.alternative.option.description",
"min": 1,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.alternative.option.step",
"path": "ExampleScenario.process.step.alternative.option.step",
"short": "What happens in each alternative option",
"definition": "What happens in each alternative option.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.process.step.alternative.option.step",
"min": 0,
"max": "*"
},
"contentReference": "#ExampleScenario.process.step",
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.process.step.alternative.option.pause",
"path": "ExampleScenario.process.step.alternative.option.pause",
"short": "If there is a pause in the flow",
"definition": "If there is a pause in the flow.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.process.step.alternative.option.pause",
"min": 0,
"max": "*"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "ExampleScenario.workflow",
"path": "ExampleScenario.workflow",
"short": "Another nested workflow",
"definition": "Another nested workflow.",
"min": 0,
"max": "*",
"base": {
"path": "ExampleScenario.workflow",
"min": 0,
"max": "*"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ExampleScenario"
]
}
],
"isModifier": false,
"isSummary": false
}
]
},
"differential": {
"element": [
{
"id": "ExampleScenario",
"path": "ExampleScenario",
"short": "Example of workflow instance",
"definition": "Example of workflow instance.",
"min": 0,
"max": "*"
},
{
"id": "ExampleScenario.url",
"path": "ExampleScenario.url",
"short": "Canonical identifier for this example scenario, represented as a URI (globally unique)",
"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 this example scenario is (or will be) published.",
"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 URL SHOULD include the major version of the example scenario. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the example scenario to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "ExampleScenario.identifier",
"path": "ExampleScenario.identifier",
"short": "Additional identifier for the example scenario",
"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.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this example scenario outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ExampleScenario.version",
"path": "ExampleScenario.version",
"short": "Business version of the example scenario",
"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.",
"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].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
}
]
},
{
"id": "ExampleScenario.name",
"path": "ExampleScenario.name",
"short": "Name for this example scenario (computer friendly)",
"definition": "A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ExampleScenario.status",
"path": "ExampleScenario.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this example scenario. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of example scenarios that are appropriate for use versus not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "ExampleScenario.experimental",
"path": "ExampleScenario.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of example scenarios that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level example scenario.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "ExampleScenario.date",
"path": "ExampleScenario.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the example scenario was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').",
"comment": "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.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "ExampleScenario.publisher",
"path": "ExampleScenario.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the example scenario.",
"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.",
"requirements": "Helps establish the \"authority/credibility\" of the example scenario. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
}
]
},
{
"id": "ExampleScenario.contact",
"path": "ExampleScenario.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "ExampleScenario.useContext",
"path": "ExampleScenario.useContext",
"short": "The context that the content is intended to support",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate example scenario instances.",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "ExampleScenario.jurisdiction",
"path": "ExampleScenario.jurisdiction",
"short": "Intended jurisdiction for example scenario (if applicable)",
"definition": "A legal or geographic region in which the example scenario is intended to be used.",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "ExampleScenario.copyright",
"path": "ExampleScenario.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.",
"comment": "null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the example scenario and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.copyright"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ExampleScenario.purpose",
"path": "ExampleScenario.purpose",
"short": "The purpose of the example, e.g. to illustrate a scenario",
"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.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ExampleScenario.actor",
"path": "ExampleScenario.actor",
"short": "Actor participating in the resource",
"definition": "Actor participating in the resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.actor.actorId",
"path": "ExampleScenario.actor.actorId",
"short": "ID or acronym of the actor",
"definition": "ID or acronym of actor.",
"comment": "should this be called ID or acronym?",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.actor.type",
"path": "ExampleScenario.actor.type",
"short": "person | entity",
"definition": "The type of actor - person or system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ExampleScenarioActorType"
}
],
"strength": "required",
"description": "The type of actor - system or human",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/examplescenario-actor-type"
}
},
{
"id": "ExampleScenario.actor.name",
"path": "ExampleScenario.actor.name",
"short": "The name of the actor as shown in the page",
"definition": "The name of the actor as shown in the page.",
"comment": "Cardinality: is name and description 1..1?",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.actor.description",
"path": "ExampleScenario.actor.description",
"short": "The description of the actor",
"definition": "The description of the actor.",
"comment": "Cardinality: is name and description 1..1?",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "ExampleScenario.instance",
"path": "ExampleScenario.instance",
"short": "Each resource and each version that is present in the workflow",
"definition": "Each resource and each version that is present in the workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.instance.resourceId",
"path": "ExampleScenario.instance.resourceId",
"short": "The id of the resource for referencing",
"definition": "The id of the resource for referencing.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.instance.resourceType",
"path": "ExampleScenario.instance.resourceType",
"short": "The type of the resource",
"definition": "The type of the resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceType"
}
],
"strength": "required",
"description": "The type of resource",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/resource-types"
}
},
{
"id": "ExampleScenario.instance.name",
"path": "ExampleScenario.instance.name",
"short": "A short name for the resource instance",
"definition": "A short name for the resource instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.instance.description",
"path": "ExampleScenario.instance.description",
"short": "Human-friendly description of the resource instance",
"definition": "Human-friendly description of the resource instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "ExampleScenario.instance.version",
"path": "ExampleScenario.instance.version",
"short": "A specific version of the resource",
"definition": "A specific version of the resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.instance.version.versionId",
"path": "ExampleScenario.instance.version.versionId",
"short": "The identifier of a specific version of a resource",
"definition": "The identifier of a specific version of a resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.instance.version.description",
"path": "ExampleScenario.instance.version.description",
"short": "The description of the resource version",
"definition": "The description of the resource version.",
"min": 1,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "ExampleScenario.instance.containedInstance",
"path": "ExampleScenario.instance.containedInstance",
"short": "Resources contained in the instance",
"definition": "Resources contained in the instance (e.g. the observations contained in a bundle).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.instance.containedInstance.resourceId",
"path": "ExampleScenario.instance.containedInstance.resourceId",
"short": "Each resource contained in the instance",
"definition": "Each resource contained in the instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.instance.containedInstance.versionId",
"path": "ExampleScenario.instance.containedInstance.versionId",
"short": "A specific version of a resource contained in the instance",
"definition": "A specific version of a resource contained in the instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.process",
"path": "ExampleScenario.process",
"short": "Each major process - a group of operations",
"definition": "Each major process - a group of operations.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.process.title",
"path": "ExampleScenario.process.title",
"short": "The diagram title of the group of operations",
"definition": "The diagram title of the group of operations.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ExampleScenario.process.description",
"path": "ExampleScenario.process.description",
"short": "A longer description of the group of operations",
"definition": "A longer description of the group of operations.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "ExampleScenario.process.preConditions",
"path": "ExampleScenario.process.preConditions",
"short": "Description of initial status before the process starts",
"definition": "Description of initial status before the process starts.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "ExampleScenario.process.postConditions",
"path": "ExampleScenario.process.postConditions",
"short": "Description of final status after the process ends",
"definition": "Description of final status after the process ends.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "ExampleScenario.process.step",
"path": "ExampleScenario.process.step",
"short": "Each step of the process",
"definition": "Each step of the process.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.process.step.process",
"path": "ExampleScenario.process.step.process",
"short": "Nested process",
"definition": "Nested process.",
"min": 0,
"max": "*",
"contentReference": "#ExampleScenario.process"
},
{
"id": "ExampleScenario.process.step.pause",
"path": "ExampleScenario.process.step.pause",
"short": "If there is a pause in the flow",
"definition": "If there is a pause in the flow.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "ExampleScenario.process.step.operation",
"path": "ExampleScenario.process.step.operation",
"short": "Each interaction or action",
"definition": "Each interaction or action.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.process.step.operation.number",
"path": "ExampleScenario.process.step.operation.number",
"short": "The sequential number of the interaction",
"definition": "The sequential number of the interaction.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.process.step.operation.type",
"path": "ExampleScenario.process.step.operation.type",
"short": "The type of operation - CRUD",
"definition": "The type of operation - CRUD.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.process.step.operation.name",
"path": "ExampleScenario.process.step.operation.name",
"short": "The human-friendly name of the interaction",
"definition": "The human-friendly name of the interaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.process.step.operation.initiator",
"path": "ExampleScenario.process.step.operation.initiator",
"short": "Who starts the transaction",
"definition": "Who starts the transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.process.step.operation.receiver",
"path": "ExampleScenario.process.step.operation.receiver",
"short": "Who receives the transaction",
"definition": "Who receives the transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.process.step.operation.description",
"path": "ExampleScenario.process.step.operation.description",
"short": "A comment to be inserted in the diagram",
"definition": "A comment to be inserted in the diagram.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "ExampleScenario.process.step.operation.initiatorActive",
"path": "ExampleScenario.process.step.operation.initiatorActive",
"short": "Whether the initiator is deactivated right after the transaction",
"definition": "Whether the initiator is deactivated right after the transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "ExampleScenario.process.step.operation.receiverActive",
"path": "ExampleScenario.process.step.operation.receiverActive",
"short": "Whether the receiver is deactivated right after the transaction",
"definition": "Whether the receiver is deactivated right after the transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "ExampleScenario.process.step.operation.request",
"path": "ExampleScenario.process.step.operation.request",
"short": "Each resource instance used by the initiator",
"definition": "Each resource instance used by the initiator.",
"min": 0,
"max": "1",
"contentReference": "#ExampleScenario.instance.containedInstance"
},
{
"id": "ExampleScenario.process.step.operation.response",
"path": "ExampleScenario.process.step.operation.response",
"short": "Each resource instance used by the responder",
"definition": "Each resource instance used by the responder.",
"min": 0,
"max": "1",
"contentReference": "#ExampleScenario.instance.containedInstance"
},
{
"id": "ExampleScenario.process.step.alternative",
"path": "ExampleScenario.process.step.alternative",
"short": "Each interaction in the process",
"definition": "Each interaction in the workflow.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.name",
"path": "ExampleScenario.process.step.alternative.name",
"short": "The name of each alternative",
"definition": "The name of each alternative.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.option",
"path": "ExampleScenario.process.step.alternative.option",
"short": "Each of the possible options in an alternative",
"definition": "Each of the possible options in an alternative.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.option.description",
"path": "ExampleScenario.process.step.alternative.option.description",
"short": "A human-readable description of each option",
"definition": "A human-readable description of each option.",
"min": 1,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "ExampleScenario.process.step.alternative.option.step",
"path": "ExampleScenario.process.step.alternative.option.step",
"short": "What happens in each alternative option",
"definition": "What happens in each alternative option.",
"min": 0,
"max": "*",
"contentReference": "#ExampleScenario.process.step"
},
{
"id": "ExampleScenario.process.step.alternative.option.pause",
"path": "ExampleScenario.process.step.alternative.option.pause",
"short": "If there is a pause in the flow",
"definition": "If there is a pause in the flow.",
"min": 0,
"max": "*",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "ExampleScenario.workflow",
"path": "ExampleScenario.workflow",
"short": "Another nested workflow",
"definition": "Another nested workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ExampleScenario"
]
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:15+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change