description: Defines the data sources and events that clients can subscribe to. Acts as a configuration that establishes what events matter by specifying which resources and conditions warrant notifications.
package_name: io.health-samurai.core.r4b
derivation: specialization
name: AidboxSubscriptionTopic
type: AidboxSubscriptionTopic
elements:
  description: {type: markdown, short: Natural language description of the AidboxSubscriptionTopic., index: 15}
  date: {type: dateTime, short: Date status first applied., isSummary: true, index: 12}
  publisher: {type: string, short: The name of the individual or organization that published the AidboxSubscriptionTopic., isSummary: true, index: 13}
  approvalDate: {type: date, short: When AidboxSubscriptionTopic is/was approved by publisher., index: 21}
  jurisdiction: {type: CodeableConcept, short: Intended jurisdiction of the AidboxSubscriptionTopic (if applicable)., isSummary: true, array: true, index: 17}
  derivedFrom: {type: canonical, short: Based on FHIR protocol or definition., isSummary: true, array: true, index: 10}
  purpose: {type: markdown, short: Why this AidboxSubscriptionTopic is defined., index: 18}
  name: {type: string, short: Name for this subscription topic (computer friendly)., isSummary: true, index: 8}
  copyrightLabel: {type: string, short: Copyright holder and year(s)., index: 20}
  useContext: {type: UsageContext, short: Content intends to support these contexts., isSummary: true, array: true, index: 16}
  copyright: {type: markdown, short: Use and/or publishing restrictions., index: 19}
  versionAlgorithm:
    short: How to compare versions.
    isSummary: true
    choices: [versionAlgorithmString, versionAlgorithmCoding]
    index: 5
  experimental: {type: boolean, short: 'If for testing purposes, not real usage.', isSummary: true, index: 11}
  title: {type: string, short: Name for this subscription topic (human friendly)., isSummary: true, index: 9}
  versionAlgorithmCoding: {type: Coding, short: How to compare versions., isSummary: true, choiceOf: versionAlgorithm, index: 7}
  status:
    constraint:
      enum-1667: {human: 'status shall be one of: draft, active, retired, unknown', severity: error, expression: '%context.subsetOf(''draft'' | ''active'' | ''retired'' | ''unknown'')'}
    isModifier: true
    short: draft | active | retired | unknown.
    type: code
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired SubscriptionTopic without due consideration
    isSummary: true
    index: 1
  url: {type: uri, short: 'Canonical identifier for this subscription topic, represented as an absolute URI (globally unique).', isSummary: true, index: 0}
  identifier: {type: Identifier, short: Business identifier for subscription topic., isSummary: true, array: true, index: 2}
  lastReviewDate: {type: date, short: Date the AidboxSubscriptionTopic was last reviewed by the publisher., index: 22}
  versionAlgorithmString: {type: string, short: How to compare versions., isSummary: true, choiceOf: versionAlgorithm, index: 6}
  version: {type: string, short: Business version of the subscription topic., isSummary: true, index: 3}
  trigger:
    type: BackboneElement
    short: Definition of a resource-based trigger for the subscription topic.
    isSummary: true
    array: true
    index: 24
    elements:
      resource: {type: uri, short: Data Type or Resource (reference to definition) for this trigger definition., isSummary: true, index: 25}
      description: {type: markdown, short: Text representation of the resource trigger., isSummary: true, index: 26}
      supportedInteraction:
        type: code
        short: create | update | delete.
        isSummary: true
        constraint:
          enum-1668: {human: 'supportedInteraction shall be one of: create, update, delete', severity: error, expression: '%context.subsetOf(''create'' | ''update'' | ''delete'')'}
        array: true
        index: 27
      fhirPathCriteria: {type: string, short: FHIRPath based trigger rule., isSummary: true, index: 28}
      canFilterBy:
        type: BackboneElement
        short: Properties by which a AidboxTopicDestination can filter notifications from the AidboxSubscriptionTopic.
        isSummary: true
        array: true
        index: 29
        elements:
          filterParameter: {type: string, short: Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic., isSummary: true, index: 30}
          comparator: {type: code, short: eq | ne | gt | lt | ge | le | sa | eb | ap., array: true, min: 1, index: 31}
          filterDefinitionFhirPathExpression: {type: string, isSummary: true, index: 32}
          description: {type: markdown, short: Description of this filter parameter., isSummary: true, index: 33}
        required: [filterParameter, filterDefinitionFhirPathExpression, comparator]
    required: [resource]
  contact: {type: ContactDetail, short: Contact details for the publisher., isSummary: true, array: true, index: 14}
  effectivePeriod: {type: Period, short: The effective date range for the AidboxSubscriptionTopic., isSummary: true, index: 23}
package_version: 0.2601.0
class: resource
kind: resource
url: http://health-samurai.io/fhir/core/StructureDefinition/AidboxSubscriptionTopic
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 0.2601.0
required: [url, status]