NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic TUDomainResourceThe definition of a specific topic for triggering events within the Subscriptions framework

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url Σ1..1uriCanonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... identifier Σ0..*IdentifierBusiness identifier for subscription topic

... version Σ0..1stringBusiness version of the subscription topic
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name Σ0..1stringName for this subscription topic (computer friendly)
... title ΣT0..1stringName for this subscription topic (human friendly)
... derivedFrom Σ0..*canonical(SubscriptionTopic)Based on FHIR protocol or definition

... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate status first applied
... publisher ΣT0..1stringThe name of the individual or organization that published the SubscriptionTopic
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the SubscriptionTopic
... useContext Σ0..*UsageContextContent intends to support these contexts

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction of the SubscriptionTopic (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this SubscriptionTopic is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel T0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen SubscriptionTopic is/was approved by publisher
... lastReviewDate 0..1dateDate the Subscription Topic was last reviewed by the publisher
... effectivePeriod Σ0..1PeriodThe effective date range for the SubscriptionTopic
... trigger Σ0..*BackboneElementDefinition of a trigger for the subscription topic

.... description Σ0..1markdownText representation of the resource trigger
.... resource Σ1..1uriKey Data Type, Resource (reference to definition), or relevant definition for this trigger
Binding: Types used with Subscriptions (Extensible)
Additional BindingsPurpose
All Resource TypesUI Binding

.... supportedInteraction Σ0..*codecreate | update | delete
Binding: Interaction Trigger (Required)

.... queryCriteria Σ0..1BackboneElementQuery based trigger rule
..... previous Σ0..1stringRule applied to previous resource state
..... resultForCreate Σ0..1codetest-passes | test-fails
Binding: Criteria Not Exists Behavior (Required)
..... current Σ0..1stringRule applied to current resource state
..... resultForDelete Σ0..1codetest-passes | test-fails
Binding: Criteria Not Exists Behavior (Required)
..... requireBoth Σ0..1booleanBoth must be true flag
.... fhirPathCriteria Σ0..1stringFHIRPath based trigger rule
.... event Σ0..1CodeableConceptEvent which can trigger a notification from the SubscriptionTopic
Binding: hl7VS-eventTypeCode (Example)
.... canFilterBy Σ0..*BackboneElementProperties by which a Subscription can filter notifications based on this trigger

..... description Σ0..1markdownDescription of this filter parameter
..... resource Σ0..1uriURL of the triggering Resource that this filter applies to
Binding: Types used with Subscriptions (Extensible)
Additional BindingsPurpose
All Resource TypesUI Binding

..... filterParameter Σ1..1stringHuman-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
..... filterDefinition Σ0..1uriCanonical URL for a filterParameter definition
..... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
Binding: Search Comparator (Required)

..... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: Search Modifier Code (Required)

.... notificationShape Σ0..*BackboneElementProperties for describing the shape of notifications generated by this trigger

..... resource Σ1..1uriURL of the key definition that is the focus in a notification shape
Binding: Types used with Subscriptions (Extensible)
Additional BindingsPurpose
All Resource TypesUI Binding

..... include Σ0..*stringInclude directives, rooted in the resource for this shape

..... revInclude Σ0..*stringReverse include directives, rooted in the resource for this shape

..... relatedQuery Σ0..*BackboneElementQuery describing data relevant to this notification

...... queryType Σ0..1CodingCoded information describing the type of data this query provides
...... query Σ1..1stringQuery to perform

doco Documentation for this format