description: The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
package_name: hl7.fhir.r5.examples
derivation: specialization
name: Subscription
type: Subscription
elements:
  maxCount: {isModifier: false, short: Maximum number of triggering resources included in notification bundles, type: positiveInt, mustSupport: false, isSummary: true, index: 20}
  notificationUrlLocation:
    isModifier: false
    short: none | full-url | request-response | all
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-url-location|4.6.0'}
    isSummary: true
    index: 19
  content:
    isModifier: false
    short: empty | id-only | full-resource
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-payload-content|4.6.0'}
    isSummary: true
    index: 18
  name: {isModifier: false, short: Human readable name for this subscription, type: string, mustSupport: false, isSummary: true, index: 1}
  topic: {isModifier: false, short: Reference to the subscription topic being subscribed to, type: canonical, mustSupport: false, isSummary: true, index: 3}
  header: {isModifier: false, short: Usage depends on the channel type, type: string, mustSupport: false, array: true, isSummary: true, index: 14}
  reason: {isModifier: false, short: Description of why this subscription was created, type: string, mustSupport: false, isSummary: true, index: 6}
  heartbeatPeriod: {isModifier: false, short: Interval in seconds to send 'heartbeat' notification, type: unsignedInt, mustSupport: false, isSummary: true, index: 15}
  status:
    isModifier: true
    short: requested | active | error | off | entered-in-error
    index: 2
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-state|4.6.0'}
    isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    isSummary: true
  identifier: {isModifier: false, short: Additional identifiers (business identifier), type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  contentType:
    isModifier: false
    short: MIME type to send, or omit for no payload
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|4.6.0'}
    isSummary: true
    index: 17
  timeout: {isModifier: false, short: Timeout in seconds to attempt notification delivery, type: unsignedInt, mustSupport: false, isSummary: true, index: 16}
  end: {isModifier: false, short: When to automatically delete the subscription, type: instant, mustSupport: false, isSummary: true, index: 5}
  filterBy:
    isModifier: false
    short: Criteria for narrowing the subscription topic stream
    index: 7
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      resourceType:
        isModifier: false
        short: Allowed Data type or Resource (reference to definition) for this Subscription
        type: uri
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/defined-types'}
        isSummary: true
        index: 8
      searchParamName: {isModifier: false, short: Filter label defined in SubscriptionTopic, type: string, mustSupport: false, isSummary: true, index: 9}
      searchModifier:
        isModifier: false
        short: = | eq | ne | gt | lt | ge | le | sa | eb | ap | above | below | in | not-in | of-type
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-search-modifier|4.6.0'}
        isSummary: true
        index: 10
      value: {isModifier: false, short: Literal value or resource path, type: string, mustSupport: false, isSummary: true, index: 11}
    required: [searchParamName, value]
    isSummary: true
  endpoint: {isModifier: false, short: Where the channel points to, type: url, mustSupport: false, isSummary: true, index: 13}
  contact: {isModifier: false, short: Contact details for source (e.g. troubleshooting), type: ContactPoint, mustSupport: false, array: true, isSummary: true, index: 4}
  channelType:
    isModifier: false
    short: Channel type for notifications
    type: Coding
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-channel-type'}
    isSummary: true
    index: 12
package_version: 4.6.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Subscription
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.6.0
required: [status, channelType, topic]