Generated Narrative: StructureDefinition ext-R5-SubscriptionTopic.resourceTrigger Name Flags Card. Type Description & Constraints Extension 0..* Extension(4.0.1) R5: Definition of a resource-based trigger for the subscription topic (new) #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:description 0..1 Extension R5: Text representation of the resource trigger (new) #xD; url 1..1 uri "description" #xD; value[x] 0..1 markdown Text representation of the resource trigger #xD; extension:resource 1..1 Extension R5: Data Type or Resource (reference to definition) for this trigger definition (new) #xD; url 1..1 uri "resource" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic.resourceTrigger-definitions.html#Extension.extension:resource.value[x]" title="URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see [ElementDefinition.type.code](https://hl7.org/fhir/elementdefinition-definition.html#ElementDefinition.type.code).">value[x] 1..1 uri Data Type or Resource (reference to definition) for this trigger definition Binding: R5SubscriptionTypesForR4 (0.1.0) (extensible): A type of resource, or a Reference (from all versions) #xD; extension:supportedInteraction 0..* Extension R5: create | update | delete (new) #xD; url 1..1 uri "supportedInteraction" #xD; value[x] 0..1 code create | update | delete Binding: R5InteractionTriggerForR4 (0.1.0) (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. #xD; extension:queryCriteria 0..1 Extension R5: Query based trigger rule (new) #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:previous 0..1 Extension R5: Rule applied to previous resource state (new) #xD; url 1..1 uri "previous" #xD; value[x] 0..1 string Rule applied to previous resource state #xD; extension:resultForCreate 0..1 Extension R5: test-passes | test-fails (new) #xD; url 1..1 uri "resultForCreate" #xD; value[x] 0..1 code test-passes | test-fails Binding: R5SubscriptiontopicCrBehaviorForR4 (0.1.0) (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). #xD; extension:current 0..1 Extension R5: Rule applied to current resource state (new) #xD; url 1..1 uri "current" #xD; value[x] 0..1 string Rule applied to current resource state #xD; extension:resultForDelete 0..1 Extension R5: test-passes | test-fails (new) #xD; url 1..1 uri "resultForDelete" #xD; value[x] 0..1 code test-passes | test-fails Binding: R5SubscriptiontopicCrBehaviorForR4 (0.1.0) (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). #xD; extension:requireBoth 0..1 Extension R5: Both must be true flag (new) #xD; url 1..1 uri "requireBoth" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic.resourceTrigger-definitions.html#Extension.extension:queryCriteria.extension:requireBoth.value[x]" title="If set to `true`, both the `current` and `previous` query criteria must evaluate `true` to trigger a notification for this topic. If set to `false` or not present, a notification for this topic will be triggered if either the `current` or `previous` tests evaluate to `true`.">value[x] 0..1 boolean Both must be true flag #xD; url 1..1 uri "queryCriteria" #xD; value[x] 0..0 Value of extension #xD; extension:fhirPathCriteria 0..1 Extension R5: FHIRPath based trigger rule (new) #xD; url 1..1 uri "fhirPathCriteria" #xD; value[x] 0..1 string FHIRPath based trigger rule #xD; url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.resourceTrigger" #xD; value[x] 0..0 Value of extension #xD; Documentation for this format
R5: Definition of a resource-based trigger for the subscription topic (new)
R5: `SubscriptionTopic.resourceTrigger` (new:BackboneElement)
This extension is part of the cross-version definitions generated to enable use of the element `SubscriptionTopic.resourceTrigger` as defined in FHIR R5 in FHIR R4. The source element is defined as: `SubscriptionTopic.resourceTrigger` 0..* `BackboneElement` Across FHIR versions, the element set has been mapped as: * R5: `SubscriptionTopic.resourceTrigger` 0..* `BackboneElement` Following are the generation technical comments: Element `SubscriptionTopic.resourceTrigger` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Element `SubscriptionTopic.resourceTrigger` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
R5: Text representation of the resource trigger (new)
R5: `SubscriptionTopic.resourceTrigger.description` (new:markdown)
Element `SubscriptionTopic.resourceTrigger.description` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.description` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.description` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.
Element `SubscriptionTopic.resourceTrigger.description` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.description` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.description` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Additional content defined by implementations
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.
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.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Text representation of the resource trigger
The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state".
Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.
R5: Data Type or Resource (reference to definition) for this trigger definition (new)
R5: `SubscriptionTopic.resourceTrigger.resource` (new:uri)
Element `SubscriptionTopic.resourceTrigger.resource` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.resource` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.resource` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Data Type or Resource (reference to definition) for this trigger definition
URL of the Resource that is the type used in this resource trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see [ElementDefinition.type.code](https://hl7.org/fhir/elementdefinition-definition.html#ElementDefinition.type.code).
A type of resource, or a Reference (from all versions)
R5: `SubscriptionTopic.resourceTrigger.supportedInteraction` (new:code)
Element `SubscriptionTopic.resourceTrigger.supportedInteraction` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.supportedInteraction` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.supportedInteraction` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE). If not present, all supported interactions are assumed.
FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.
R5: `SubscriptionTopic.resourceTrigger.queryCriteria` (new:BackboneElement)
Element `SubscriptionTopic.resourceTrigger.queryCriteria` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
R5: Rule applied to previous resource state (new)
R5: `SubscriptionTopic.resourceTrigger.queryCriteria.previous` (new:string)
Element `SubscriptionTopic.resourceTrigger.queryCriteria.previous` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger.queryCriteria` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria.previous` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria.previous` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character (`/`).
Element `SubscriptionTopic.resourceTrigger.queryCriteria.previous` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger.queryCriteria` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria.previous` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria.previous` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
The FHIR query based rules are applied to the previous resource state (e.g., state before an update).
The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character (`/`).
R5: `SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate` (new:code)
Element `SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger.queryCriteria` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
For `create` interactions, should the `previous` criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during `create` interactions is unspecified (server discretion).
Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).
R5: Rule applied to current resource state (new)
R5: `SubscriptionTopic.resourceTrigger.queryCriteria.current` (new:string)
Element `SubscriptionTopic.resourceTrigger.queryCriteria.current` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger.queryCriteria` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria.current` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria.current` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character (`/`).
Element `SubscriptionTopic.resourceTrigger.queryCriteria.current` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger.queryCriteria` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria.current` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria.current` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
The FHIR query based rules are applied to the current resource state (e.g., state after an update).
R5: `SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete` (new:code)
Element `SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger.queryCriteria` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
For 'delete' interactions, should the 'current' query criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during `delete` interactions is unspecified (server discretion).
R5: `SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth` (new:boolean)
Element `SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger.queryCriteria` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Please note the interaction between this element and the `resultForCreate`/`resultForDelete` elements during `create` and `delete` interactions. For example, if `resultForCreate` is set to `test-passes`, setting `requireBoth` to `false` means that every `create` will trigger a notification while setting `requireBoth` to `true` will result in notifications if the `current` test passes. Similarly, if `resultForCreate` is set to `test-fails`, setting `requireBoth` to `true` means that no `create` will be able to generate a notification while setting `requireBoth` to `false` will result in notifications if the `current` test passes.
Element `SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger.queryCriteria` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
If set to `true`, both the `current` and `previous` query criteria must evaluate `true` to trigger a notification for this topic. If set to `false` or not present, a notification for this topic will be triggered if either the `current` or `previous` tests evaluate to `true`.
Please note the interaction between this element and the `resultForCreate`/`resultForDelete` elements during `create` and `delete` interactions. For example, if `resultForCreate` is set to `test-passes`, setting `requireBoth` to `false` means that every `create` will trigger a notification while setting `requireBoth` to `true` will result in notifications if the `current` test passes. Similarly, if `resultForCreate` is set to `test-fails`, setting `requireBoth` to `true` means that no `create` will be able to generate a notification while setting `requireBoth` to `false` will result in notifications if the `current` test passes.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
R5: `SubscriptionTopic.resourceTrigger.fhirPathCriteria` (new:string)
Element `SubscriptionTopic.resourceTrigger.fhirPathCriteria` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.fhirPathCriteria` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.fhirPathCriteria` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). FHIRPath expression with %previous and %current vars.
Element `SubscriptionTopic.resourceTrigger.fhirPathCriteria` is part of an existing definition because parent element `SubscriptionTopic.resourceTrigger` requires a cross-version extension. Element `SubscriptionTopic.resourceTrigger.fhirPathCriteria` is not mapped to FHIR R4, since FHIR R5 `SubscriptionTopic` is not mapped. Element `SubscriptionTopic.resourceTrigger.fhirPathCriteria` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.
FHIRPath expression with %previous and %current vars.