Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the ext-R5-SubscriptionTopic.resourceTrigger extension.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R5: Optional Extension Element - found in all resources. |
| Short | R5: Definition of a resource-based trigger for the subscription topic (new)Optional Extensions Element |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 2. Extension.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 10..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:description | |
| Slice Name | description |
| Definition | R5: |
| Short | R5: Text representation of the resource trigger (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 6. Extension.extension:description.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | description |
| 8. Extension.extension:description.value[x] | |
| Definition | The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state". Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Text representation of the resource triggerValue of extension |
| Comments | Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition. |
| Control | 0..1 |
| Type | markdown, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Extension.extension:resource | |
| Slice Name | resource |
| Definition | R5: |
| Short | R5: Data Type or Resource (reference to definition) for this trigger definition (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 10..1* |
| Type | Extension |
| Requirements | Element |
| 12. Extension.extension:resource.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | resource |
| 14. Extension.extension:resource.value[x] | |
| 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Data Type or Resource (reference to definition) for this trigger definitionValue of extension |
| Control | 10..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see R5SubscriptionTypesForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R3|0.1.0)A type of resource, or a Reference (from all versions) |
| Type | uri, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Extension.extension:supportedInteraction | |
| Slice Name | supportedInteraction |
| Definition | R5: |
| Short | R5: create | update | delete (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:supportedInteraction.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | supportedInteraction |
| 20. Extension.extension:supportedInteraction.value[x] | |
| Definition | 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. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | create | update | deleteValue of extension |
| Control | 0..1 |
| Binding | The codes SHALL be taken from For codes, see R5InteractionTriggerForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-interaction-trigger-for-R3|0.1.0)FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. |
| Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Extension.extension:queryCriteria | |
| Slice Name | queryCriteria |
| Definition | R5: |
| Short | R5: Query based trigger rule (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 24. Extension.extension:queryCriteria.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. Extension.extension:queryCriteria.extension:previous | |
| Slice Name | previous |
| Definition | R5: |
| Short | R5: Rule applied to previous resource state (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 28. Extension.extension:queryCriteria.extension:previous.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | previous |
| 30. Extension.extension:queryCriteria.extension:previous.value[x] | |
| Definition | The FHIR query based rules are applied to the previous resource state (e.g., state before an update). Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Rule applied to previous resource stateValue of extension |
| Comments | The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character ( |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. Extension.extension:queryCriteria.extension:resultForCreate | |
| Slice Name | resultForCreate |
| Definition | R5: |
| Short | R5: test-passes | test-fails (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 34. Extension.extension:queryCriteria.extension:resultForCreate.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | resultForCreate |
| 36. Extension.extension:queryCriteria.extension:resultForCreate.value[x] | |
| Definition | For Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | test-passes | test-failsValue of extension |
| Control | 0..1 |
| Binding | The codes SHALL be taken from For codes, see R5SubscriptiontopicCrBehaviorForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscriptiontopic-cr-behavior-for-R3|0.1.0)Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). |
| Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. Extension.extension:queryCriteria.extension:current | |
| Slice Name | current |
| Definition | R5: |
| Short | R5: Rule applied to current resource state (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 40. Extension.extension:queryCriteria.extension:current.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | current |
| 42. Extension.extension:queryCriteria.extension:current.value[x] | |
| Definition | The FHIR query based rules are applied to the current resource state (e.g., state after an update). Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Rule applied to current resource stateValue of extension |
| Comments | The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character ( |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 44. Extension.extension:queryCriteria.extension:resultForDelete | |
| Slice Name | resultForDelete |
| Definition | R5: |
| Short | R5: test-passes | test-fails (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 46. Extension.extension:queryCriteria.extension:resultForDelete.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | resultForDelete |
| 48. Extension.extension:queryCriteria.extension:resultForDelete.value[x] | |
| Definition | For 'delete' interactions, should the 'current' query criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | test-passes | test-failsValue of extension |
| Control | 0..1 |
| Binding | The codes SHALL be taken from For codes, see R5SubscriptiontopicCrBehaviorForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscriptiontopic-cr-behavior-for-R3|0.1.0)Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). |
| Type | code, date, dateTime, Meta, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. Extension.extension:queryCriteria.extension:requireBoth | |
| Slice Name | requireBoth |
| Definition | R5: |
| Short | R5: Both must be true flag (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 52. Extension.extension:queryCriteria.extension:requireBoth.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | requireBoth |
| 54. Extension.extension:queryCriteria.extension:requireBoth.value[x] | |
| Definition | If set to Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Both must be true flagValue of extension |
| Comments | Please note the interaction between this element and the |
| Control | 0..1 |
| Type | boolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. Extension.extension:queryCriteria.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | queryCriteria |
| 58. Extension.extension:queryCriteria.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 60. Extension.extension:fhirPathCriteria | |
| Slice Name | fhirPathCriteria |
| Definition | R5: |
| Short | R5: FHIRPath based trigger rule (new)Additional Content defined by implementations |
| Comments | Element |
| Control | 0..1* |
| Type | Extension |
| Requirements | Element |
| 62. Extension.extension:fhirPathCriteria.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | fhirPathCriteria |
| 64. Extension.extension:fhirPathCriteria.value[x] | |
| Definition | The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic. Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | FHIRPath based trigger ruleValue of extension |
| Comments | FHIRPath expression with %previous and %current vars. |
| Control | 0..1 |
| Type | string, date, dateTime, Meta, code, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 66. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.resourceTrigger |
| 68. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R5: |
| Short | R5: Definition of a resource-based trigger for the subscription topic (new) |
| Comments | Element |
| Control | 0..* |
| Is Modifier | false |
| 2. Extension.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Extension.extension:description | |
| Slice Name | description |
| Definition | R5: |
| Short | R5: Text representation of the resource trigger (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 6. Extension.extension:description.url | |
| Control | 1..1 |
| Fixed Value | description |
| 8. Extension.extension:description.value[x] | |
| Definition | The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state". |
| Short | Text representation of the resource trigger |
| Comments | Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition. |
| Control | 0..1 |
| Type | markdown |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. Extension.extension:resource | |
| Slice Name | resource |
| Definition | R5: |
| Short | R5: Data Type or Resource (reference to definition) for this trigger definition (new) |
| Comments | Element |
| Control | 1..1 |
| Requirements | Element |
| 12. Extension.extension:resource.url | |
| Control | 1..1 |
| Fixed Value | resource |
| 14. Extension.extension:resource.value[x] | |
| 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. |
| Short | Data Type or Resource (reference to definition) for this trigger definition |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R5SubscriptionTypesForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R3|0.1.0)A type of resource, or a Reference (from all versions) |
| Type | uri |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Extension.extension:supportedInteraction | |
| Slice Name | supportedInteraction |
| Definition | R5: |
| Short | R5: create | update | delete (new) |
| Comments | Element |
| Control | 0..* |
| Requirements | Element |
| 18. Extension.extension:supportedInteraction.url | |
| Control | 1..1 |
| Fixed Value | supportedInteraction |
| 20. Extension.extension:supportedInteraction.value[x] | |
| Definition | 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. |
| Short | create | update | delete |
| Control | 0..1 |
| Binding | The codes SHALL be taken from R5InteractionTriggerForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-interaction-trigger-for-R3|0.1.0)FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. Extension.extension:queryCriteria | |
| Slice Name | queryCriteria |
| Definition | R5: |
| Short | R5: Query based trigger rule (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 24. Extension.extension:queryCriteria.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. Extension.extension:queryCriteria.extension:previous | |
| Slice Name | previous |
| Definition | R5: |
| Short | R5: Rule applied to previous resource state (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 28. Extension.extension:queryCriteria.extension:previous.url | |
| Control | 1..1 |
| Fixed Value | previous |
| 30. Extension.extension:queryCriteria.extension:previous.value[x] | |
| Definition | The FHIR query based rules are applied to the previous resource state (e.g., state before an update). |
| Short | Rule applied to previous resource state |
| Comments | The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character ( |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 32. Extension.extension:queryCriteria.extension:resultForCreate | |
| Slice Name | resultForCreate |
| Definition | R5: |
| Short | R5: test-passes | test-fails (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 34. Extension.extension:queryCriteria.extension:resultForCreate.url | |
| Control | 1..1 |
| Fixed Value | resultForCreate |
| 36. Extension.extension:queryCriteria.extension:resultForCreate.value[x] | |
| Definition | For |
| Short | test-passes | test-fails |
| Control | 0..1 |
| Binding | The codes SHALL be taken from R5SubscriptiontopicCrBehaviorForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscriptiontopic-cr-behavior-for-R3|0.1.0)Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 38. Extension.extension:queryCriteria.extension:current | |
| Slice Name | current |
| Definition | R5: |
| Short | R5: Rule applied to current resource state (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 40. Extension.extension:queryCriteria.extension:current.url | |
| Control | 1..1 |
| Fixed Value | current |
| 42. Extension.extension:queryCriteria.extension:current.value[x] | |
| Definition | The FHIR query based rules are applied to the current resource state (e.g., state after an update). |
| Short | Rule applied to current resource state |
| Comments | The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character ( |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 44. Extension.extension:queryCriteria.extension:resultForDelete | |
| Slice Name | resultForDelete |
| Definition | R5: |
| Short | R5: test-passes | test-fails (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 46. Extension.extension:queryCriteria.extension:resultForDelete.url | |
| Control | 1..1 |
| Fixed Value | resultForDelete |
| 48. Extension.extension:queryCriteria.extension:resultForDelete.value[x] | |
| Definition | For 'delete' interactions, should the 'current' query criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during |
| Short | test-passes | test-fails |
| Control | 0..1 |
| Binding | The codes SHALL be taken from R5SubscriptiontopicCrBehaviorForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscriptiontopic-cr-behavior-for-R3|0.1.0)Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. Extension.extension:queryCriteria.extension:requireBoth | |
| Slice Name | requireBoth |
| Definition | R5: |
| Short | R5: Both must be true flag (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 52. Extension.extension:queryCriteria.extension:requireBoth.url | |
| Control | 1..1 |
| Fixed Value | requireBoth |
| 54. Extension.extension:queryCriteria.extension:requireBoth.value[x] | |
| Definition | If set to |
| Short | Both must be true flag |
| Comments | Please note the interaction between this element and the |
| Control | 0..1 |
| Type | boolean |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. Extension.extension:queryCriteria.url | |
| Control | 1..1 |
| Fixed Value | queryCriteria |
| 58. Extension.extension:queryCriteria.value[x] | |
| Control | 0..0 |
| 60. Extension.extension:fhirPathCriteria | |
| Slice Name | fhirPathCriteria |
| Definition | R5: |
| Short | R5: FHIRPath based trigger rule (new) |
| Comments | Element |
| Control | 0..1 |
| Requirements | Element |
| 62. Extension.extension:fhirPathCriteria.url | |
| Control | 1..1 |
| Fixed Value | fhirPathCriteria |
| 64. Extension.extension:fhirPathCriteria.value[x] | |
| Definition | The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic. |
| Short | FHIRPath based trigger rule |
| Comments | FHIRPath expression with %previous and %current vars. |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 66. Extension.url | |
| Control | 1..1 |
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.resourceTrigger |
| 68. Extension.value[x] | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Extension | |
| Definition | R5: |
| Short | R5: Definition of a resource-based trigger for the subscription topic (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 2. Extension.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 4. Extension.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 1..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Extension.extension:description | |
| Slice Name | description |
| Definition | R5: |
| Short | R5: Text representation of the resource trigger (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 8. Extension.extension:description.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 10. Extension.extension:description.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Extension.extension:description.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | description |
| 14. Extension.extension:description.value[x] | |
| Definition | The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state". |
| Short | Text representation of the resource trigger |
| Comments | Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition. |
| Control | 0..1 |
| Type | markdown |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. Extension.extension:resource | |
| Slice Name | resource |
| Definition | R5: |
| Short | R5: Data Type or Resource (reference to definition) for this trigger definition (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension |
| Requirements | Element |
| 18. Extension.extension:resource.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 20. Extension.extension:resource.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Extension.extension:resource.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | resource |
| 24. Extension.extension:resource.value[x] | |
| 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. |
| Short | Data Type or Resource (reference to definition) for this trigger definition |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from R5SubscriptionTypesForR3 (0.1.0) (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscription-types-for-R3|0.1.0)A type of resource, or a Reference (from all versions) |
| Type | uri |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. Extension.extension:supportedInteraction | |
| Slice Name | supportedInteraction |
| Definition | R5: |
| Short | R5: create | update | delete (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension |
| Requirements | Element |
| 28. Extension.extension:supportedInteraction.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 30. Extension.extension:supportedInteraction.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. Extension.extension:supportedInteraction.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | supportedInteraction |
| 34. Extension.extension:supportedInteraction.value[x] | |
| Definition | 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. |
| Short | create | update | delete |
| Control | 0..1 |
| Binding | The codes SHALL be taken from R5InteractionTriggerForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-interaction-trigger-for-R3|0.1.0)FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 36. Extension.extension:queryCriteria | |
| Slice Name | queryCriteria |
| Definition | R5: |
| Short | R5: Query based trigger rule (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 38. Extension.extension:queryCriteria.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 40. Extension.extension:queryCriteria.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. Extension.extension:queryCriteria.extension:previous | |
| Slice Name | previous |
| Definition | R5: |
| Short | R5: Rule applied to previous resource state (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 44. Extension.extension:queryCriteria.extension:previous.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 46. Extension.extension:queryCriteria.extension:previous.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. Extension.extension:queryCriteria.extension:previous.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | previous |
| 50. Extension.extension:queryCriteria.extension:previous.value[x] | |
| Definition | The FHIR query based rules are applied to the previous resource state (e.g., state before an update). |
| Short | Rule applied to previous resource state |
| Comments | The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character ( |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 52. Extension.extension:queryCriteria.extension:resultForCreate | |
| Slice Name | resultForCreate |
| Definition | R5: |
| Short | R5: test-passes | test-fails (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 54. Extension.extension:queryCriteria.extension:resultForCreate.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 56. Extension.extension:queryCriteria.extension:resultForCreate.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. Extension.extension:queryCriteria.extension:resultForCreate.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | resultForCreate |
| 60. Extension.extension:queryCriteria.extension:resultForCreate.value[x] | |
| Definition | For |
| Short | test-passes | test-fails |
| Control | 0..1 |
| Binding | The codes SHALL be taken from R5SubscriptiontopicCrBehaviorForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscriptiontopic-cr-behavior-for-R3|0.1.0)Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 62. Extension.extension:queryCriteria.extension:current | |
| Slice Name | current |
| Definition | R5: |
| Short | R5: Rule applied to current resource state (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 64. Extension.extension:queryCriteria.extension:current.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 66. Extension.extension:queryCriteria.extension:current.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. Extension.extension:queryCriteria.extension:current.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | current |
| 70. Extension.extension:queryCriteria.extension:current.value[x] | |
| Definition | The FHIR query based rules are applied to the current resource state (e.g., state after an update). |
| Short | Rule applied to current resource state |
| Comments | The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character ( |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 72. Extension.extension:queryCriteria.extension:resultForDelete | |
| Slice Name | resultForDelete |
| Definition | R5: |
| Short | R5: test-passes | test-fails (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 74. Extension.extension:queryCriteria.extension:resultForDelete.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 76. Extension.extension:queryCriteria.extension:resultForDelete.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 78. Extension.extension:queryCriteria.extension:resultForDelete.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | resultForDelete |
| 80. Extension.extension:queryCriteria.extension:resultForDelete.value[x] | |
| Definition | For 'delete' interactions, should the 'current' query criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during |
| Short | test-passes | test-fails |
| Control | 0..1 |
| Binding | The codes SHALL be taken from R5SubscriptiontopicCrBehaviorForR3 (0.1.0) (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-subscriptiontopic-cr-behavior-for-R3|0.1.0)Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). |
| Type | code |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 82. Extension.extension:queryCriteria.extension:requireBoth | |
| Slice Name | requireBoth |
| Definition | R5: |
| Short | R5: Both must be true flag (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 84. Extension.extension:queryCriteria.extension:requireBoth.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 86. Extension.extension:queryCriteria.extension:requireBoth.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 88. Extension.extension:queryCriteria.extension:requireBoth.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | requireBoth |
| 90. Extension.extension:queryCriteria.extension:requireBoth.value[x] | |
| Definition | If set to |
| Short | Both must be true flag |
| Comments | Please note the interaction between this element and the |
| Control | 0..1 |
| Type | boolean |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 92. Extension.extension:queryCriteria.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | queryCriteria |
| 94. Extension.extension:queryCriteria.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 96. Extension.extension:fhirPathCriteria | |
| Slice Name | fhirPathCriteria |
| Definition | R5: |
| Short | R5: FHIRPath based trigger rule (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension |
| Requirements | Element |
| 98. Extension.extension:fhirPathCriteria.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | xml:id (or equivalent in JSON) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| 100. Extension.extension:fhirPathCriteria.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | Additional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 102. Extension.extension:fhirPathCriteria.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | fhirPathCriteria |
| 104. Extension.extension:fhirPathCriteria.value[x] | |
| Definition | The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic. |
| Short | FHIRPath based trigger rule |
| Comments | FHIRPath expression with %previous and %current vars. |
| Control | 0..1 |
| Type | string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 106. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Short | identifies the meaning of the extension |
| Comments | 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. |
| Control | 1..1 |
| Type | uri |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic.resourceTrigger |
| 108. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Short | Value of extension |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |