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.
Structure JSON Dependencies FHIRSchema Other Versions Dependant (0)Elements Summary
description: Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.
derivation: specialization
name: SubscriptionTopic
type: SubscriptionTopic
elements:
  description: {isModifier: false, short: Natural language description of the SubscriptionTopic, mustSupport: false, isSummary: false, index: 13}
  date: {isModifier: false, short: Date status first applied, mustSupport: false, isSummary: true, index: 10}
  publisher: {isModifier: false, short: The name of the individual or organization that published the SubscriptionTopic, mustSupport: false, isSummary: true, index: 11}
  approvalDate: {isModifier: false, short: When SubscriptionTopic is/was approved by publisher, mustSupport: false, isSummary: false, index: 19}
  canFilterBy:
    isModifier: false
    short: Properties by which a Subscription can filter notifications from the SubscriptionTopic
    mustSupport: false
    array: true
    isSummary: true
    index: 37
    elements:
      description: {isModifier: false, short: Description of this filter parameter, mustSupport: false, isSummary: true, index: 38}
      resource:
        isModifier: false
        short: URL of the triggering Resource that this filter applies to
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-types'}
        isSummary: true
        index: 39
      filterParameter: {isModifier: false, short: 'Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter', mustSupport: false, isSummary: true, index: 40}
      filterDefinition: {isModifier: false, short: Canonical URL for a filterParameter definition, mustSupport: false, isSummary: true, index: 41}
      comparator:
        isModifier: false
        short: eq | ne | gt | lt | ge | le | sa | eb | ap
        mustSupport: false
        array: true
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-comparator|5.0.0'}
        isSummary: false
        index: 42
      modifier:
        isModifier: false
        short: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
        mustSupport: false
        array: true
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-modifier-code|5.0.0'}
        isSummary: false
        index: 43
    required: [filterParameter]
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction of the SubscriptionTopic (if applicable)
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 15
  derivedFrom: {isModifier: false, short: Based on FHIR protocol or definition, mustSupport: false, array: true, isSummary: true, index: 7}
  purpose: {isModifier: false, short: Why this SubscriptionTopic is defined, mustSupport: false, isSummary: false, index: 16}
  name: {isModifier: false, short: Name for this subscription topic (computer friendly), mustSupport: false, isSummary: true, index: 5}
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), mustSupport: false, isSummary: false, index: 18}
  useContext: {isModifier: false, short: Content intends to support these contexts, mustSupport: false, array: true, isSummary: true, index: 14}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, mustSupport: false, isSummary: false, index: 17}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: []
    isSummary: true
    index: 4
  experimental: {isModifier: false, short: 'If for testing purposes, not real usage', mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 9}
  title: {isModifier: false, short: Name for this subscription topic (human friendly), mustSupport: false, isSummary: true, index: 6}
  eventTrigger:
    isModifier: false
    short: Event definitions the SubscriptionTopic
    mustSupport: false
    array: true
    isSummary: true
    index: 33
    elements:
      description: {isModifier: false, short: Text representation of the event trigger, mustSupport: false, isSummary: true, index: 34}
      event:
        isModifier: false
        short: Event which can trigger a notification from the SubscriptionTopic
        mustSupport: false
        binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v2-0003'}
        isSummary: true
        index: 35
      resource:
        isModifier: false
        short: Data Type or Resource (reference to definition) for this trigger definition
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-types'}
        isSummary: true
        index: 36
    required: [resource, event]
  status:
    isModifier: true
    short: draft | active | retired | unknown
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired SubscriptionTopic without due consideration
    isSummary: true
    index: 8
  url: {isModifier: false, short: 'Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)', mustSupport: false, isSummary: true, index: 0}
  identifier: {isModifier: false, short: Business identifier for subscription topic, mustSupport: false, array: true, isSummary: true, index: 1}
  lastReviewDate: {isModifier: false, short: Date the Subscription Topic was last reviewed by the publisher, mustSupport: false, isSummary: false, index: 20}
  notificationShape:
    isModifier: false
    short: Properties for describing the shape of notifications generated by this topic
    mustSupport: false
    array: true
    isSummary: true
    index: 44
    elements:
      resource:
        isModifier: false
        short: URL of the Resource that is the focus (main) resource in a notification shape
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-types'}
        isSummary: true
        index: 45
      include: {isModifier: false, short: 'Include directives, rooted in the resource for this shape', mustSupport: false, array: true, isSummary: true, index: 46}
      revInclude: {isModifier: false, short: 'Reverse include directives, rooted in the resource for this shape', mustSupport: false, array: true, isSummary: true, index: 47}
    required: [resource]
  version: {isModifier: false, short: Business version of the subscription topic, mustSupport: false, isSummary: true, index: 2}
  contact: {isModifier: false, short: Contact details for the publisher, mustSupport: false, array: true, isSummary: true, index: 12}
  resourceTrigger:
    isModifier: false
    short: Definition of a resource-based trigger for the subscription topic
    mustSupport: false
    array: true
    isSummary: true
    index: 22
    elements:
      description: {isModifier: false, short: Text representation of the resource trigger, mustSupport: false, isSummary: true, index: 23}
      resource:
        isModifier: false
        short: Data Type or Resource (reference to definition) for this trigger definition
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-types'}
        isSummary: true
        index: 24
      supportedInteraction:
        isModifier: false
        short: create | update | delete
        mustSupport: false
        array: true
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/interaction-trigger|5.0.0'}
        isSummary: true
        index: 25
      queryCriteria:
        isModifier: false
        short: Query based trigger rule
        mustSupport: false
        isSummary: true
        index: 26
        elements:
          previous: {isModifier: false, short: Rule applied to previous resource state, mustSupport: false, isSummary: true, index: 27}
          resultForCreate:
            isModifier: false
            short: test-passes | test-fails
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior|5.0.0'}
            isSummary: true
            index: 28
          current: {isModifier: false, short: Rule applied to current resource state, mustSupport: false, isSummary: true, index: 29}
          resultForDelete:
            isModifier: false
            short: test-passes | test-fails
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscriptiontopic-cr-behavior|5.0.0'}
            isSummary: true
            index: 30
          requireBoth: {isModifier: false, short: Both must be true flag, mustSupport: false, isSummary: true, index: 31}
      fhirPathCriteria: {isModifier: false, short: FHIRPath based trigger rule, mustSupport: false, isSummary: true, index: 32}
    required: [resource]
  effectivePeriod: {isModifier: false, short: The effective date range for the SubscriptionTopic, mustSupport: false, isSummary: true, index: 21}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/SubscriptionTopic
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [url, status]