http://hl7.org/fhir/StructureDefinition/SubscriptionTopic|5.0.0
Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
| Name | Flags | Card | Type | Description & Constraints |
|---|---|---|---|---|
SubscriptionTopic | 0..* | The definition of a specific topic for triggering events within the Subscriptions framework | ||
Σ | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) | |
Σ | 0..* | Identifier | Business identifier for subscription topic | |
Σ | 0..1 | string | Business version of the subscription topic | |
Σ | 0..1 | How to compare versions http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | ||
Σ | 0..1 | string | http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | |
Σ | 0..1 | Coding | http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | |
Σ | 0..1 | string | Name for this subscription topic (computer friendly) | |
Σ | 0..1 | string | Name for this subscription topic (human friendly) | |
Σ | 0..* | canonical | Based on FHIR protocol or definition | |
?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (required) | |
Σ | 0..1 | boolean | If for testing purposes, not real usage | |
Σ | 0..1 | dateTime | Date status first applied | |
Σ | 0..1 | string | The name of the individual or organization that published the SubscriptionTopic | |
Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the SubscriptionTopic | ||
Σ | 0..* | UsageContext | Content intends to support these contexts | |
Σ | 0..* | CodeableConcept | Intended jurisdiction of the SubscriptionTopic (if applicable) Jurisdiction (extensible) | |
| 0..1 | markdown | Why this SubscriptionTopic is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | string | Copyright holder and year(s) | ||
| 0..1 | date | When SubscriptionTopic is/was approved by publisher | ||
| 0..1 | date | Date the Subscription Topic was last reviewed by the publisher | ||
Σ | 0..1 | Period | The effective date range for the SubscriptionTopic | |
Σ | 0..* | BackboneElement | Definition of a resource-based trigger for the subscription topic | |
Σ | 0..1 | markdown | Text representation of the resource trigger | |
Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition FHIRTypes (extensible) | |
Σ | 0..* | code | create | update | delete MethodCode (required) | |
Σ | 0..1 | BackboneElement | Query based trigger rule | |
Σ | 0..1 | string | Rule applied to previous resource state | |
Σ | 0..1 | code | test-passes | test-fails CriteriaNotExistsBehavior (required) | |
Σ | 0..1 | string | Rule applied to current resource state | |
Σ | 0..1 | code | test-passes | test-fails CriteriaNotExistsBehavior (required) | |
Σ | 0..1 | boolean | Both must be true flag | |
Σ | 0..1 | string | FHIRPath based trigger rule | |
Σ | 0..* | BackboneElement | Event definitions the SubscriptionTopic | |
Σ | 0..1 | markdown | Text representation of the event trigger | |
Σ | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic SubscriptionTopicEventTrigger (example) | |
Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition FHIRTypes (extensible) | |
Σ | 0..* | BackboneElement | Properties by which a Subscription can filter notifications from the SubscriptionTopic | |
Σ | 0..1 | markdown | Description of this filter parameter | |
Σ | 0..1 | uri | URL of the triggering Resource that this filter applies to FHIRTypes (extensible) | |
Σ | 1..1 | string | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter | |
Σ | 0..1 | uri | Canonical URL for a filterParameter definition | |
| 0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap SearchComparator (required) | ||
| 0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate SearchModifierCode (required) | ||
Σ | 0..* | BackboneElement | Properties for describing the shape of notifications generated by this topic | |
Σ | 1..1 | uri | URL of the Resource that is the focus (main) resource in a notification shape FHIRTypes (extensible) | |
Σ | 0..* | string | Include directives, rooted in the resource for this shape | |
Σ | 0..* | string | Reverse include directives, rooted in the resource for this shape |