Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-ExampleScenario | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_ExampleScenario_R4 | ||
This cross-version profile allows R5 ExampleScenario content to be represented via FHIR R4 ExampleScenario resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ExampleScenario |
C | 0..* | ExampleScenario(4.0.1) | Example of workflow instance Constraints: esc-0 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |
| extension:title |
0..1 | string | R5: Name for this example scenario (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |
| extension:description |
0..1 | markdown | R5: Natural language description of the ExampleScenario (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |
 extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
 status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ExampleScenario.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ExampleScenario | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ExampleScenario | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ExampleScenario | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ExampleScenario | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ExampleScenario | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ExampleScenario.implicitRules, ExampleScenario.extension, ExampleScenario.extension:versionAlgorithm, ExampleScenario.extension:title, ExampleScenario.extension:description, ExampleScenario.extension:copyrightLabel, ExampleScenario.modifierExtension, ExampleScenario.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| esc-0 | warning | ExampleScenario | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| ext-1 | error | ExampleScenario.extension, ExampleScenario.extension:versionAlgorithm, ExampleScenario.extension:title, ExampleScenario.extension:description, ExampleScenario.extension:copyrightLabel, ExampleScenario.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ExampleScenario
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ExampleScenario |
C | 0..* | ExampleScenario(4.0.1) | Example of workflow instance Constraints: esc-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages  (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: Name for this example scenario (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |||||
| extension:description |
0..1 | markdown | R5: Natural language description of the ExampleScenario (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this example scenario, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the example scenario | ||||
| version |
Σ | 0..1 | string | Business version of the example scenario | ||||
| name |
ΣC | 0..1 | string | Name for this example scenario (computer friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for example scenario (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| purpose |
0..1 | markdown | The purpose of the example, e.g. to illustrate a scenario | |||||
| actor |
0..* | BackboneElement | Actor participating in the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| actorId |
1..1 | string | ID or acronym of the actor | |||||
| type |
1..1 | code | person | entity Binding: ExampleScenarioActorType (required): The type of actor - system or human. | |||||
| name |
0..1 | string | The name of the actor as shown in the page | |||||
| description |
0..1 | markdown | The description of the actor | |||||
| instance |
0..* | BackboneElement | Each resource and each version that is present in the workflow | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:structureVersion |
0..1 | string | R5: E.g. 4.0.1 (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureVersion Constraints: ext-1 | |||||
| extension:structureProfile |
0..1 | canonical(), uri | R5: Rules instance adheres to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureProfile Constraints: ext-1 | |||||
| extension:content |
0..1 | Reference() | R5: Example instance data (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| resourceId |
1..1 | string | The id of the resource for referencing | |||||
| resourceType |
1..1 | code | The type of the resource Binding: ResourceType (required): The type of resource. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:structureType |
0..1 | Coding | R5: Data structure for example additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureType Binding: R5ExamplescenarioInstanceTypeForR4 (0.1.0) (extensible): The structure that defines the instance Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| name |
0..1 | string | A short name for the resource instance | |||||
| description |
0..1 | markdown | Human-friendly description of the resource instance | |||||
| version |
0..* | BackboneElement | A specific version of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:title |
1..1 | string | R5: Label for instance version (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title Constraints: ext-1 | |||||
| extension:content |
0..1 | Reference() | R5: Example instance version data (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| versionId |
1..1 | string | The identifier of a specific version of a resource | |||||
| description |
1..1 | markdown | The description of the resource version | |||||
 containedInstance |
0..* | BackboneElement | Resources contained in the instance | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| resourceId |
1..1 | string | Each resource contained in the instance | |||||
| versionId |
0..1 | string | A specific version of a resource contained in the instance | |||||
| process |
0..* | BackboneElement | Each major process - a group of operations | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| title |
Σ | 1..1 | string | The diagram title of the group of operations | ||||
| description |
0..1 | markdown | A longer description of the group of operations | |||||
| preConditions |
0..1 | markdown | Description of initial status before the process starts | |||||
| postConditions |
0..1 | markdown | Description of final status after the process ends | |||||
| step |
0..* | BackboneElement | Each step of the process | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:number |
0..1 | string | R5: Sequential number of the step (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.number Constraints: ext-1 | |||||
| extension:workflow |
0..1 | canonical(Cross-version Profile for R5.ExampleScenario for use in FHIR R4(0.1.0) | ExampleScenario) | R5: Step is nested workflow (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.workflow Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
 process |
0..* | See process (ExampleScenario) | Nested process | |||||
| pause |
0..1 | boolean | If there is a pause in the flow | |||||
| operation |
0..1 | BackboneElement | Each interaction or action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| number |
1..1 | string | The sequential number of the interaction | |||||
| type |
0..1 | string | The type of operation - CRUD | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
0..1 | Coding | R5: Kind of action additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.operation.type Binding: R5TestscriptOperationCodesForR4 (0.1.0) (extensible) Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| name |
0..1 | string | The human-friendly name of the interaction | |||||
| initiator |
0..1 | string | Who starts the transaction | |||||
| receiver |
0..1 | string | Who receives the transaction | |||||
| description |
0..1 | markdown | A comment to be inserted in the diagram | |||||
| initiatorActive |
0..1 | boolean | Whether the initiator is deactivated right after the transaction | |||||
| receiverActive |
0..1 | boolean | Whether the receiver is deactivated right after the transaction | |||||
| request |
0..1 | See containedInstance (ExampleScenario) | Each resource instance used by the initiator | |||||
| response |
0..1 | See containedInstance (ExampleScenario) | Each resource instance used by the responder | |||||
| alternative |
0..* | BackboneElement | Alternate non-typical step action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| title |
1..1 | string | Label for alternative | |||||
| description |
0..1 | markdown | A human-readable description of each option | |||||
| step |
0..* | See step (ExampleScenario) | What happens in each alternative option | |||||
| workflow |
0..* | canonical(ExampleScenario) | Another nested workflow | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ExampleScenario.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| ExampleScenario.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ExampleScenario.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ExampleScenario.actor.type | Base | required | ExampleScenarioActorType | 📍4.0.1 | FHIR Std. |
| ExampleScenario.instance.resourceType | Base | required |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ExampleScenario | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ExampleScenario | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ExampleScenario | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ExampleScenario | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ExampleScenario | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ExampleScenario.meta, ExampleScenario.implicitRules, ExampleScenario.language, ExampleScenario.text, ExampleScenario.extension, ExampleScenario.extension:versionAlgorithm, ExampleScenario.extension:title, ExampleScenario.extension:description, ExampleScenario.extension:copyrightLabel, ExampleScenario.modifierExtension, ExampleScenario.url, ExampleScenario.identifier, ExampleScenario.version, ExampleScenario.name, ExampleScenario.status, ExampleScenario.experimental, ExampleScenario.date, ExampleScenario.publisher, ExampleScenario.contact, ExampleScenario.useContext, ExampleScenario.jurisdiction, ExampleScenario.copyright, ExampleScenario.purpose, ExampleScenario.actor, ExampleScenario.actor.extension, ExampleScenario.actor.modifierExtension, ExampleScenario.actor.actorId, ExampleScenario.actor.type, ExampleScenario.actor.name, ExampleScenario.actor.description, ExampleScenario.instance, ExampleScenario.instance.extension, ExampleScenario.instance.extension:structureVersion, ExampleScenario.instance.extension:structureProfile, ExampleScenario.instance.extension:content, ExampleScenario.instance.modifierExtension, ExampleScenario.instance.resourceId, ExampleScenario.instance.resourceType, ExampleScenario.instance.resourceType.extension, ExampleScenario.instance.resourceType.extension:structureType, ExampleScenario.instance.name, ExampleScenario.instance.description, ExampleScenario.instance.version, ExampleScenario.instance.version.extension, ExampleScenario.instance.version.extension:title, ExampleScenario.instance.version.extension:content, ExampleScenario.instance.version.modifierExtension, ExampleScenario.instance.version.versionId, ExampleScenario.instance.version.description, ExampleScenario.instance.containedInstance, ExampleScenario.instance.containedInstance.extension, ExampleScenario.instance.containedInstance.modifierExtension, ExampleScenario.instance.containedInstance.resourceId, ExampleScenario.instance.containedInstance.versionId, ExampleScenario.process, ExampleScenario.process.extension, ExampleScenario.process.modifierExtension, ExampleScenario.process.title, ExampleScenario.process.description, ExampleScenario.process.preConditions, ExampleScenario.process.postConditions, ExampleScenario.process.step, ExampleScenario.process.step.extension, ExampleScenario.process.step.extension:number, ExampleScenario.process.step.extension:workflow, ExampleScenario.process.step.modifierExtension, ExampleScenario.process.step.process, ExampleScenario.process.step.pause, ExampleScenario.process.step.operation, ExampleScenario.process.step.operation.extension, ExampleScenario.process.step.operation.modifierExtension, ExampleScenario.process.step.operation.number, ExampleScenario.process.step.operation.type, ExampleScenario.process.step.operation.type.extension, ExampleScenario.process.step.operation.type.extension:type, ExampleScenario.process.step.operation.name, ExampleScenario.process.step.operation.initiator, ExampleScenario.process.step.operation.receiver, ExampleScenario.process.step.operation.description, ExampleScenario.process.step.operation.initiatorActive, ExampleScenario.process.step.operation.receiverActive, ExampleScenario.process.step.operation.request, ExampleScenario.process.step.operation.response, ExampleScenario.process.step.alternative, ExampleScenario.process.step.alternative.extension, ExampleScenario.process.step.alternative.modifierExtension, ExampleScenario.process.step.alternative.title, ExampleScenario.process.step.alternative.description, ExampleScenario.process.step.alternative.step, ExampleScenario.workflow | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| esc-0 | warning | ExampleScenario | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| ext-1 | error | ExampleScenario.extension, ExampleScenario.extension:versionAlgorithm, ExampleScenario.extension:title, ExampleScenario.extension:description, ExampleScenario.extension:copyrightLabel, ExampleScenario.modifierExtension, ExampleScenario.actor.extension, ExampleScenario.actor.modifierExtension, ExampleScenario.instance.extension, ExampleScenario.instance.extension:structureVersion, ExampleScenario.instance.extension:structureProfile, ExampleScenario.instance.extension:content, ExampleScenario.instance.modifierExtension, ExampleScenario.instance.resourceType.extension, ExampleScenario.instance.resourceType.extension:structureType, ExampleScenario.instance.version.extension, ExampleScenario.instance.version.extension:title, ExampleScenario.instance.version.extension:content, ExampleScenario.instance.version.modifierExtension, ExampleScenario.instance.containedInstance.extension, ExampleScenario.instance.containedInstance.modifierExtension, ExampleScenario.process.extension, ExampleScenario.process.modifierExtension, ExampleScenario.process.step.extension, ExampleScenario.process.step.extension:number, ExampleScenario.process.step.extension:workflow, ExampleScenario.process.step.modifierExtension, ExampleScenario.process.step.operation.extension, ExampleScenario.process.step.operation.modifierExtension, ExampleScenario.process.step.operation.type.extension, ExampleScenario.process.step.operation.type.extension:type, ExampleScenario.process.step.alternative.extension, ExampleScenario.process.step.alternative.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ExampleScenario
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ExampleScenario |
C | 0..* | ExampleScenario(4.0.1) | Example of workflow instance Constraints: esc-0 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |
| extension:title |
0..1 | string | R5: Name for this example scenario (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |
| extension:description |
0..1 | markdown | R5: Natural language description of the ExampleScenario (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ExampleScenario.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ExampleScenario | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ExampleScenario | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ExampleScenario | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ExampleScenario | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ExampleScenario | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ExampleScenario.implicitRules, ExampleScenario.extension, ExampleScenario.extension:versionAlgorithm, ExampleScenario.extension:title, ExampleScenario.extension:description, ExampleScenario.extension:copyrightLabel, ExampleScenario.modifierExtension, ExampleScenario.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| esc-0 | warning | ExampleScenario | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| ext-1 | error | ExampleScenario.extension, ExampleScenario.extension:versionAlgorithm, ExampleScenario.extension:title, ExampleScenario.extension:description, ExampleScenario.extension:copyrightLabel, ExampleScenario.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ExampleScenario
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ExampleScenario |
C | 0..* | ExampleScenario(4.0.1) | Example of workflow instance Constraints: esc-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: Name for this example scenario (human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |||||
| extension:description |
0..1 | markdown | R5: Natural language description of the ExampleScenario (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this example scenario, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the example scenario | ||||
| version |
Σ | 0..1 | string | Business version of the example scenario | ||||
| name |
ΣC | 0..1 | string | Name for this example scenario (computer friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for example scenario (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| purpose |
0..1 | markdown | The purpose of the example, e.g. to illustrate a scenario | |||||
| actor |
0..* | BackboneElement | Actor participating in the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| actorId |
1..1 | string | ID or acronym of the actor | |||||
| type |
1..1 | code | person | entity Binding: ExampleScenarioActorType (required): The type of actor - system or human. | |||||
| name |
0..1 | string | The name of the actor as shown in the page | |||||
| description |
0..1 | markdown | The description of the actor | |||||
| instance |
0..* | BackboneElement | Each resource and each version that is present in the workflow | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:structureVersion |
0..1 | string | R5: E.g. 4.0.1 (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureVersion Constraints: ext-1 | |||||
| extension:structureProfile |
0..1 | canonical(), uri | R5: Rules instance adheres to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureProfile Constraints: ext-1 | |||||
| extension:content |
0..1 | Reference() | R5: Example instance data (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| resourceId |
1..1 | string | The id of the resource for referencing | |||||
| resourceType |
1..1 | code | The type of the resource Binding: ResourceType (required): The type of resource. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:structureType |
0..1 | Coding | R5: Data structure for example additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.structureType Binding: R5ExamplescenarioInstanceTypeForR4 (0.1.0) (extensible): The structure that defines the instance Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| name |
0..1 | string | A short name for the resource instance | |||||
| description |
0..1 | markdown | Human-friendly description of the resource instance | |||||
| version |
0..* | BackboneElement | A specific version of the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:title |
1..1 | string | R5: Label for instance version (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title Constraints: ext-1 | |||||
| extension:content |
0..1 | Reference() | R5: Example instance version data (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| versionId |
1..1 | string | The identifier of a specific version of a resource | |||||
| description |
1..1 | markdown | The description of the resource version | |||||
| containedInstance |
0..* | BackboneElement | Resources contained in the instance | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| resourceId |
1..1 | string | Each resource contained in the instance | |||||
| versionId |
0..1 | string | A specific version of a resource contained in the instance | |||||
| process |
0..* | BackboneElement | Each major process - a group of operations | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| title |
Σ | 1..1 | string | The diagram title of the group of operations | ||||
| description |
0..1 | markdown | A longer description of the group of operations | |||||
| preConditions |
0..1 | markdown | Description of initial status before the process starts | |||||
| postConditions |
0..1 | markdown | Description of final status after the process ends | |||||
| step |
0..* | BackboneElement | Each step of the process | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:number |
0..1 | string | R5: Sequential number of the step (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.number Constraints: ext-1 | |||||
| extension:workflow |
0..1 | canonical(Cross-version Profile for R5.ExampleScenario for use in FHIR R4(0.1.0) | ExampleScenario) | R5: Step is nested workflow (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.workflow Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| process |
0..* | See process (ExampleScenario) | Nested process | |||||
| pause |
0..1 | boolean | If there is a pause in the flow | |||||
| operation |
0..1 | BackboneElement | Each interaction or action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| number |
1..1 | string | The sequential number of the interaction | |||||
| type |
0..1 | string | The type of operation - CRUD | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
0..1 | Coding | R5: Kind of action additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.process.step.operation.type Binding: R5TestscriptOperationCodesForR4 (0.1.0) (extensible) Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| name |
0..1 | string | The human-friendly name of the interaction | |||||
| initiator |
0..1 | string | Who starts the transaction | |||||
| receiver |
0..1 | string | Who receives the transaction | |||||
| description |
0..1 | markdown | A comment to be inserted in the diagram | |||||
| initiatorActive |
0..1 | boolean | Whether the initiator is deactivated right after the transaction | |||||
| receiverActive |
0..1 | boolean | Whether the receiver is deactivated right after the transaction | |||||
| request |
0..1 | See containedInstance (ExampleScenario) | Each resource instance used by the initiator | |||||
| response |
0..1 | See containedInstance (ExampleScenario) | Each resource instance used by the responder | |||||
| alternative |
0..* | BackboneElement | Alternate non-typical step action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| title |
1..1 | string | Label for alternative | |||||
| description |
0..1 | markdown | A human-readable description of each option | |||||
| step |
0..* | See step (ExampleScenario) | What happens in each alternative option | |||||
| workflow |
0..* | canonical(ExampleScenario) | Another nested workflow | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ExampleScenario.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| ExampleScenario.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ExampleScenario.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ExampleScenario.actor.type | Base | required | ExampleScenarioActorType | 📍4.0.1 | FHIR Std. |
| ExampleScenario.instance.resourceType | Base | required |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ExampleScenario | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ExampleScenario | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ExampleScenario | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ExampleScenario | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ExampleScenario | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ExampleScenario.meta, ExampleScenario.implicitRules, ExampleScenario.language, ExampleScenario.text, ExampleScenario.extension, ExampleScenario.extension:versionAlgorithm, ExampleScenario.extension:title, ExampleScenario.extension:description, ExampleScenario.extension:copyrightLabel, ExampleScenario.modifierExtension, ExampleScenario.url, ExampleScenario.identifier, ExampleScenario.version, ExampleScenario.name, ExampleScenario.status, ExampleScenario.experimental, ExampleScenario.date, ExampleScenario.publisher, ExampleScenario.contact, ExampleScenario.useContext, ExampleScenario.jurisdiction, ExampleScenario.copyright, ExampleScenario.purpose, ExampleScenario.actor, ExampleScenario.actor.extension, ExampleScenario.actor.modifierExtension, ExampleScenario.actor.actorId, ExampleScenario.actor.type, ExampleScenario.actor.name, ExampleScenario.actor.description, ExampleScenario.instance, ExampleScenario.instance.extension, ExampleScenario.instance.extension:structureVersion, ExampleScenario.instance.extension:structureProfile, ExampleScenario.instance.extension:content, ExampleScenario.instance.modifierExtension, ExampleScenario.instance.resourceId, ExampleScenario.instance.resourceType, ExampleScenario.instance.resourceType.extension, ExampleScenario.instance.resourceType.extension:structureType, ExampleScenario.instance.name, ExampleScenario.instance.description, ExampleScenario.instance.version, ExampleScenario.instance.version.extension, ExampleScenario.instance.version.extension:title, ExampleScenario.instance.version.extension:content, ExampleScenario.instance.version.modifierExtension, ExampleScenario.instance.version.versionId, ExampleScenario.instance.version.description, ExampleScenario.instance.containedInstance, ExampleScenario.instance.containedInstance.extension, ExampleScenario.instance.containedInstance.modifierExtension, ExampleScenario.instance.containedInstance.resourceId, ExampleScenario.instance.containedInstance.versionId, ExampleScenario.process, ExampleScenario.process.extension, ExampleScenario.process.modifierExtension, ExampleScenario.process.title, ExampleScenario.process.description, ExampleScenario.process.preConditions, ExampleScenario.process.postConditions, ExampleScenario.process.step, ExampleScenario.process.step.extension, ExampleScenario.process.step.extension:number, ExampleScenario.process.step.extension:workflow, ExampleScenario.process.step.modifierExtension, ExampleScenario.process.step.process, ExampleScenario.process.step.pause, ExampleScenario.process.step.operation, ExampleScenario.process.step.operation.extension, ExampleScenario.process.step.operation.modifierExtension, ExampleScenario.process.step.operation.number, ExampleScenario.process.step.operation.type, ExampleScenario.process.step.operation.type.extension, ExampleScenario.process.step.operation.type.extension:type, ExampleScenario.process.step.operation.name, ExampleScenario.process.step.operation.initiator, ExampleScenario.process.step.operation.receiver, ExampleScenario.process.step.operation.description, ExampleScenario.process.step.operation.initiatorActive, ExampleScenario.process.step.operation.receiverActive, ExampleScenario.process.step.operation.request, ExampleScenario.process.step.operation.response, ExampleScenario.process.step.alternative, ExampleScenario.process.step.alternative.extension, ExampleScenario.process.step.alternative.modifierExtension, ExampleScenario.process.step.alternative.title, ExampleScenario.process.step.alternative.description, ExampleScenario.process.step.alternative.step, ExampleScenario.workflow | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| esc-0 | warning | ExampleScenario | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| ext-1 | error | ExampleScenario.extension, ExampleScenario.extension:versionAlgorithm, ExampleScenario.extension:title, ExampleScenario.extension:description, ExampleScenario.extension:copyrightLabel, ExampleScenario.modifierExtension, ExampleScenario.actor.extension, ExampleScenario.actor.modifierExtension, ExampleScenario.instance.extension, ExampleScenario.instance.extension:structureVersion, ExampleScenario.instance.extension:structureProfile, ExampleScenario.instance.extension:content, ExampleScenario.instance.modifierExtension, ExampleScenario.instance.resourceType.extension, ExampleScenario.instance.resourceType.extension:structureType, ExampleScenario.instance.version.extension, ExampleScenario.instance.version.extension:title, ExampleScenario.instance.version.extension:content, ExampleScenario.instance.version.modifierExtension, ExampleScenario.instance.containedInstance.extension, ExampleScenario.instance.containedInstance.modifierExtension, ExampleScenario.process.extension, ExampleScenario.process.modifierExtension, ExampleScenario.process.step.extension, ExampleScenario.process.step.extension:number, ExampleScenario.process.step.extension:workflow, ExampleScenario.process.step.modifierExtension, ExampleScenario.process.step.operation.extension, ExampleScenario.process.step.operation.modifierExtension, ExampleScenario.process.step.operation.type.extension, ExampleScenario.process.step.operation.type.extension:type, ExampleScenario.process.step.alternative.extension, ExampleScenario.process.step.alternative.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ExampleScenario
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change